org.jboss.identity.federation.api.wstrust.protocol
Class RequestSecurityTokenResponse

java.lang.Object
  org.jboss.identity.federation.api.wstrust.protocol.RequestSecurityTokenResponse

All Implemented Interfaces:

BaseRequestSecurityTokenResponse

public class RequestSecurityTokenResponse
extends java.lang.Object
implements BaseRequestSecurityTokenResponse

Author:

Stefan Guilhen

Constructor Summary

RequestSecurityTokenResponse()
Creates an instance of RequestSecurityTokenResponse.

RequestSecurityTokenResponse(RequestSecurityTokenResponseType delegate)
Creates an instance of RequestSecurityTokenResponse using the specified delegate.

Method Summary

AllowPostdatingType	getAllowPostDating() Checks whether the returned token is a postdated token or not.
java.util.List<java.lang.Object>	getAny() Gets a reference to the list that holds all response element values.
AppliesTo	getAppliesTo() Obtains the scope to which the security token applies.
java.net.URI	getAuthenticationType() Obtains the type of authentication that is to be conducted.
AuthenticatorType	getAuthenticator() Obtains the authenticator that must be used in authenticating exchanges.
java.net.URI	getCanonicalizationAlgorithm() Obtains the canonicalization algorithm that has been set in the response.
java.lang.String	getContext() Obtains the response context.
RequestSecurityTokenResponseType	getDelegate() Obtains a reference to the RequestSecurityTokenResponseType delegate.
DelegateToType	getDelegateTo() Obtains the identity to which the requested token should be delegated.
EncryptionType	getEncryption() Obtains the Encryption section of the response.
java.net.URI	getEncryptionAlgorithm() Obtains the encryption algorithm that has been set in the response.
java.net.URI	getEncryptWith() Obtains the encryption algorithm used with the issued security token.
EntropyType	getEntropy() Obtains the entropy that has been used in creating the key.
java.util.List<java.lang.Object>	getExtensionElements() Obtains the list of request elements that are not part of the standard content model.
EndpointReferenceType	getIssuer() Obtains the issuer of the token included in the request in the scenarios where the requestor is obtaining a token on behalf of another party.
long	getKeySize() Obtains the size of they key that has been set in the response.
java.net.URI	getKeyType() Obtains the type of the key that has been set in the response.
LifetimeType	getLifetime() Obtains the lifetime of the security token.
OnBehalfOfType	getOnBehalfOf() Obtains the identity on whose behalf the token request was made.
java.util.Map<javax.xml.namespace.QName,java.lang.String>	getOtherAttributes() Obtains a map that contains attributes that aren't bound to any typed property on the response.
Policy	getPolicy() Obtains the Policy that was associated with the request.
PolicyReference	getPolicyReference() Obtains the reference to the Policy that was associated with the request.
ProofEncryptionType	getProofEncryption() Obtains the ProofEncryption section of the response.
RenewingType	getRenewing() Obtains the renew semantics for the token request.
RequestedReferenceType	getRequestedAttachedReference() Obtains the RequestedAttachedReference that indicate how to reference the returned token when that token doesn't support references using URI fragments (XML ID).
RequestedProofTokenType	getRequestedProofToken() Obtains the proof of possession token that has been set in the response.
RequestedSecurityTokenType	getRequestedSecurityToken() Obtains the requested security token that has been set in the response.
RequestedReferenceType	getRequestedUnattachedReference() Obtains the RequestedUnattachedReference that specifies to indicate how to reference the token when it is not placed inside the message.
java.net.URI	getRequestType() Obtains the request type.
java.net.URI	getSignatureAlgorithm() Obtains the signature algorithm that has been set in the response.
java.net.URI	getSignWith() Obtains the signature algorithm used with the issued security token.
StatusType	getStatus() Obtains the result of a security token validation.
java.net.URI	getTokenType() Obtains the URI that identifies the token type.
UseKeyType	getUseKey() Obtains the key that used in the returned token.
boolean	isDelegatable() Indicates whether the requested token has been marked as "delegatable" or not.
boolean	isForwardable() Indicates whether the requested token has been marked as "forwardable" or not.
void	setAllowPostDating(AllowPostdatingType allowPostDating) Specifies whether the returned token is a postdated token or not.
void	setAppliesTo(AppliesTo appliesTo) Sets the scope to which the security token applies.
void	setAuthenticationType(java.net.URI authenticationType) Sets the authentication type in the response.
void	setAuthenticator(AuthenticatorType authenticator) Sets the authenticator that must be used in authenticating exchanges.
void	setCanonicalizationAlgorithm(java.net.URI canonicalizationAlgorithm) Sets the canonicalization algorithm in the response.
void	setContext(java.lang.String context) Sets the response context.
void	setDelegatable(boolean delegatable) Specifies whether the requested token has been marked as "delegatable" or not.
void	setDelegateTo(DelegateToType delegateTo) Sets the identity to which the requested token should be delegated.
void	setEncryption(EncryptionType encryption) Sets the Encryption section of the response.
void	setEncryptionAlgorithm(java.net.URI encryptionAlgorithm) Sets the encryption algorithm in the response.
void	setEncryptWith(java.net.URI encryptWith) Sets the encryption algorithm used with the issued security token.
void	setEntropy(EntropyType entropy) Sets the entropy that has been used in creating the key.
void	setForwardable(boolean forwardable) Specifies whether the requested token has been marked as "forwardable" or not.
void	setIssuer(EndpointReferenceType issuer) Sets the issuer of the token included in the request in scenarios where the requestor is obtaining a token on behalf of another party.
void	setKeySize(long keySize) Sets the size of the key in the response.
void	setKeyType(java.net.URI keyType) Sets the key type in the response.
void	setLifetime(LifetimeType lifetime) Sets the lifetime of the security token.
void	setOnBehalfOf(OnBehalfOfType onBehalfOf) Specifies the identity on whose behalf the token request was made.
void	setPolicy(Policy policy) Sets the Policy in the response.
void	setPolicyReference(PolicyReference policyReference) Sets the reference to the Policy that was associated with the request.
void	setProofEncryption(ProofEncryptionType proofEncryption) Sets the ProofEncryption section of the response.
void	setRenewing(RenewingType renewing) Sets the renew semantics for the token request.
void	setRequestedAttachedReference(RequestedReferenceType requestedAttachedReference) Sets the RequestedAttachedReference that indicate how to reference the returned token when that token doesn't support references using URI fragments (XML ID).
void	setRequestedProofToken(RequestedProofTokenType requestedProofToken) Sets the proof of possesion token in the response.
void	setRequestedSecurityToken(RequestedSecurityTokenType requestedSecurityToken) Sets the requested security token in the response.
void	setRequestedUnattachedReference(RequestedReferenceType requestedUnattachedReference) Sets the RequestedUnattachedReference that specifies to indicate how to reference the token when it is not placed inside the message.
void	setRequestType(java.net.URI requestType) Sets the request type.
void	setSignatureAlgorithm(java.net.URI signatureAlgorithm) Sets the signature algorithm in the response.
void	setSignWith(java.net.URI signWith) Sets the signature algorithm used with the issued security token.
void	setStatus(StatusType status) Sets the result of a security token validation.
void	setTokenType(java.net.URI tokenType) Sets the token type.
void	setUseKey(UseKeyType useKey) Sets the key that used in the returned token.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestSecurityTokenResponse

