org.eclipse.higgins.sts.api
Interface IRequestSecurityTokenResponse

public interface IRequestSecurityTokenResponse

Interface representing the RequestSecurityTokenResponse

Author:

mikemci at us dot ibm dot com

Method Summary

IElement	getAllowPostdating() Gets the AllowPostdating element that indicates that returned tokens should allow requests for postdated tokens.
List	getAnyOtherElements() Gets any other elements (other than those explicitly named)
IEndpointReference	getAppliesTo() Gets this optional element that specifies the scope for the service(s) to which this token applies.
URI	getAuthenticationType() Gets the AuthenticationType
IElement	getAuthenticator() Gets the optional Authenticator element that verifies the computed hash.
URI	getCanonicalizationAlgorithm() Gets the optional CanonicalizationAlgorithm URI element that indicates the canonicalization method used within the returned token.
IElement	getClientPseudonym()
URI	getComputedKey() Get the ComputedKey URI element value that describes how to compute the key.
String	getContext() Gets the optional Context element URI String that specifies the identifier from the original request.
Object	getData() Gets the associated data object (this object is not serialized in the message)
Boolean	getDelegatable() Gets the Delegatable element which should be used in conjunction with the <wst:DelegateTo> element.
IElement	getDelegateTo() Gets the optional DelegateTo element.
IElement	getEncryption() Gets the optional Encryption element that specifies that the requestor desires any returned secrets in issued security tokens to be encrypted for the specified token.
URI	getEncryptionAlgorithm() Gets the optional EncryptionAlgorithm URI element that indicates the encryption algorithm used within the returned token.
URI	getEncryptWith() Gets the optional EncryptWith element that specifies the desired encryption algorithm to used with the issued security token.
IElement	getEntropy() Gets the optional Entropy element that allows a requestor to specify entropy that is to be used in creating the key.
Boolean	getForwardable() Gets the Forwardable element
IEndpointReference	getIssuer() Gets the Issuer element EndpointReference of the issuer of the security token that is presented in the message.
Integer	getKeySize() Gets the optional KeySize element that indicates the size of the key required specified in number of bits.
URI	getKeyType() Gets the optional URI element that indicates the type of key desired in this RequestSecurityToken.
ILifetime	getLifetime() Gets the optional Lifetime element that specifies the duration of time between creation and expiration that the security token is valid.
IElement	getOnBehalfOf() Gets the optional OnBehalfOf element that indicates that the requestor is making the request on behalf of another.
IElement	getPolicy() Gets the optional Policy element that specifies a policy that indicates desired settings for the requested token.
IElement	getPolicyReference() Gets the optional PolicyReference element that specifies a reference to a policy that indicates desired settings for the requested token.
IElement	getProofEncryption() Gets the optional ProofEncryption element
IElement	getRenewing() Gets optional Renewing element that is used to specify renew semantics for types that support this operation.
IElement	getRequestedAttachedReference() Gets the optional RequestedAttachedReference element from the response.
IDisplayToken	getRequestedDisplayToken() Gets the RequestedDisplayToken
IElement	getRequestedProofToken() Gets the optional RequestedProofToken element that is used to return the proof-of-possession token associated with the requested security token.
IElement	getRequestedSecurityToken() Gets the requested RequestedSecurityToken element from the response.
IElement	getRequestedTokenCancelled() Gets the RequestedTokenCancelled element.
IElement	getRequestedUnattachedReference() Gets the optional RequestedUnattachedReference element from the response.
URI	getRequestType() Gets the required RequestType element that is used to indicate the type of function that was requested, specified as a URI.
URI	getSignatureAlgorithm() Gets optional URI element that indicates the desired SignatureAlgorithm used within the returned token.
URI	getSignWith() Gets the optional SignWith URI element that indicates the desired signature algorithm to be used with the issued security token.
IElement	getStatus() Gets the Status element that MUST be in the response when a validation request is made.
URI	getTokenType() Gets the optional element that describes the type of security token returned, specified as a URI.
IElement	getUseKey() Gets the UseKey element that specifies which existing key to use, rather than creating a new one.
void	setAllowPostdating(IElement elemAllowPostdating) Sets the AllowPostdating element that indicates that returned tokens should allow requests for postdated tokens.
void	setAppliesTo(IEndpointReference eprAppliesTo) Sets this optional element that specifies the scope for the service(s) to which this token applies.
void	setAuthenticationType(URI uriAuthenticationType) Sets the AuthenticationType
void	setAuthenticator(IElement elemAuthenticator) Sets the optional Authenticator element that verifies the computed hash.
void	setCanonicalizationAlgorithm(URI uriCanonicalizationAlgorithm) Sets the optional CanonicalizationAlgorithm URI element that indicates the canonicalization method used within the returned token.
void	setClientPseudonym(IElement clientPseudonym)
void	setComputedKey(URI uriComputedKey)
void	setContext(String uriContext) Sets the optional Context element URI String that specifies the identifier from the original request.
void	setData(Object objectData) Sets the associated data object (this object is not serialized in the message)
void	setDelegatable(boolean bDelegatable) Sets the Delegatable element which should be used in conjunction with the <wst:DelegateTo> element.
void	setDelegateTo(IElement elemDelegateTo) Sets the optional DelegateTo element.
void	setEncryption(IElement elemEncryption) Sets the optional Encryption element that specifies that the requestor desires any returned secrets in issued security tokens to be encrypted for the specified token.
void	setEncryptionAlgorithm(URI uriEncryptionAlgorithm) Sets the EncryptionAlgorithm
void	setEncryptWith(URI uriEncryptWith) Sets the optional EncryptWith element that specifies the desired encryption algorithm to used with the issued security token.
void	setEntropy(IElement elemEntropy) Sets the optional Entropy element that allows a requestor to specify entropy that is to be used in creating the key.
void	setForwardable(boolean bForwardable) Sets the optional Forwardable element.
void	setIssuer(IEndpointReference eprIssuer) Sets the Issuer element EndpointReference of the issuer of the security token that is presented in the message.
void	setKeySize(int nKeySize) Sets the optional KeySize element that indicates the size of the key required specified in number of bits.
void	setKeyType(URI uriKeyType) Sets the optional URI element that indicates the type of key desired in this RequestSecurityToken.
void	setLifetime(ILifetime ltLifetime) Sets the optional Lifetime element that specifies the duration of time between creation and expiration that the security token is valid.
void	setOnBehalfOf(IElement elemOnBehalfOf) Sets the optional OnBehalfOf element that indicates that the requestor is making the request on behalf of another.
void	setPolicy(IElement elemPolicy) Sets the optional Policy element that specifies a policy that indicates desired settings for the requested token.
void	setPolicyReference(IElement elemPolicyReference) Sets the optional PolicyReference element that specifies a reference to a policy that indicates desired settings for the requested token.
void	setProofEncryption(IElement elemProofEncryption) Sets the optional ProofEncryption element.
void	setRenewing(IElement elemRenewing) Sets optional Renewing element that is used to specify renew semantics for types that support this operation.
void	setRequestedAttachedReference(IElement elemRequestedAttachedReference) Sets the optional RequestedAttachedReference element in the response.
void	setRequestedDisplayToken(IDisplayToken elemRequestedDisplayToken) Sets the RequestedDisplayToken
void	setRequestedProofToken(IElement elemRequestedProofToken) Sets the optional RequestedProofToken element that is used to return the proof-of-possession token associated with the requested security token.
void	setRequestedSecurityToken(IElement elemRequestedSecurityToken) Sets the requested RequestedSecurityToken element within the response.
void	setRequestedTokenCancelled(IElement elemRequestedTokenCancelled) Sets the RequestedTokenCancelled element.
void	setRequestedUnattachedReference(IElement elemRequestedUnattachedReference) Sets the optional RequestedUnattachedReference element in the response.
void	setRequestType(URI uriRequestType) Sets the required RequestType element that is used to indicate the type of function that was requested, specified as a URI.
void	setSignatureAlgorithm(URI uriSignatureAlgorithm) Sets the optional URI element that indicates the desired SignatureAlgorithm used within the returned token.
void	setSignWith(URI uriSignWith) Sets the optional SignWith URI element that indicates the desired signature algorithm to be used with the issued security token.
void	setStatus(IElement elemStatus) Sets the Status element that MUST be in the response when a validation request is made.
void	setTokenType(URI uriTokenType) Sets the optional element that describes the type of security token returned, specified as a URI.
void	setUseKey(IElement elemUseKey) Sets the UseKey element that specifies which existing key to use, rather than creating a new one.

