Package com.sun.xml.ws.security.trust.impl.elements

Class RequestSecurityTokenImpl

java.lang.Object

com.sun.xml.ws.security.trust.impl.bindings.RequestSecurityTokenType

com.sun.xml.ws.security.trust.impl.elements.RequestSecurityTokenImpl

All Implemented Interfaces:

BaseSTSRequest, RequestSecurityToken, WSTrustElementBase

public class RequestSecurityTokenImpl
extends RequestSecurityTokenType
implements RequestSecurityToken

Implementation of the RequestSecurityToken interface.

Author:

Manveen Kaur

Field Summary

Fields inherited from class com.sun.xml.ws.security.trust.impl.bindings.RequestSecurityTokenType

any, context

Constructor Summary

Constructors

Constructor	Description
RequestSecurityTokenImpl()
RequestSecurityTokenImpl(RequestSecurityTokenType rstType)
RequestSecurityTokenImpl(URI tokenType, URI requestType)
RequestSecurityTokenImpl(URI tokenType, URI requestType, CancelTarget cancel)
RequestSecurityTokenImpl(URI tokenType, URI requestType, URI context, AppliesTo scopes, Claims claims, Entropy entropy, Lifetime lifetime, URI algorithm)
RequestSecurityTokenImpl(URI tokenType, URI requestType, URI context, RenewTarget target, AllowPostdating apd, Renewing renewingInfo)

Method Summary