public RequestSecurityTokenResponse()

Creates an instance of RequestSecurityTokenResponse.

RequestSecurityTokenResponse

public RequestSecurityTokenResponse(RequestSecurityTokenResponseType delegate)

Creates an instance of RequestSecurityTokenResponse using the specified delegate.

Parameters:

delegate - the JAXB RequestSecurityTokenResponseType that represents a WS-Trust response.

Method Detail

getTokenType

public java.net.URI getTokenType()

Obtains the URI that identifies the token type.

Returns:

a URI that represents the token type.

setTokenType

public void setTokenType(java.net.URI tokenType)

Sets the token type.

Parameters:

tokenType - a URI that identifies the token type.

getRequestType

public java.net.URI getRequestType()

Obtains the request type.

Returns:

a URI that identifies the request type.

setRequestType

public void setRequestType(java.net.URI requestType)

Sets the request type. The type must be one of the request types described in the WS-Trust specification.

Parameters:

requestType - a URI that identifies the request type.

getRequestedSecurityToken

public RequestedSecurityTokenType getRequestedSecurityToken()

Obtains the requested security token that has been set in the response.

Returns:

a reference to the RequestedSecurityTokenType that contains the token.

setRequestedSecurityToken

public void setRequestedSecurityToken(RequestedSecurityTokenType requestedSecurityToken)