Method Detail

getClientPseudonym

public IElement getClientPseudonym()

setClientPseudonym

public void setClientPseudonym(IElement clientPseudonym)

getComputedKey

public URI getComputedKey()

Get the ComputedKey URI element value that describes how to compute the key.

Returns:

the ComputedKey URI

getContext

public String getContext()

Gets the optional Context element URI String that specifies the identifier from the original request.

Returns:

the String value of the Context URI

getRequestedTokenCancelled

public IElement getRequestedTokenCancelled()

Gets the RequestedTokenCancelled element.

Returns:

the RequestedTokenCancelled

getRequestedDisplayToken

public IDisplayToken getRequestedDisplayToken()

Gets the RequestedDisplayToken

Returns:

the RequestedDisplayToken

getTokenType

public URI getTokenType()

Gets the optional element that describes the type of security token returned, specified as a URI.

Returns:

the TokenType

getRequestType

public URI getRequestType()

Gets the required RequestType element that is used to indicate the type of function that was requested, specified as a URI.
The values are defined by the WS-Trust specifications.

Returns:

the RequestType

getRequestedSecurityToken

public IElement getRequestedSecurityToken()

Gets the requested RequestedSecurityToken element from the response.

Returns:

the RequestedSecurityToken

getAppliesTo

public IEndpointReference getAppliesTo()