Modifier and Type	Method	Description
ActAs	getActAs()
AllowPostdating	getAllowPostdating()	Get the AllowPostdating element for the token if specified, null otherwise NOTE: Although this is an issue with the WSTrust spec, leaving it here for now.
AppliesTo	getAppliesTo()	Get the desired AppliesTo policy settings for the token if specified, null otherwise
URI	getAuthenticationType()	get Authentication Type parameter if set, null otherwise
BinaryExchange	getBinaryExchange()	get BinaryExchange element if any, null otherwise
CancelTarget	getCancelTarget()
URI	getCanonicalizationAlgorithm()	get CanonicalizationAlgorithm value if set, return default otherwise
Claims	getClaims()	Get the desired claims settings for the token if specified, null otherwise
URI	getComputedKeyAlgorithm()	get CanonicalizationAlgorithm value if set, return default otherwise
boolean	getDelegatable()	Get the value of the Delegatable flag NOTE: default value of this flag is false
DelegateTo	getDelegateTo()	get the DelegateTo value if set, null otherwise
Encryption	getEncryption()	get Encryption value if set, return null otherwise
URI	getEncryptionAlgorithm()	get EncryptionAlgorithm value if set, return default otherwise
URI	getEncryptWith()	Get the Encryption Algorithm to be used with the token if set, null otherwise
Entropy	getEntropy()	Get the entropy for the requested token
List<Object>	getExtensionElements()
boolean	getForwardable()	Get the value of the Forwardable flag NOTE: default value of this flag is true
Issuer	getIssuer()	get Issuer of the SecurityToken Presented in the Message, null otherwise
long	getKeySize()	get the KeySize parameter if specified, 0 otherwise
URI	getKeyType()	get KeyType Parameter if set, null otherwise
URI	getKeyWrapAlgorithm()	get KeyWrapAlgorithm value if set, return default otherwise
Lifetime	getLifetime()	Get the desired LifeTime settings for the token if specified, null otherwise
OnBehalfOf	getOnBehalfOf()	Get the value of OnBehalfOf for the token if specified, null otherwise
Participants	getParticipants()	Get the participants sharing the token if specified, null otherwise
Policy	getPolicy()	Get the desired policy settings for the token if specified, null otherwise
PolicyReference	getPolicyReference()	Get the desired policyReference settings for the token if specified, null otherwise
ProofEncryption	getProofEncryption()	Get the desired proofEncryption settings for the token if specified, null otherwise
Renewing	getRenewable()	get the <wst:Renewing/> element if present, null otherwise
RenewTarget	getRenewTarget()
URI	getRequestType()	Get the type of request, specified as a URI.
SecondaryParameters	getSecondaryParameters()
URI	getSignatureAlgorithm()	get SignatureAlgorithm value if set, return default otherwise
SignChallenge	getSignChallenge()	get SignChallenge element if any, null otherwise
URI	getSignWith()	Get the Signature Algorithm to be used with the token if set, null otherwise
URI	getTokenType()	Get the type of security token, specified as a URI.
UseKey	getUseKey()	Get the desired useKey settings for the token if specified, null otherwise
ValidateTarget	getValidateTarget()
void	setActAs(ActAs actAs)
void	setAllowPostdating(AllowPostdating allowPostdating)	Set the desired policyReference settings for the requested token
void	setAppliesTo(AppliesTo appliesTo)	Set the desired policy settings for the requested token
void	setAuthenticationType(URI uri)	set AuthenticationType
void	setBinaryExchange(BinaryExchange exchange)	set a BinaryExchange
void	setCancelTarget(CancelTarget cTarget)
void	setCanonicalizationAlgorithm(URI algorithm)	set CanonicalizationAlgorithm
void	setClaims(Claims claims)	Set the desired claims settings for the requested token
void	setComputedKeyAlgorithm(URI algorithm)	set ComputedKeyAlgorithm
void	setDelegatable(boolean flag)	Set if the requested token be delegatable
void	setDelegateTo(DelegateTo delegateTo)	set the Delegate to which the issued token be delegated
void	setEncryption(Encryption enc)	set Encryption
void	setEncryptionAlgorithm(URI algorithm)	set EncryptionAlgorithm
void	setEncryptWith(URI algorithm)	Set the Encryption Algorithm to be used with the issued token
void	setEntropy(Entropy entropy)	Set the entropy for the requested token
void	setForwardable(boolean flag)	Set if the requested token be forwardable
void	setIssuer(Issuer issuer)	set Issuer of the SecurityToken Presented in the message
void	setKeySize(long size)	set the KeySize parameter
void	setKeyType(URI keytype)	set KeyType parameter
void	setKeyWrapAlgorithm(URI algorithm)	set KeyWrapAlgorithm
void	setLifetime(Lifetime lifetime)	Set the desired lifetime settings for the requested token
void	setOnBehalfOf(OnBehalfOf onBehalfOf)	Set the value of OnBehalfOf for the requested token
void	setParticipants(Participants participants)	Set the Participants Sharing the requested Token
void	setPolicy(Policy policy)	Set the desired policy settings for the requested token
void	setPolicyReference(PolicyReference policyRef)	Set the desired policyReference settings for the requested token
void	setProofEncryption(ProofEncryption proofEncryption)	Set the desired proofEncryption settings for the requested token
void	setRenewable(Renewing renew)	set a <wst:Renewing/> element to make a renewable Issue request
void	setRenewTarget(RenewTarget target)
void	setRequestType(URI requestType)	Set the type of request, specified as a URI.
void	setSecondaryParameters(SecondaryParameters sp)
void	setSignatureAlgorithm(URI algorithm)	set SignatureAlgorithm
void	setSignChallenge(SignChallenge challenge)	Set a SignChallenge
void	setSignWith(URI algorithm)	Set the Signature Algorithm to be used with the issued token
void	setTokenType(URI tokenType)	Set the type of security token, specified as a URI.
void	setUseKey(UseKey useKey)	Set the desired useKey settings for the requested token
void	setValidateTarget(ValidateTarget target)

Methods inherited from class com.sun.xml.ws.security.trust.impl.bindings.RequestSecurityTokenType

getAny, getContext, getOtherAttributes, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.xml.ws.security.trust.elements.RequestSecurityToken

getAny, getContext, getOtherAttributes

Constructor Detail

RequestSecurityTokenImpl

public RequestSecurityTokenImpl()

RequestSecurityTokenImpl

public RequestSecurityTokenImpl(URI tokenType,
                                URI requestType)

RequestSecurityTokenImpl

public RequestSecurityTokenImpl(URI tokenType,
                                URI requestType,
                                URI context,
                                AppliesTo scopes,
                                Claims claims,
                                Entropy entropy,
                                Lifetime lifetime,
                                URI algorithm)