Sets the requested security token in the response.

Parameters:

requestedSecurityToken - the RequestedSecurityTokenType instance to be set.

getAppliesTo

public AppliesTo getAppliesTo()

Obtains the scope to which the security token applies.

Returns:

a reference to the AppliesTo instance that represents the token scope.

setAppliesTo

public void setAppliesTo(AppliesTo appliesTo)

Sets the scope to which the security token applies.

Parameters:

appliesTo - a reference to the AppliesTo object that represents the scope to be set.

getRequestedAttachedReference

public RequestedReferenceType getRequestedAttachedReference()

Obtains the RequestedAttachedReference that indicate how to reference the returned token when that token doesn't support references using URI fragments (XML ID).

Returns:

a RequestedReferenceType that represents the token reference.

setRequestedAttachedReference

public void setRequestedAttachedReference(RequestedReferenceType requestedAttachedReference)

Sets the RequestedAttachedReference that indicate how to reference the returned token when that token doesn't support references using URI fragments (XML ID).

Parameters:

requestedAttachedReference - the RequestedReferenceType instance to be set.

getRequestedUnattachedReference

public RequestedReferenceType getRequestedUnattachedReference()

Obtains the RequestedUnattachedReference that specifies to indicate how to reference the token when it is not placed inside the message.

Returns:

a RequestedReferenceType that represents the unattached reference.

setRequestedUnattachedReference

public void setRequestedUnattachedReference(RequestedReferenceType requestedUnattachedReference)

Sets the RequestedUnattachedReference that specifies to indicate how to reference the token when it is not placed inside the message.

Parameters:

requestedUnattachedReference - the RequestedReferenceType instance to be set.

getRequestedProofToken

public RequestedProofTokenType getRequestedProofToken()

Obtains the proof of possession token that has been set in the response.

Returns:

a reference to the RequestedProofTokenType that contains the token.

setRequestedProofToken

public void setRequestedProofToken(RequestedProofTokenType requestedProofToken)

Sets the proof of possesion token in the response.

Parameters:

requestedProofToken - the RequestedProofTokenType instance to be set.

getEntropy

public EntropyType getEntropy()

Obtains the entropy that has been used in creating the key.

Returns:

a reference to the EntropyType that represents the entropy.

setEntropy

public void setEntropy(EntropyType entropy)

Sets the entropy that has been used in creating the key.

Parameters:

entropy - the EntropyType representing the entropy to be set.

getLifetime

public LifetimeType getLifetime()

Obtains the lifetime of the security token.

Returns:

a reference to the LifetimeType that represents the lifetime of the security token.

setLifetime

public void setLifetime(LifetimeType lifetime)

Sets the lifetime of the security token.

Parameters:

lifetime - the LifetimeType object representing the lifetime to be set.

getStatus

public StatusType getStatus()

Obtains the result of a security token validation.

Returns:

a referece to the StatusType instance that represents the status of the validation.

setStatus

public void setStatus(StatusType status)

Sets the result of a security token validation.

Parameters:

status - the StatusType instance to be set.

getAllowPostDating

public AllowPostdatingType getAllowPostDating()

Checks whether the returned token is a postdated token or not.

Returns:

null if the token is not postdated; a AllowPostdatingType otherwise.

setAllowPostDating

public void setAllowPostDating(AllowPostdatingType allowPostDating)

Specifies whether the returned token is a postdated token or not.

Parameters:

allowPostDating - null if the token is not postdated; a AllowPostdatingType otherwise.

getRenewing

public RenewingType getRenewing()

Obtains the renew semantics for the token request.

Returns:

a reference to the RenewingType that represents the renew semantics for the request.

setRenewing

public void setRenewing(RenewingType renewing)

Sets the renew semantics for the token request.

Parameters:

renewing - the RenewingType object representing the semantics to be set.

getOnBehalfOf

public OnBehalfOfType getOnBehalfOf()

Obtains the identity on whose behalf the token request was made.

Returns:

a reference to the OnBehalfOfType that represents the identity on whose behalf the token request was made.

setOnBehalfOf

public void setOnBehalfOf(OnBehalfOfType onBehalfOf)

Specifies the identity on whose behalf the token request was made.