Gets this optional element that specifies the scope for the service(s) to which this token applies.

Returns:

the AppliesTo EndpointReference

getRequestedAttachedReference

public IElement getRequestedAttachedReference()

Gets the optional RequestedAttachedReference element from the response.

Returns:

the RequestedAttachedReference

getRequestedUnattachedReference

public IElement getRequestedUnattachedReference()

Gets the optional RequestedUnattachedReference element from the response.

Returns:

the RequestedUnattachedReference

getRequestedProofToken

public IElement getRequestedProofToken()

Gets the optional RequestedProofToken element that is used to return the proof-of-possession token associated with the requested security token.

Returns:

the RequestedProofToken

getEntropy

public IElement getEntropy()

Gets the optional Entropy element that allows a requestor to specify entropy that is to be used in creating the key.

Returns:

the Entropy

getLifetime

public ILifetime getLifetime()

Gets the optional Lifetime element that specifies the duration of time between creation and expiration that the security token is valid.

Returns:

the Lifetime

getStatus

public IElement getStatus()

Gets the Status element that MUST be in the response when a validation request is made.

Returns:

the Status

getAllowPostdating

public IElement getAllowPostdating()

Gets the AllowPostdating element that indicates that returned tokens should allow requests for postdated tokens.

Returns:

the AllowPostdating

getRenewing

public IElement getRenewing()

Gets optional Renewing element that is used to specify renew semantics for types that support this operation.

Returns:

the Renewing

getOnBehalfOf

public IElement getOnBehalfOf()

Gets the optional OnBehalfOf element that indicates that the requestor is making the request on behalf of another.

Returns:

the OnBehalfOf

getIssuer

public IEndpointReference getIssuer()

Gets the Issuer element EndpointReference of the issuer of the security token that is presented in the message.

Returns:

the Issuer element EndpointReference

getAuthenticationType

public URI getAuthenticationType()

Gets the AuthenticationType

Returns:

the AuthenticationType

getAuthenticator

