org.apache.rahas.client

Class STSClient

java.lang.Object

org.apache.rahas.client.STSClient

public class STSClient
extends Object

Constructor Summary

Constructors

Constructor and Description
STSClient(org.apache.axis2.context.ConfigurationContext configCtx)

Method Summary

Modifier and Type	Method and Description
void	addParameter(org.apache.axis2.description.Parameter param)
boolean	cancelToken(String tokenId, String issuerAddress, org.apache.neethi.Policy issuerPolicy) Cancel a given token
boolean	cancelToken(String issuerAddress, String tokenId, String action) Deprecated.
org.apache.axiom.om.OMElement	createIssueRequest(String requestType, String appliesTo) Create the RST request.
boolean	renewToken(String tokenId, String issuerAddress, org.apache.neethi.Policy issuerPolicy)
boolean	renewToken(String tokenId, String issuerAddress, org.apache.neethi.Policy issuerPolicy, TokenStorage store) Renews the token referenced by the token id, updates the token store
boolean	renewToken(String tokenId, String tokenType, String issuerAddress, org.apache.neethi.Policy issuerPolicy, TokenStorage store)
Token	requestSecurityToken(org.apache.neethi.Policy servicePolicy, String issuerAddress, org.apache.neethi.Policy issuerPolicy, String appliesTo)
Token	requestSecurityToken(org.apache.neethi.Policy servicePolicy, String issuerAddress, org.apache.neethi.Policy issuerPolicy, String appliesTo, org.apache.axis2.client.Options options)
void	setAction(String action)
void	setAddressingNs(String addressingNs)
void	setAlgorithmSuite(AlgorithmSuite algorithmSuite) This can be used in the case where the AlgorithmSuite is not specified in the given policy.
void	setCryptoInfo(org.apache.ws.security.components.crypto.Crypto crypto, CallbackHandler cbHandler) Sets the crypto information required to process the RSTR.
void	setCryptoInfo(org.apache.ws.security.components.crypto.Crypto crypto, String privKeyPasswd) Sets the crypto information required to process the RSTR.
void	setOptions(org.apache.axis2.client.Options options)
void	setRstTemplate(org.apache.axiom.om.OMElement rstTemplate)
void	setSoapVersion(String soapVersion)
void	setTrust10(Trust10 trust10) Set this to set the entropy configurations.
void	setTrust13(Trust13 trust13) Set this to set the entropy configurations.
void	setTtl(int ttl)
void	setVersion(int version)
boolean	validateToken(String tokenId, String issuerAddress, org.apache.neethi.Policy issuerPolicy)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

STSClient

public STSClient(org.apache.axis2.context.ConfigurationContext configCtx)
          throws TrustException

Throws:

TrustException

Method Detail

requestSecurityToken

public Token requestSecurityToken(org.apache.neethi.Policy servicePolicy,
                                  String issuerAddress,
                                  org.apache.neethi.Policy issuerPolicy,
                                  String appliesTo,
                                  org.apache.axis2.client.Options options)
                           throws TrustException

Throws:

TrustException

requestSecurityToken

public Token requestSecurityToken(org.apache.neethi.Policy servicePolicy,
                                  String issuerAddress,
                                  org.apache.neethi.Policy issuerPolicy,
                                  String appliesTo)
                           throws TrustException

Throws:

TrustException

cancelToken

@Deprecated
public boolean cancelToken(String issuerAddress,
                                       String tokenId,
                                       String action)
                                throws TrustException

Deprecated.

Cancel a particular security token

Parameters:

issuerAddress -

tokenId -

Returns:

true is the Token was successfully canceled. False otherwise.

Throws:

TrustException

cancelToken

public boolean cancelToken(String tokenId,
                           String issuerAddress,
                           org.apache.neethi.Policy issuerPolicy)
                    throws TrustException

Cancel a given token

Parameters:

tokenId - Token Identifier

issuerAddress - URI of the token issuer

issuerPolicy - Security policy applied to token issuer

Returns:

Return true if the given token is successfully revoked else return false

Throws:

TrustException

validateToken

public boolean validateToken(String tokenId,
                             String issuerAddress,
                             org.apache.neethi.Policy issuerPolicy)
                      throws TrustException

Throws:

TrustException

renewToken

public boolean renewToken(String tokenId,
                          String issuerAddress,
                          org.apache.neethi.Policy issuerPolicy)
                   throws TrustException

Throws:

TrustException

renewToken

public boolean renewToken(String tokenId,
                          String issuerAddress,
                          org.apache.neethi.Policy issuerPolicy,
                          TokenStorage store)
                   throws TrustException

Renews the token referenced by the token id, updates the token store

Parameters:

tokenId -

issuerAddress -

issuerPolicy -

store -

Returns:

status

Throws:

TrustException

renewToken

public boolean renewToken(String tokenId,
                          String tokenType,
                          String issuerAddress,
                          org.apache.neethi.Policy issuerPolicy,
                          TokenStorage store)
                   throws TrustException

Throws:

TrustException

createIssueRequest

public org.apache.axiom.om.OMElement createIssueRequest(String requestType,
                                                        String appliesTo)
                                                 throws TrustException

Create the RST request.

Parameters:

requestType -

appliesTo -

Returns:

OMElement

Throws:

TrustException

setTrust10

public void setTrust10(Trust10 trust10)

Set this to set the entropy configurations. If this is provided in the given policy it will be overridden.

Parameters:

trust10 - The trust10 to set.

setTrust13

public void setTrust13(Trust13 trust13)

Set this to set the entropy configurations. If this is provided in the given policy it will be overridden.

Parameters:

trust13 - The trust13 to set.

setAlgorithmSuite

public void setAlgorithmSuite(AlgorithmSuite algorithmSuite)

This can be used in the case where the AlgorithmSuite is not specified in the given policy. If the AlgorithmSuite exists in a binding in the policy then the value set will be overridden.

Parameters:

algorithmSuite - The algorithmSuite to set.

setAddressingNs

public void setAddressingNs(String addressingNs)

Parameters:

addressingNs - The addressingNs to set.

setTtl

public void setTtl(int ttl)

Parameters:

ttl - The ttl to set.

setCryptoInfo

public void setCryptoInfo(org.apache.ws.security.components.crypto.Crypto crypto,
                          CallbackHandler cbHandler)

Sets the crypto information required to process the RSTR.

Parameters:

crypto - Crypto information

cbHandler - Callback handler to provide the private key password to decrypt

setCryptoInfo

public void setCryptoInfo(org.apache.ws.security.components.crypto.Crypto crypto,
                          String privKeyPasswd)

Sets the crypto information required to process the RSTR.

Parameters:

crypto - The crypto information

privKeyPasswd - Private key password to decrypt

setAction

public void setAction(String action)

Parameters:

action - The action to set.

setOptions

public void setOptions(org.apache.axis2.client.Options options)

Parameters:

options - The options to set.

setRstTemplate

public void setRstTemplate(org.apache.axiom.om.OMElement rstTemplate)

Parameters:

rstTemplate - The rstTemplate to set.

setVersion

public void setVersion(int version)

Parameters:

version - The version to set.

setSoapVersion

public void setSoapVersion(String soapVersion)

addParameter

public void addParameter(org.apache.axis2.description.Parameter param)