Parameters:

onBehalfOf - the OnBehalfOfType object representing the identity to be set.

getIssuer

public EndpointReferenceType getIssuer()

Obtains the issuer of the token included in the request in the scenarios where the requestor is obtaining a token on behalf of another party.

Returns:

a reference to the EndpointReferenceType that represents the issuer.

setIssuer

public void setIssuer(EndpointReferenceType issuer)

Sets the issuer of the token included in the request in scenarios where the requestor is obtaining a token on behalf of another party.

Parameters:

issuer - the EndpointReferenceType object representing the issuer to be set.

getAuthenticationType

public java.net.URI getAuthenticationType()

Obtains the type of authentication that is to be conducted.

Returns:

a URI that identifies the authentication type.

setAuthenticationType

public void setAuthenticationType(java.net.URI authenticationType)

Sets the authentication type in the response.

Parameters:

authenticationType - a URI that identifies the authentication type to be set.

getAuthenticator

public AuthenticatorType getAuthenticator()

Obtains the authenticator that must be used in authenticating exchanges.

Returns:

a reference to the AuthenticatorType that represents the authenticator.

setAuthenticator

public void setAuthenticator(AuthenticatorType authenticator)

Sets the authenticator that must be used in authenticating exchanges.

Parameters:

authenticator - the AuthenticatorType instance to be set.

getKeyType

public java.net.URI getKeyType()

Obtains the type of the key that has been set in the response.

Returns:

a URI that identifies the key type.

setKeyType

public void setKeyType(java.net.URI keyType)

Sets the key type in the response.

Parameters:

keyType - a URI that specifies the key type.

getKeySize

public long getKeySize()

Obtains the size of they key that has been set in the response.

Returns:

a long representing the key size in bytes.

setKeySize

public void setKeySize(long keySize)

Sets the size of the key in the response.

Parameters:

keySize - a long representing the key size in bytes.

getSignatureAlgorithm

public java.net.URI getSignatureAlgorithm()

Obtains the signature algorithm that has been set in the response.

Returns:

a URI that represents the signature algorithm.

setSignatureAlgorithm

public void setSignatureAlgorithm(java.net.URI signatureAlgorithm)

Sets the signature algorithm in the response.

Parameters:

signatureAlgorithm - a URI that represents the algorithm to be set.

getEncryption

public EncryptionType getEncryption()

Obtains the Encryption section of the response. The Encryption element indicates that the requestor desires any returned secrets in issued security tokens to be encrypted.

Returns:

a reference to the EncryptionType object.

setEncryption

public void setEncryption(EncryptionType encryption)

Sets the Encryption section of the response. The Encryption element indicates that the requestor desires any returned secrets in issued security tokens to be encrypted.

Parameters:

encryption - the EncryptionType to be set.

getEncryptionAlgorithm

public java.net.URI getEncryptionAlgorithm()

Obtains the encryption algorithm that has been set in the response.

Returns:

a URI that represents the encryption algorithm.

setEncryptionAlgorithm

public void setEncryptionAlgorithm(java.net.URI encryptionAlgorithm)

Sets the encryption algorithm in the response.

Parameters:

encryptionAlgorithm - a URI that represents the encryption algorithm to be set.

getCanonicalizationAlgorithm

public java.net.URI getCanonicalizationAlgorithm()

Obtains the canonicalization algorithm that has been set in the response.

Returns:

a URI that represents the canonicalization algorithm.

setCanonicalizationAlgorithm

public void setCanonicalizationAlgorithm(java.net.URI canonicalizationAlgorithm)

Sets the canonicalization algorithm in the response.

Parameters:

canonicalizationAlgorithm - a URI that represents the algorithm to be set.

getProofEncryption

public ProofEncryptionType getProofEncryption()

Obtains the ProofEncryption section of the response. The ProofEncryption indicates that the requestor desires any returned secrets in issued security tokens to be encrypted.

Returns:

a reference to the ProofEncryptionType object.

setProofEncryption

public void setProofEncryption(ProofEncryptionType proofEncryption)

Sets the ProofEncryption section of the response. The ProofEncryption indicates that the requestor desires any returned secrets in issued security tokens to be encrypted.

Parameters:

proofEncryption - the ProofEncryptionType to be set.

getUseKey

public UseKeyType getUseKey()

Obtains the key that used in the returned token.