public IElement getAuthenticator()

Gets the optional Authenticator element that verifies the computed hash.

Returns:

the Authenticator

getKeyType

public URI getKeyType()

Gets the optional URI element that indicates the type of key desired in this RequestSecurityToken.

Returns:

the KeyType

getKeySize

public Integer getKeySize()

Gets the optional KeySize element that indicates the size of the key required specified in number of bits.

Returns:

the KeySize

getSignatureAlgorithm

public URI getSignatureAlgorithm()

Gets optional URI element that indicates the desired SignatureAlgorithm used within the returned token.

Returns:

the URI of the SignatureAlgorithm

getEncryption

public IElement getEncryption()

Gets the optional Encryption element that specifies that the requestor desires any returned secrets in issued security tokens to be encrypted for the specified token.

Returns:

the Encryption

getEncryptionAlgorithm

public URI getEncryptionAlgorithm()

Gets the optional EncryptionAlgorithm URI element that indicates the encryption algorithm used within the returned token.

Returns:

the EncryptionAlgorithm

getCanonicalizationAlgorithm

public URI getCanonicalizationAlgorithm()

Gets the optional CanonicalizationAlgorithm URI element that indicates the canonicalization method used within the returned token.

Returns:

the CanonicalizationAlgorithm

getProofEncryption

public IElement getProofEncryption()

Gets the optional ProofEncryption element

Returns:

the ProofEncryption

getUseKey

public IElement getUseKey()

Gets the UseKey element that specifies which existing key to use, rather than creating a new one.

Returns:

the UseKey

getSignWith

public URI getSignWith()

Gets the optional SignWith URI element that indicates the desired signature algorithm to be used with the issued security token.

Returns:

the SignWith

getEncryptWith

public URI getEncryptWith()

Gets the optional EncryptWith element that specifies the desired encryption algorithm to used with the issued security token.

Returns:

the EncryptWith

getDelegateTo

public IElement getDelegateTo()

Gets the optional DelegateTo element.

Returns:

the DelegateTo

getForwardable

public Boolean getForwardable()

Gets the Forwardable element

Returns:

Boolean value representing whether the request is bound to the requestor's machine or service

getDelegatable

public Boolean getDelegatable()

Gets the Delegatable element which should be used in conjunction with the <wst:DelegateTo> element.

Returns:

Boolean value representing whether the returned token MAY be delegated to another party

getPolicy

public IElement getPolicy()

Gets the optional Policy element that specifies a policy that indicates desired settings for the requested token.

Returns:

the Policy

getPolicyReference

public IElement getPolicyReference()

Gets the optional PolicyReference element that specifies a reference to a policy that indicates desired settings for the requested token.

Returns:

the PolicyReference

getAnyOtherElements

public List getAnyOtherElements()

Gets any other elements (other than those explicitly named)

Returns:

any other elements (other than those explicitly named)

getData

public Object getData()

Gets the associated data object (this object is not serialized in the message)

Returns:

the associated data object (this object is not serialized in the message)

setComputedKey

public void setComputedKey(URI uriComputedKey)

setRequestedTokenCancelled

public void setRequestedTokenCancelled(IElement elemRequestedTokenCancelled)

Sets the RequestedTokenCancelled element.

Parameters:

elemRequestedTokenCancelled - the RequestedTokenCancelled

setRequestedDisplayToken

public void setRequestedDisplayToken(IDisplayToken elemRequestedDisplayToken)

Sets the RequestedDisplayToken

Parameters:

elemRequestedDisplayToken - the RequestedDisplayToken

setTokenType

public void setTokenType(URI uriTokenType)

Sets the optional element that describes the type of security token returned, specified as a URI.

Parameters:

uriTokenType - is the URI of the TokenType
An example of a SAML 1.0 TokenType URI:
urn:oasis:names:tc:SAML:1.0:assertion

setRequestType

public void setRequestType(URI uriRequestType)