RequestSecurityTokenImpl

public RequestSecurityTokenImpl(URI tokenType,
                                URI requestType,
                                URI context,
                                RenewTarget target,
                                AllowPostdating apd,
                                Renewing renewingInfo)

RequestSecurityTokenImpl

public RequestSecurityTokenImpl(URI tokenType,
                                URI requestType,
                                CancelTarget cancel)

RequestSecurityTokenImpl

public RequestSecurityTokenImpl(RequestSecurityTokenType rstType)
                         throws URISyntaxException,
                                WSTrustException

Throws:

URISyntaxException

WSTrustException

Method Detail

setClaims

public final void setClaims(Claims claims)

Description copied from interface: RequestSecurityToken

Set the desired claims settings for the requested token

Specified by:

setClaims in interface RequestSecurityToken

getClaims

public Claims getClaims()

Description copied from interface: RequestSecurityToken

Get the desired claims settings for the token if specified, null otherwise

Specified by:

getClaims in interface RequestSecurityToken

setCancelTarget

public final void setCancelTarget(CancelTarget cTarget)

Specified by:

setCancelTarget in interface RequestSecurityToken

getCancelTarget

public CancelTarget getCancelTarget()

Specified by:

getCancelTarget in interface RequestSecurityToken

setRenewTarget

public final void setRenewTarget(RenewTarget target)

Specified by:

setRenewTarget in interface RequestSecurityToken

getRenewTarget

public RenewTarget getRenewTarget()

Specified by:

getRenewTarget in interface RequestSecurityToken

setValidateTarget

public final void setValidateTarget(ValidateTarget target)

Specified by:

setValidateTarget in interface RequestSecurityToken

getValidateTarget

public ValidateTarget getValidateTarget()

Specified by:

getValidateTarget in interface RequestSecurityToken

setParticipants

public final void setParticipants(Participants participants)

Description copied from interface: RequestSecurityToken

Set the Participants Sharing the requested Token

Specified by:

setParticipants in interface RequestSecurityToken

getParticipants

public Participants getParticipants()

Description copied from interface: RequestSecurityToken

Get the participants sharing the token if specified, null otherwise

Specified by:

getParticipants in interface RequestSecurityToken

getTokenType

public URI getTokenType()

Description copied from interface: WSTrustElementBase

Get the type of security token, specified as a URI.

Specified by:

getTokenType in interface WSTrustElementBase

Returns:

URI

setTokenType

public final void setTokenType(URI tokenType)

Description copied from interface: WSTrustElementBase

Set the type of security token, specified as a URI.

Specified by:

setTokenType in interface WSTrustElementBase

Parameters:

tokenType - URI

setSecondaryParameters

public void setSecondaryParameters(SecondaryParameters sp)

Specified by:

setSecondaryParameters in interface RequestSecurityToken

getSecondaryParameters

public SecondaryParameters getSecondaryParameters()

Specified by:

getSecondaryParameters in interface RequestSecurityToken

getRequestType

public URI getRequestType()

Description copied from interface: RequestSecurityToken

Get the type of request, specified as a URI. The URI indicates the class of function that is requested.

Specified by:

getRequestType in interface RequestSecurityToken

Returns:

URI

setRequestType

public final void setRequestType(@NotNull
                                 URI requestType)

Description copied from interface: RequestSecurityToken

Set the type of request, specified as a URI.

Specified by:

setRequestType in interface RequestSecurityToken

Parameters:

requestType - URI

getLifetime

public Lifetime getLifetime()

Description copied from interface: WSTrustElementBase

Get the desired LifeTime settings for the token if specified, null otherwise

Specified by:

getLifetime in interface WSTrustElementBase

setLifetime

public final void setLifetime(Lifetime lifetime)

Description copied from interface: WSTrustElementBase

Set the desired lifetime settings for the requested token

Specified by:

setLifetime in interface WSTrustElementBase

getEntropy

public Entropy getEntropy()

Description copied from interface: WSTrustElementBase

Get the entropy for the requested token

Specified by:

getEntropy in interface WSTrustElementBase