Returns:

a reference to the UseKeyType instance that represents the key used.

setUseKey

public void setUseKey(UseKeyType useKey)

Sets the key that used in the returned token.

Parameters:

useKey - the UseKeyType instance to be set.

getSignWith

public java.net.URI getSignWith()

Obtains the signature algorithm used with the issued security token.

Returns:

a URI representing the algorithm used.

setSignWith

public void setSignWith(java.net.URI signWith)

Sets the signature algorithm used with the issued security token.

Parameters:

signWith - a URI representing the algorithm used.

getEncryptWith

public java.net.URI getEncryptWith()

Obtains the encryption algorithm used with the issued security token.

Returns:

a URI representing the encryption algorithm used.

setEncryptWith

public void setEncryptWith(java.net.URI encryptWith)

Sets the encryption algorithm used with the issued security token.

Parameters:

encryptWith - a URI representing the algorithm used.

getDelegateTo

public DelegateToType getDelegateTo()

Obtains the identity to which the requested token should be delegated.

Returns:

a reference to the DelegateToType instance that represents the identity.

setDelegateTo

public void setDelegateTo(DelegateToType delegateTo)

Sets the identity to which the requested token should be delegated.

Parameters:

delegateTo - the DelegateToType object representing the identity to be set.

isForwardable

public boolean isForwardable()

Indicates whether the requested token has been marked as "forwardable" or not. In general, this flag is used when a token is normally bound to the requestor's machine or service. Using this flag, the returned token MAY be used from any source machine so long as the key is correctly proven.

Returns:

true if the requested token has been marked as "forwardable"; false otherwise.

setForwardable

public void setForwardable(boolean forwardable)

Specifies whether the requested token has been marked as "forwardable" or not. In general, this flag is used when a token is normally bound to the requestor's machine or service. Using this flag, the returned token MAY be used from any source machine so long as the key is correctly proven.

Parameters:

forwardable - true if the requested token has been marked as "forwardable"; false otherwise.

isDelegatable

public boolean isDelegatable()

Indicates whether the requested token has been marked as "delegatable" or not. Using this flag, the returned token MAY be delegated to another party.

Returns:

true if the requested token has been marked as "delegatable"; false otherwise.

setDelegatable

public void setDelegatable(boolean delegatable)

Specifies whether the requested token has been marked as "delegatable" or not. Using this flag, the returned token MAY be delegated to another party.

Parameters:

delegatable - true if the requested token has been marked as "delegatable"; false otherwise.

getPolicy

public Policy getPolicy()

Obtains the Policy that was associated with the request. The policy specifies defaults that can be overridden by the previous properties.

Returns:

a reference to the Policy that was associated with the request.

setPolicy

public void setPolicy(Policy policy)

Sets the Policy in the response. The policy specifies defaults that can be overridden by the previous properties.

Parameters:

policy - the Policy instance to be set.

getPolicyReference

public PolicyReference getPolicyReference()

Obtains the reference to the Policy that was associated with the request.

Returns:

a PolicyReference that specifies where the Policy can be found.

setPolicyReference

public void setPolicyReference(PolicyReference policyReference)

Sets the reference to the Policy that was associated with the request.

Parameters:

policyReference - the PolicyReference object to be set.

getExtensionElements

public java.util.List<java.lang.Object> getExtensionElements()

Obtains the list of request elements that are not part of the standard content model.

Returns:

a List<Object> containing the extension elements.

getContext

public java.lang.String getContext()

Obtains the response context.

Returns:

a String that identifies the original request.

setContext

public void setContext(java.lang.String context)

Sets the response context.

Parameters:

context - a String that identifies the original request.

getOtherAttributes

public java.util.Map<javax.xml.namespace.QName,java.lang.String> getOtherAttributes()

Obtains a map that contains attributes that aren't bound to any typed property on the response. This is a live reference, so attributes can be added/changed/removed directly. For this reason, there is no setter method.

Returns:

a Map<QName, String> that contains the attributes.

getAny

public java.util.List<java.lang.Object> getAny()

Gets a reference to the list that holds all response element values.

Returns:

a List<Object> containing all values specified in the response.

getDelegate

public RequestSecurityTokenResponseType getDelegate()

Obtains a reference to the RequestSecurityTokenResponseType delegate.

Returns:

a reference to the delegate instance.