Sets the required RequestType element that is used to indicate the type of function that was requested, specified as a URI.
The values are defined by the WS-Trust specifications.
An example of an 'Issue' RequestType URI, defined by the 2005-02 WS-Trust specification:
new URI("http://schemas.xmlsoap.org/ws/2005/02/trust/Issue")

Parameters:

uriRequestType - the RequestType

setRequestedSecurityToken

public void setRequestedSecurityToken(IElement elemRequestedSecurityToken)

Sets the requested RequestedSecurityToken element within the response.

Parameters:

elemRequestedSecurityToken - the RequestedSecurityToken

setAppliesTo

public void setAppliesTo(IEndpointReference eprAppliesTo)

Sets this optional element that specifies the scope for the service(s) to which this token applies.

Parameters:

eprAppliesTo - is the AppliesTo EndpointReference

setRequestedAttachedReference

public void setRequestedAttachedReference(IElement elemRequestedAttachedReference)

Sets the optional RequestedAttachedReference element in the response.

Parameters:

elemRequestedAttachedReference - the RequestedAttachedReference

setRequestedUnattachedReference

public void setRequestedUnattachedReference(IElement elemRequestedUnattachedReference)

Sets the optional RequestedUnattachedReference element in the response.

Parameters:

elemRequestedUnattachedReference - the RequestedUnattachedReference

setRequestedProofToken

public void setRequestedProofToken(IElement elemRequestedProofToken)

Sets the optional RequestedProofToken element that is used to return the proof-of-possession token associated with the requested security token.

Parameters:

elemRequestedProofToken - the RequestedProofToken

setEntropy

public void setEntropy(IElement elemEntropy)

Sets the optional Entropy element that allows a requestor to specify entropy that is to be used in creating the key.

Parameters:

elemEntropy - the Entropy

setLifetime

public void setLifetime(ILifetime ltLifetime)

Sets the optional Lifetime element that specifies the duration of time between creation and expiration that the security token is valid.

Parameters:

ltLifetime - the Lifetime

setStatus

public void setStatus(IElement elemStatus)

Sets the Status element that MUST be in the response when a validation request is made.

Parameters:

elemStatus - is the Status URI.
Examples of status URIs:
http://schemas.xmlsoap.org/ws/2005/02/trust/status/valid
http://schemas.xmlsoap.org/ws/2005/02/trust/status/invalid

setAllowPostdating

public void setAllowPostdating(IElement elemAllowPostdating)

Sets the AllowPostdating element that indicates that returned tokens should allow requests for postdated tokens.

Parameters:

elemAllowPostdating - the AllowPostdating

setRenewing

public void setRenewing(IElement elemRenewing)

Sets optional Renewing element that is used to specify renew semantics for types that support this operation.

Parameters:

elemRenewing - the Renewing element. Example for setting the Renewing element:

String renewing = "<wst:Renewing Allow=\"true\" OK=\"false\"/>"
IElement renewingElement = new Element();
renewingElement.set(renewing);
rst.setRenewing(renewingElement);

If attributes are not specified (see snippet example below), then 'Allow' defaults to 'true' and 'OK' to 'false'.
<wst:Renewing/>

setOnBehalfOf

public void setOnBehalfOf(IElement elemOnBehalfOf)

Sets the optional OnBehalfOf element that indicates that the requestor is making the request on behalf of another.

Parameters:

elemOnBehalfOf - is the OnBehalfOf element will contain either a <wsse:SecurityTokenReference> or an <wsa:EndpointReference> element which will contain the identity on whose behalf the request is being made

setIssuer

public void setIssuer(IEndpointReference eprIssuer)

Sets the Issuer element EndpointReference of the issuer of the security token that is presented in the message.

Parameters:

eprIssuer - is the EndpointReference that specifies the Issuer

setAuthenticationType

public void setAuthenticationType(URI uriAuthenticationType)

Sets the AuthenticationType

Parameters:

uriAuthenticationType - the AuthenticationType

setAuthenticator

public void setAuthenticator(IElement elemAuthenticator)

Sets the optional Authenticator element that verifies the computed hash.