Returns:

Entropy

setEntropy

public final void setEntropy(Entropy entropy)

Description copied from interface: WSTrustElementBase

Set the entropy for the requested token

Specified by:

setEntropy in interface WSTrustElementBase

Parameters:

entropy - Entropy

setAppliesTo

public final void setAppliesTo(AppliesTo appliesTo)

Description copied from interface: WSTrustElementBase

Set the desired policy settings for the requested token

Specified by:

setAppliesTo in interface WSTrustElementBase

Parameters:

appliesTo - AppliesTo

getAppliesTo

public AppliesTo getAppliesTo()

Description copied from interface: WSTrustElementBase

Get the desired AppliesTo policy settings for the token if specified, null otherwise

Specified by:

getAppliesTo in interface WSTrustElementBase

Returns:

AppliesTo

setOnBehalfOf

public final void setOnBehalfOf(OnBehalfOf onBehalfOf)

Description copied from interface: WSTrustElementBase

Set the value of OnBehalfOf for the requested token

Specified by:

setOnBehalfOf in interface WSTrustElementBase

Parameters:

onBehalfOf - OnBehalfOf

getOnBehalfOf

public OnBehalfOf getOnBehalfOf()

Description copied from interface: WSTrustElementBase

Get the value of OnBehalfOf for the token if specified, null otherwise

Specified by:

getOnBehalfOf in interface WSTrustElementBase

Returns:

OnBehalfOf

setActAs

public void setActAs(ActAs actAs)

Specified by:

setActAs in interface RequestSecurityToken

getActAs

public ActAs getActAs()

Specified by:

getActAs in interface RequestSecurityToken

setIssuer

public final void setIssuer(Issuer issuer)

Description copied from interface: WSTrustElementBase

set Issuer of the SecurityToken Presented in the message

Specified by:

setIssuer in interface WSTrustElementBase

getIssuer

public Issuer getIssuer()

Description copied from interface: WSTrustElementBase

get Issuer of the SecurityToken Presented in the Message, null otherwise

Specified by:

getIssuer in interface WSTrustElementBase

setRenewable

public final void setRenewable(Renewing renew)

Description copied from interface: WSTrustElementBase

set a <wst:Renewing/> element to make a renewable Issue request

Specified by:

setRenewable in interface WSTrustElementBase

getRenewable

public Renewing getRenewable()

Description copied from interface: WSTrustElementBase

get the <wst:Renewing/> element if present, null otherwise

Specified by:

getRenewable in interface WSTrustElementBase

setSignChallenge

public final void setSignChallenge(SignChallenge challenge)

Description copied from interface: WSTrustElementBase

Set a SignChallenge

Specified by:

setSignChallenge in interface WSTrustElementBase

getSignChallenge

public SignChallenge getSignChallenge()

Description copied from interface: WSTrustElementBase

get SignChallenge element if any, null otherwise

Specified by:

getSignChallenge in interface WSTrustElementBase

setBinaryExchange

public final void setBinaryExchange(BinaryExchange exchange)

Description copied from interface: WSTrustElementBase

set a BinaryExchange

Specified by:

setBinaryExchange in interface WSTrustElementBase

getBinaryExchange

public BinaryExchange getBinaryExchange()

Description copied from interface: WSTrustElementBase

get BinaryExchange element if any, null otherwise

Specified by:

getBinaryExchange in interface WSTrustElementBase

setAuthenticationType

public final void setAuthenticationType(URI uri)

Description copied from interface: WSTrustElementBase

set AuthenticationType

Specified by:

setAuthenticationType in interface WSTrustElementBase

getAuthenticationType

public URI getAuthenticationType()

Description copied from interface: WSTrustElementBase

get Authentication Type parameter if set, null otherwise

Specified by:

getAuthenticationType in interface WSTrustElementBase

setKeyType

public final void setKeyType(@NotNull
                             URI keytype)
                      throws WSTrustException

Description copied from interface: WSTrustElementBase

set KeyType parameter

Specified by:

setKeyType in interface WSTrustElementBase

Throws:

WSTrustException

getKeyType

public URI getKeyType()

