Interface WSTrustElementBase
- All Known Subinterfaces:
RequestSecurityToken,RequestSecurityTokenResponse,SecondaryParameters
- All Known Implementing Classes:
RequestSecurityTokenImpl,RequestSecurityTokenImpl,RequestSecurityTokenResponseImpl,RequestSecurityTokenResponseImpl,SecondaryParametersImpl
public interface WSTrustElementBase
- Author:
- WS-Trust Implementation Team.
-
Method Summary
Modifier and TypeMethodDescriptionGet 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.Get the desired AppliesTo policy settings for the token if specified, null otherwiseget Authentication Type parameter if set, null otherwiseget BinaryExchange element if any, null otherwiseget CanonicalizationAlgorithm value if set, return default otherwiseget CanonicalizationAlgorithm value if set, return default otherwisebooleanGet the value of the Delegatable flag NOTE: default value of this flag is falseget the DelegateTo value if set, null otherwiseget Encryption value if set, return null otherwiseget EncryptionAlgorithm value if set, return default otherwiseGet the Encryption Algorithm to be used with the token if set, null otherwiseGet the entropy for the requested tokenbooleanGet the value of the Forwardable flag NOTE: default value of this flag is trueget Issuer of the SecurityToken Presented in the Message, null otherwiselongget the KeySize parameter if specified, 0 otherwiseget KeyType Parameter if set, null otherwiseget KeyWrapAlgorithm value if set, return default otherwiseGet the desired LifeTime settings for the token if specified, null otherwiseGet the value of OnBehalfOf for the token if specified, null otherwisecom.sun.xml.ws.policy.PolicyGet the desired policy settings for the token if specified, null otherwiseGet the desired policyReference settings for the token if specified, null otherwiseGet the desired proofEncryption settings for the token if specified, null otherwiseget the<wst:Renewing/>element if present, null otherwiseget SignatureAlgorithm value if set, return default otherwiseget SignChallenge element if any, null otherwiseGet the Signature Algorithm to be used with the token if set, null otherwiseGet the type of security token, specified as a URI.Get the desired useKey settings for the token if specified, null otherwisevoidsetAllowPostdating(AllowPostdating allowPostDating) Set the desired policyReference settings for the requested tokenvoidsetAppliesTo(AppliesTo appliesTo) Set the desired policy settings for the requested tokenvoidsetAuthenticationType(URI uri) set AuthenticationTypevoidsetBinaryExchange(BinaryExchange challenge) set a BinaryExchangevoidsetCanonicalizationAlgorithm(URI algorithm) set CanonicalizationAlgorithmvoidsetComputedKeyAlgorithm(URI algorithm) set ComputedKeyAlgorithmvoidsetDelegatable(boolean flag) Set if the requested token be delegatablevoidset the Delegate to which the issued token be delegatedvoidsetEncryption(Encryption enc) set EncryptionvoidsetEncryptionAlgorithm(URI algorithm) set EncryptionAlgorithmvoidsetEncryptWith(URI algorithm) Set the Encryption Algorithm to be used with the issued tokenvoidsetEntropy(Entropy entropy) Set the entropy for the requested tokenvoidsetForwardable(boolean flag) Set if the requested token be forwardablevoidset Issuer of the SecurityToken Presented in the messagevoidsetKeySize(long size) set the KeySize parametervoidsetKeyType(URI keytype) set KeyType parametervoidsetKeyWrapAlgorithm(URI algorithm) set KeyWrapAlgorithmvoidsetLifetime(Lifetime lifetime) Set the desired lifetime settings for the requested tokenvoidsetOnBehalfOf(OnBehalfOf onBehalfOf) Set the value of OnBehalfOf for the requested tokenvoidsetPolicy(com.sun.xml.ws.policy.Policy policy) Set the desired policy settings for the requested tokenvoidsetPolicyReference(PolicyReference policyRef) Set the desired policyReference settings for the requested tokenvoidsetProofEncryption(ProofEncryption proofEncryption) Set the desired proofEncryption settings for the requested tokenvoidsetRenewable(Renewing renew) set a<wst:Renewing/>element to make a renewable Issue requestvoidsetSignatureAlgorithm(URI algorithm) set SignatureAlgorithmvoidsetSignChallenge(SignChallenge challenge) Set a SignChallengevoidsetSignWith(URI algorithm) Set the Signature Algorithm to be used with the issued tokenvoidsetTokenType(URI tokenType) Set the type of security token, specified as a URI.voidSet the desired useKey settings for the requested token
-
Method Details
-
getTokenType
URI getTokenType()Get the type of security token, specified as a URI.- Returns:
URI
-
setTokenType
Set the type of security token, specified as a URI.- Parameters:
tokenType-URI
-
getLifetime
Lifetime getLifetime()Get the desired LifeTime settings for the token if specified, null otherwise -
setLifetime
Set the desired lifetime settings for the requested token -
getEntropy
Entropy getEntropy()Get the entropy for the requested token- Returns:
Entropy
-
setEntropy
Set the entropy for the requested token- Parameters:
entropy-Entropy
-
setAppliesTo
Set the desired policy settings for the requested token- Parameters:
appliesTo-AppliesTo
-
getAppliesTo
AppliesTo getAppliesTo()Get the desired AppliesTo policy settings for the token if specified, null otherwise- Returns:
AppliesTo
-
setOnBehalfOf
Set the value of OnBehalfOf for the requested token- Parameters:
onBehalfOf-OnBehalfOf
-
getOnBehalfOf
OnBehalfOf getOnBehalfOf()Get the value of OnBehalfOf for the token if specified, null otherwise- Returns:
OnBehalfOf
-
setIssuer
set Issuer of the SecurityToken Presented in the message -
getIssuer
Issuer getIssuer()get Issuer of the SecurityToken Presented in the Message, null otherwise -
setRenewable
set a<wst:Renewing/>element to make a renewable Issue request -
getRenewable
Renewing getRenewable()get the<wst:Renewing/>element if present, null otherwise -
setSignChallenge
Set a SignChallenge -
getSignChallenge
SignChallenge getSignChallenge()get SignChallenge element if any, null otherwise -
setBinaryExchange
set a BinaryExchange -
getBinaryExchange
BinaryExchange getBinaryExchange()get BinaryExchange element if any, null otherwise -
setAuthenticationType
set AuthenticationType -
getAuthenticationType
URI getAuthenticationType()get Authentication Type parameter if set, null otherwise -
setKeyType
set KeyType parameter- Throws:
WSTrustException
-
getKeyType
URI getKeyType()get KeyType Parameter if set, null otherwise -
setKeySize
void setKeySize(long size) set the KeySize parameter -
getKeySize
long getKeySize()get the KeySize parameter if specified, 0 otherwise -
setSignatureAlgorithm
set SignatureAlgorithm -
getSignatureAlgorithm
URI getSignatureAlgorithm()get SignatureAlgorithm value if set, return default otherwise -
setEncryptionAlgorithm
set EncryptionAlgorithm -
getEncryptionAlgorithm
URI getEncryptionAlgorithm()get EncryptionAlgorithm value if set, return default otherwise -
setCanonicalizationAlgorithm
set CanonicalizationAlgorithm -
getCanonicalizationAlgorithm
URI getCanonicalizationAlgorithm()get CanonicalizationAlgorithm value if set, return default otherwise -
setUseKey
Set the desired useKey settings for the requested token -
getUseKey
UseKey getUseKey()Get the desired useKey settings for the token if specified, null otherwise -
setProofEncryption
Set the desired proofEncryption settings for the requested token -
getProofEncryption
ProofEncryption getProofEncryption()Get the desired proofEncryption settings for the token if specified, null otherwise -
setComputedKeyAlgorithm
set ComputedKeyAlgorithm -
getComputedKeyAlgorithm
URI getComputedKeyAlgorithm()get CanonicalizationAlgorithm value if set, return default otherwise -
setEncryption
set Encryption -
getEncryption
Encryption getEncryption()get Encryption value if set, return null otherwise -
setSignWith
Set the Signature Algorithm to be used with the issued token -
getSignWith
URI getSignWith()Get the Signature Algorithm to be used with the token if set, null otherwise -
setEncryptWith
Set the Encryption Algorithm to be used with the issued token -
getEncryptWith
URI getEncryptWith()Get the Encryption Algorithm to be used with the token if set, null otherwise -
setKeyWrapAlgorithm
set KeyWrapAlgorithm -
getKeyWrapAlgorithm
URI getKeyWrapAlgorithm()get KeyWrapAlgorithm value if set, return default otherwise -
setDelegateTo
set the Delegate to which the issued token be delegated -
getDelegateTo
DelegateTo getDelegateTo()get the DelegateTo value if set, null otherwise -
setForwardable
void setForwardable(boolean flag) Set if the requested token be forwardable -
getForwardable
boolean getForwardable()Get the value of the Forwardable flag NOTE: default value of this flag is true -
setDelegatable
void setDelegatable(boolean flag) Set if the requested token be delegatable -
getDelegatable
boolean getDelegatable()Get the value of the Delegatable flag NOTE: default value of this flag is false -
setPolicy
void setPolicy(com.sun.xml.ws.policy.Policy policy) Set the desired policy settings for the requested token -
getPolicy
com.sun.xml.ws.policy.Policy getPolicy()Get the desired policy settings for the token if specified, null otherwise -
setPolicyReference
Set the desired policyReference settings for the requested token -
getPolicyReference
PolicyReference getPolicyReference()Get the desired policyReference settings for the token if specified, null otherwise -
getAllowPostdating
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. This can be removed or modified later depending on the outcome of the issue. -
setAllowPostdating
Set the desired policyReference settings for the requested token
-