Parameters:

elemAuthenticator - the Authenticator

setKeyType

public void setKeyType(URI uriKeyType)

Sets the optional URI element that indicates the type of key desired in this RequestSecurityToken.

Parameters:

uriKeyType - is the type of key for this RequestSecurityToken
Example URIs:
http://schemas.xmlsoap.org/ws/2005/02/trust/SymmetricKey
http://schemas.xmlsoap.org/ws/2005/02/trust/PublicKey

setKeySize

public void setKeySize(int nKeySize)

Sets the optional KeySize element that indicates the size of the key required specified in number of bits. The receipient of this request SHOULD at least try to have the same strength as request.

Parameters:

nKeySize - the KeySize

setSignatureAlgorithm

public void setSignatureAlgorithm(URI uriSignatureAlgorithm)

Sets the optional URI element that indicates the desired SignatureAlgorithm used within the returned token.

Parameters:

uriSignatureAlgorithm - the SignatureAlgorithm

setEncryption

public void setEncryption(IElement elemEncryption)

Sets the optional Encryption element that specifies that the requestor desires any returned secrets in issued security tokens to be encrypted for the specified token.

Parameters:

elemEncryption - the Encryption

setEncryptionAlgorithm

public void setEncryptionAlgorithm(URI uriEncryptionAlgorithm)

Sets the EncryptionAlgorithm

Parameters:

uriEncryptionAlgorithm - the EncryptionAlgorithm

setCanonicalizationAlgorithm

public void setCanonicalizationAlgorithm(URI uriCanonicalizationAlgorithm)

Sets the optional CanonicalizationAlgorithm URI element that indicates the canonicalization method used within the returned token.

Parameters:

uriCanonicalizationAlgorithm - the CanonicalizationAlgorithm

setProofEncryption

public void setProofEncryption(IElement elemProofEncryption)

Sets the optional ProofEncryption element.

Parameters:

elemProofEncryption - the ProofEncryption

setUseKey

public void setUseKey(IElement elemUseKey)

Sets the UseKey element that specifies which existing key to use, rather than creating a new one.

Parameters:

elemUseKey - the UseKey

setSignWith

public void setSignWith(URI uriSignWith)

Sets the optional SignWith URI element that indicates the desired signature algorithm to be used with the issued security token.

Parameters:

uriSignWith - the SignWith

setEncryptWith

public void setEncryptWith(URI uriEncryptWith)

Sets the optional EncryptWith element that specifies the desired encryption algorithm to used with the issued security token.

Parameters:

uriEncryptWith - the EncryptWith

setDelegateTo

public void setDelegateTo(IElement elemDelegateTo)

Sets the optional DelegateTo element.

Parameters:

elemDelegateTo - is the identity receiving the delegation, which is specified by setting this value to the security token or <wsse:SecurityTokenReference> element.

setForwardable

public void setForwardable(boolean bForwardable)

Sets the optional Forwardable element.

Parameters:

bForwardable - is the boolean value specifying whether this request is forwardable.

setDelegatable

public void setDelegatable(boolean bDelegatable)

Sets the Delegatable element which should be used in conjunction with the <wst:DelegateTo> element.

Parameters:

bDelegatable - is the boolean value specifying whether returned token MAY be delegated to another party.

setPolicy

public void setPolicy(IElement elemPolicy)

Sets the optional Policy element that specifies a policy that indicates desired settings for the requested token.

Parameters:

elemPolicy - the Policy

setPolicyReference

public void setPolicyReference(IElement elemPolicyReference)

Sets the optional PolicyReference element that specifies a reference to a policy that indicates desired settings for the requested token.

Parameters:

elemPolicyReference - the PolicyReference

setContext

public void setContext(String uriContext)

Sets the optional Context element URI String that specifies the identifier from the original request.

Parameters:

uriContext - the String value of the Context URI

setData

public void setData(Object objectData)

Sets the associated data object (this object is not serialized in the message)

Parameters:

objectData - the data object to be associated (this object is not serialized in the message)