Description copied from interface: WSTrustElementBase

get KeyType Parameter if set, null otherwise

Specified by:

getKeyType in interface WSTrustElementBase

setKeySize

public final void setKeySize(long size)

Description copied from interface: WSTrustElementBase

set the KeySize parameter

Specified by:

setKeySize in interface WSTrustElementBase

getKeySize

public long getKeySize()

Description copied from interface: WSTrustElementBase

get the KeySize parameter if specified, 0 otherwise

Specified by:

getKeySize in interface WSTrustElementBase

setSignatureAlgorithm

public final void setSignatureAlgorithm(URI algorithm)

Description copied from interface: WSTrustElementBase

set SignatureAlgorithm

Specified by:

setSignatureAlgorithm in interface WSTrustElementBase

getSignatureAlgorithm

public URI getSignatureAlgorithm()

Description copied from interface: WSTrustElementBase

get SignatureAlgorithm value if set, return default otherwise

Specified by:

getSignatureAlgorithm in interface WSTrustElementBase

setEncryptionAlgorithm

public final void setEncryptionAlgorithm(URI algorithm)

Description copied from interface: WSTrustElementBase

set EncryptionAlgorithm

Specified by:

setEncryptionAlgorithm in interface WSTrustElementBase

getEncryptionAlgorithm

public URI getEncryptionAlgorithm()

Description copied from interface: WSTrustElementBase

get EncryptionAlgorithm value if set, return default otherwise

Specified by:

getEncryptionAlgorithm in interface WSTrustElementBase

setCanonicalizationAlgorithm

public final void setCanonicalizationAlgorithm(URI algorithm)

Description copied from interface: WSTrustElementBase

set CanonicalizationAlgorithm

Specified by:

setCanonicalizationAlgorithm in interface WSTrustElementBase

getCanonicalizationAlgorithm

public URI getCanonicalizationAlgorithm()

Description copied from interface: WSTrustElementBase

get CanonicalizationAlgorithm value if set, return default otherwise

Specified by:

getCanonicalizationAlgorithm in interface WSTrustElementBase

setUseKey

public final void setUseKey(UseKey useKey)

Description copied from interface: WSTrustElementBase

Set the desired useKey settings for the requested token

Specified by:

setUseKey in interface WSTrustElementBase

getUseKey

public UseKey getUseKey()

Description copied from interface: WSTrustElementBase

Get the desired useKey settings for the token if specified, null otherwise

Specified by:

getUseKey in interface WSTrustElementBase

setProofEncryption

public final void setProofEncryption(ProofEncryption proofEncryption)

Description copied from interface: WSTrustElementBase

Set the desired proofEncryption settings for the requested token

Specified by:

setProofEncryption in interface WSTrustElementBase

getProofEncryption

public ProofEncryption getProofEncryption()

Description copied from interface: WSTrustElementBase

Get the desired proofEncryption settings for the token if specified, null otherwise

Specified by:

getProofEncryption in interface WSTrustElementBase

setComputedKeyAlgorithm

public final void setComputedKeyAlgorithm(@NotNull
                                          URI algorithm)

Description copied from interface: WSTrustElementBase

set ComputedKeyAlgorithm

Specified by:

setComputedKeyAlgorithm in interface WSTrustElementBase

getComputedKeyAlgorithm

public URI getComputedKeyAlgorithm()

Description copied from interface: WSTrustElementBase

get CanonicalizationAlgorithm value if set, return default otherwise

Specified by:

getComputedKeyAlgorithm in interface WSTrustElementBase

setEncryption

public final void setEncryption(Encryption enc)

Description copied from interface: WSTrustElementBase

set Encryption

Specified by:

setEncryption in interface WSTrustElementBase

getEncryption

public Encryption getEncryption()

Description copied from interface: WSTrustElementBase

get Encryption value if set, return null otherwise

Specified by:

getEncryption in interface WSTrustElementBase

setSignWith

public final void setSignWith(URI algorithm)

Description copied from interface: WSTrustElementBase

Set the Signature Algorithm to be used with the issued token

Specified by:

setSignWith in interface WSTrustElementBase

