public class RequestSecurityTokenResponse extends Object implements BaseRequestSecurityTokenResponse
Constructor and Description |
---|
RequestSecurityTokenResponse()
Creates an instance of
RequestSecurityTokenResponse . |
RequestSecurityTokenResponse(RequestSecurityTokenResponseType delegate)
Creates an instance of
RequestSecurityTokenResponse using the specified delegate. |
Modifier and Type | Method and Description |
---|---|
AllowPostdatingType |
getAllowPostDating()
Checks whether the returned token is a postdated token or not.
|
List<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.
|
URI |
getAuthenticationType()
Obtains the type of authentication that is to be conducted.
|
AuthenticatorType |
getAuthenticator()
Obtains the authenticator that must be used in authenticating exchanges.
|
URI |
getCanonicalizationAlgorithm()
Obtains the canonicalization algorithm that has been set in the response.
|
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. |
URI |
getEncryptionAlgorithm()
Obtains the encryption algorithm that has been set in the response.
|
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.
|
List<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.
|
URI |
getKeyType()
Obtains the type of the key that has been set in the response.
|
Lifetime |
getLifetime()
Obtains the lifetime of the security token.
|
OnBehalfOfType |
getOnBehalfOf()
Obtains the identity on whose behalf the token request was made.
|
Map<QName,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.
|
RequestedTokenCancelledType |
getRequestedTokenCancelled()
Obtains the
RequestedTokenCancelled section of the response, if it has been set. |
RequestedReferenceType |
getRequestedUnattachedReference()
Obtains the
RequestedUnattachedReference that specifies to indicate how to reference the token when it is
not
placed inside the message. |
URI |
getRequestType()
Obtains the request type.
|
URI |
getSignatureAlgorithm()
Obtains the signature algorithm that has been set in the response.
|
URI |
getSignWith()
Obtains the signature algorithm used with the issued security token.
|
StatusType |
getStatus()
Obtains the result of a security token validation.
|
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(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(URI canonicalizationAlgorithm)
Sets the canonicalization algorithm in the response.
|
void |
setContext(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(URI encryptionAlgorithm)
Sets the encryption algorithm in the response.
|
void |
setEncryptWith(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(URI keyType)
Sets the key type in the response.
|
void |
setLifetime(Lifetime 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 |
setRequestedTokenCancelled(RequestedTokenCancelledType requestedTokenCancelled)
Sets the
RequestedTokenCancelled section of 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(URI requestType)
Sets the request type.
|
void |
setSignatureAlgorithm(URI signatureAlgorithm)
Sets the signature algorithm in the response.
|
void |
setSignWith(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(URI tokenType)
Sets the token type.
|
void |
setUseKey(UseKeyType useKey)
Sets the key that used in the returned token.
|
public RequestSecurityTokenResponse()
Creates an instance of RequestSecurityTokenResponse
.
public RequestSecurityTokenResponse(RequestSecurityTokenResponseType delegate)
Creates an instance of RequestSecurityTokenResponse
using the specified delegate.
delegate
- the JAXB RequestSecurityTokenResponseType
that represents a WS-Trust response.public URI getTokenType()
Obtains the URI
that identifies the token type.
URI
that represents the token type.public void setTokenType(URI tokenType)
Sets the token type.
tokenType
- a URI
that identifies the token type.public URI getRequestType()
Obtains the request type.
URI
that identifies the request type.public void setRequestType(URI requestType)
Sets the request type. The type must be one of the request types described in the WS-Trust specification.
requestType
- a URI
that identifies the request type.public RequestedSecurityTokenType getRequestedSecurityToken()
Obtains the requested security token that has been set in the response.
RequestedSecurityTokenType
that contains the token.public void setRequestedSecurityToken(RequestedSecurityTokenType requestedSecurityToken)
Sets the requested security token in the response.
requestedSecurityToken
- the RequestedSecurityTokenType
instance to be set.public AppliesTo getAppliesTo()
Obtains the scope to which the security token applies.
AppliesTo
instance that represents the token scope.public void setAppliesTo(AppliesTo appliesTo)
Sets the scope to which the security token applies.
appliesTo
- a reference to the AppliesTo
object that represents the scope to be set.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).
RequestedReferenceType
that represents the token reference.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).
requestedAttachedReference
- the RequestedReferenceType
instance to be set.public RequestedReferenceType getRequestedUnattachedReference()
Obtains the RequestedUnattachedReference
that specifies to indicate how to reference the token when it is
not
placed inside the message.
RequestedReferenceType
that represents the unattached reference.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.
requestedUnattachedReference
- the RequestedReferenceType
instance to be set.public RequestedProofTokenType getRequestedProofToken()
Obtains the proof of possession token that has been set in the response.
RequestedProofTokenType
that contains the token.public void setRequestedProofToken(RequestedProofTokenType requestedProofToken)
Sets the proof of possesion token in the response.
requestedProofToken
- the RequestedProofTokenType
instance to be set.public RequestedTokenCancelledType getRequestedTokenCancelled()
Obtains the RequestedTokenCancelled
section of the response, if it has been set. The presence of this
element
indicates that the security token specified in the cancel request has been successfully canceled by the STS.
RequestedTokenCancelledType
, or null
if the response doesn't have a
RequestedTokenCancelled
section.public void setRequestedTokenCancelled(RequestedTokenCancelledType requestedTokenCancelled)
Sets the RequestedTokenCancelled
section of the response. This element is used to inform the client that
the
token specified in a cancel request has been successfully canceled by the STS.
requestedTokenCancelled
- a reference to the RequestedTokenCancelledType
.public EntropyType getEntropy()
Obtains the entropy that has been used in creating the key.
EntropyType
that represents the entropy.public void setEntropy(EntropyType entropy)
Sets the entropy that has been used in creating the key.
entropy
- the EntropyType
representing the entropy to be set.public Lifetime getLifetime()
Obtains the lifetime of the security token.
Lifetime
that represents the lifetime of the security token.public void setLifetime(Lifetime lifetime)
Sets the lifetime of the security token.
lifetime
- the Lifetime
object representing the lifetime to be set.public StatusType getStatus()
Obtains the result of a security token validation.
StatusType
instance that represents the status of the validation.public void setStatus(StatusType status)
Sets the result of a security token validation.
status
- the StatusType
instance to be set.public AllowPostdatingType getAllowPostDating()
Checks whether the returned token is a postdated token or not.
null
if the token is not postdated; a AllowPostdatingType
otherwise.public void setAllowPostDating(AllowPostdatingType allowPostDating)
Specifies whether the returned token is a postdated token or not.
allowPostDating
- null
if the token is not postdated; a AllowPostdatingType
otherwise.public RenewingType getRenewing()
Obtains the renew semantics for the token request.
RenewingType
that represents the renew semantics for the request.public void setRenewing(RenewingType renewing)
Sets the renew semantics for the token request.
renewing
- the RenewingType
object representing the semantics to be set.public OnBehalfOfType getOnBehalfOf()
Obtains the identity on whose behalf the token request was made.
OnBehalfOfType
that represents the identity on whose behalf the token request
was
made.public void setOnBehalfOf(OnBehalfOfType onBehalfOf)
Specifies the identity on whose behalf the token request was made.
onBehalfOf
- the OnBehalfOfType
object representing the identity to be set.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.
EndpointReferenceType
that represents the issuer.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.
issuer
- the EndpointReferenceType
object representing the issuer to be set.public URI getAuthenticationType()
Obtains the type of authentication that is to be conducted.
URI
that identifies the authentication type.public void setAuthenticationType(URI authenticationType)
Sets the authentication type in the response.
authenticationType
- a URI
that identifies the authentication type to be set.public AuthenticatorType getAuthenticator()
Obtains the authenticator that must be used in authenticating exchanges.
AuthenticatorType
that represents the authenticator.public void setAuthenticator(AuthenticatorType authenticator)
Sets the authenticator that must be used in authenticating exchanges.
authenticator
- the AuthenticatorType
instance to be set.public URI getKeyType()
Obtains the type of the key that has been set in the response.
URI
that identifies the key type.public void setKeyType(URI keyType)
Sets the key type in the response.
keyType
- a URI
that specifies the key type.public long getKeySize()
Obtains the size of they key that has been set in the response.
long
representing the key size in bytes.public void setKeySize(long keySize)
Sets the size of the key in the response.
keySize
- a long
representing the key size in bytes.public URI getSignatureAlgorithm()
Obtains the signature algorithm that has been set in the response.
URI
that represents the signature algorithm.public void setSignatureAlgorithm(URI signatureAlgorithm)
Sets the signature algorithm in the response.
signatureAlgorithm
- a URI
that represents the algorithm to be set.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.
EncryptionType
object.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.
encryption
- the EncryptionType
to be set.public URI getEncryptionAlgorithm()
Obtains the encryption algorithm that has been set in the response.
URI
that represents the encryption algorithm.public void setEncryptionAlgorithm(URI encryptionAlgorithm)
Sets the encryption algorithm in the response.
encryptionAlgorithm
- a URI
that represents the encryption algorithm to be set.public URI getCanonicalizationAlgorithm()
Obtains the canonicalization algorithm that has been set in the response.
URI
that represents the canonicalization algorithm.public void setCanonicalizationAlgorithm(URI canonicalizationAlgorithm)
Sets the canonicalization algorithm in the response.
canonicalizationAlgorithm
- a URI
that represents the algorithm to be set.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.
ProofEncryptionType
object.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.
proofEncryption
- the ProofEncryptionType
to be set.public UseKeyType getUseKey()
Obtains the key that used in the returned token.
UseKeyType
instance that represents the key used.public void setUseKey(UseKeyType useKey)
Sets the key that used in the returned token.
useKey
- the UseKeyType
instance to be set.public URI getSignWith()
Obtains the signature algorithm used with the issued security token.
URI
representing the algorithm used.public void setSignWith(URI signWith)
Sets the signature algorithm used with the issued security token.
signWith
- a URI
representing the algorithm used.public URI getEncryptWith()
Obtains the encryption algorithm used with the issued security token.
URI
representing the encryption algorithm used.public void setEncryptWith(URI encryptWith)
Sets the encryption algorithm used with the issued security token.
encryptWith
- a URI
representing the algorithm used.public DelegateToType getDelegateTo()
Obtains the identity to which the requested token should be delegated.
DelegateToType
instance that represents the identity.public void setDelegateTo(DelegateToType delegateTo)
Sets the identity to which the requested token should be delegated.
delegateTo
- the DelegateToType
object representing the identity to be set.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.
true
if the requested token has been marked as "forwardable"; false
otherwise.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.
forwardable
- true
if the requested token has been marked as "forwardable"; false
otherwise.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.
true
if the requested token has been marked as "delegatable"; false
otherwise.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.
delegatable
- true
if the requested token has been marked as "delegatable"; false
otherwise.public Policy getPolicy()
Obtains the Policy
that was associated with the request. The policy specifies defaults that can be
overridden by
the previous properties.
Policy
that was associated with the request.public void setPolicy(Policy policy)
Sets the Policy
in the response. The policy specifies defaults that can be overridden by the previous
properties.
policy
- the Policy
instance to be set.public PolicyReference getPolicyReference()
Obtains the reference to the Policy
that was associated with the request.
PolicyReference
that specifies where the Policy
can be found.public void setPolicyReference(PolicyReference policyReference)
Sets the reference to the Policy
that was associated with the request.
policyReference
- the PolicyReference
object to be set.public List<Object> getExtensionElements()
Obtains the list of request elements that are not part of the standard content model.
List<Object>
containing the extension elements.public String getContext()
Obtains the response context.
String
that identifies the original request.public void setContext(String context)
Sets the response context.
context
- a String
that identifies the original request.public Map<QName,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.
Map<QName, String>
that contains the attributes.public List<Object> getAny()
Gets a reference to the list that holds all response element values.
List<Object>
containing all values specified in the response.public RequestSecurityTokenResponseType getDelegate()
Obtains a reference to the RequestSecurityTokenResponseType
delegate.
Copyright © 2017 JBoss by Red Hat. All rights reserved.