getSignWith

public URI getSignWith()

Description copied from interface: WSTrustElementBase

Get the Signature Algorithm to be used with the token if set, null otherwise

Specified by:

getSignWith in interface WSTrustElementBase

setEncryptWith

public final void setEncryptWith(URI algorithm)

Description copied from interface: WSTrustElementBase

Set the Encryption Algorithm to be used with the issued token

Specified by:

setEncryptWith in interface WSTrustElementBase

getEncryptWith

public URI getEncryptWith()

Description copied from interface: WSTrustElementBase

Get the Encryption Algorithm to be used with the token if set, null otherwise

Specified by:

getEncryptWith in interface WSTrustElementBase

setKeyWrapAlgorithm

public void setKeyWrapAlgorithm(URI algorithm)

Description copied from interface: WSTrustElementBase

set KeyWrapAlgorithm

Specified by:

setKeyWrapAlgorithm in interface WSTrustElementBase

getKeyWrapAlgorithm

public URI getKeyWrapAlgorithm()

Description copied from interface: WSTrustElementBase

get KeyWrapAlgorithm value if set, return default otherwise

Specified by:

getKeyWrapAlgorithm in interface WSTrustElementBase

setDelegateTo

public final void setDelegateTo(DelegateTo delegateTo)

Description copied from interface: WSTrustElementBase

set the Delegate to which the issued token be delegated

Specified by:

setDelegateTo in interface WSTrustElementBase

getDelegateTo

public DelegateTo getDelegateTo()

Description copied from interface: WSTrustElementBase

get the DelegateTo value if set, null otherwise

Specified by:

getDelegateTo in interface WSTrustElementBase

setForwardable

public final void setForwardable(boolean flag)

Description copied from interface: WSTrustElementBase

Set if the requested token be forwardable

Specified by:

setForwardable in interface WSTrustElementBase

getForwardable

public boolean getForwardable()

Description copied from interface: WSTrustElementBase

Get the value of the Forwardable flag NOTE: default value of this flag is true

Specified by:

getForwardable in interface WSTrustElementBase

setDelegatable

public final void setDelegatable(boolean flag)

Description copied from interface: WSTrustElementBase

Set if the requested token be delegatable

Specified by:

setDelegatable in interface WSTrustElementBase

getDelegatable

public boolean getDelegatable()

Description copied from interface: WSTrustElementBase

Get the value of the Delegatable flag NOTE: default value of this flag is false

Specified by:

getDelegatable in interface WSTrustElementBase

setPolicy

public final void setPolicy(Policy policy)

Description copied from interface: WSTrustElementBase

Set the desired policy settings for the requested token

Specified by:

setPolicy in interface WSTrustElementBase

getPolicy

public Policy getPolicy()

Description copied from interface: WSTrustElementBase

Get the desired policy settings for the token if specified, null otherwise

Specified by:

getPolicy in interface WSTrustElementBase

setPolicyReference

public final void setPolicyReference(PolicyReference policyRef)

Description copied from interface: WSTrustElementBase

Set the desired policyReference settings for the requested token

Specified by:

setPolicyReference in interface WSTrustElementBase

getPolicyReference

public PolicyReference getPolicyReference()

Description copied from interface: WSTrustElementBase

Get the desired policyReference settings for the token if specified, null otherwise

Specified by:

getPolicyReference in interface WSTrustElementBase

getAllowPostdating

public AllowPostdating getAllowPostdating()

Description copied from interface: WSTrustElementBase

Get the AllowPostdating element for the token if specified, null otherwise NOTE: Although this is an issue with the WSTrust spec, leaving it here for now. This can be removed or modified later depending on the outcome of the issue.

Specified by:

getAllowPostdating in interface WSTrustElementBase

setAllowPostdating

public final void setAllowPostdating(AllowPostdating allowPostdating)

Description copied from interface: WSTrustElementBase

Set the desired policyReference settings for the requested token

Specified by:

setAllowPostdating in interface WSTrustElementBase

getExtensionElements

public List<Object> getExtensionElements()

Specified by:

getExtensionElements in interface RequestSecurityToken