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

Class WSTrustElementFactoryImpl

java.lang.Object

com.sun.xml.ws.security.trust.WSTrustElementFactory

com.sun.xml.ws.security.trust.impl.WSTrustElementFactoryImpl

Direct Known Subclasses:

WSSCElementFactory

public class WSTrustElementFactoryImpl
extends WSTrustElementFactory

A Factory for creating the WS-Trust schema elements, and marshalling/un-marshalling them.

Author:

Manveen Kaur

Constructor Summary

Constructors

Constructor	Description
WSTrustElementFactoryImpl()

Method Summary

Modifier and Type	Method	Description
ActAs	createActAs(Token token)
BinarySecret	createBinarySecret(byte[] rawValue, String type)	Create a BinarySecret
BinarySecret	createBinarySecret(Element elem)	Create a BinarySecret
CancelTarget	createCancelTarget(SecurityTokenReference str)
Claims	createClaims()
Claims	createClaims(Claims claims)
Claims	createClaims(Element elem)
DirectReference	createDirectReference(String valueType, String uri)
DirectReference	createDirectReference(String valueType, String uri, String instanceId)
Entropy	createEntropy(EncryptedKey key)	Create an Entropy with an xenc:EncryptedKey
Entropy	createEntropy(BinarySecret secret)	Create an Entropy with a BinarySecret
IssuedTokens	createIssuedTokens(RequestSecurityTokenResponseCollection issuedTokens)	Create a wst:IssuedTokens object
KeyIdentifier	createKeyIdentifier(String valueType, String encodingType)
Lifetime	createLifetime(AttributedDateTime created, AttributedDateTime expires)	Create a Lifetime.
OnBehalfOf	createOnBehalfOf(Token oboToken)
RenewTarget	createRenewTarget(SecurityTokenReference str)
RequestedAttachedReference	createRequestedAttachedReference(SecurityTokenReference str)	Create a RequestedAttachedReference.
RequestedProofToken	createRequestedProofToken()	Create a RequestedProofToken.
RequestedSecurityToken	createRequestedSecurityToken()	Create a RequestedSecurityToken.
RequestedSecurityToken	createRequestedSecurityToken(Token token)	Create a RequestedSecurityToken.
RequestedUnattachedReference	createRequestedUnattachedReference(SecurityTokenReference str)	Create a RequestedUnattachedReference.
RequestSecurityToken	createRST()	Create an Empty RST
RequestSecurityToken	createRSTForCancel(URI requestType, CancelTarget target)	Create an RST for Token Cancellation
RequestSecurityToken	createRSTForIssue(URI tokenType, URI requestType, URI context, AppliesTo scopes, Claims claims, Entropy entropy, Lifetime lifetime)	Create an RST for Issue from the given arguments Any of the arguments can be null since they are all optional, but one of tokenType and AppliesTo must be present
RequestSecurityToken	createRSTForRenew(URI tokenType, URI requestType, URI context, RenewTarget target, AllowPostdating apd, Renewing renewingInfo)	Create an RST for a Renewal Request
RequestSecurityToken	createRSTForValidate(URI tokenType, URI requestType)	Create an RST for Token Validation
RequestSecurityToken	createRSTFrom(javax.xml.bind.JAXBElement elem)	create an RST from JAXBElement
RequestSecurityToken	createRSTFrom(Source src)	create an RST from a Source
RequestSecurityToken	createRSTFrom(Element elem)	create an RST from DOM Element
RequestSecurityTokenResponse	createRSTR()	Create an Empty RSTR
RequestSecurityTokenResponseCollection	createRSTRC(List<RequestSecurityTokenResponse> rstrs)
RequestSecurityTokenResponseCollection	createRSTRCollectionForIssue(URI tokenType, URI context, RequestedSecurityToken token, AppliesTo scopes, RequestedAttachedReference attached, RequestedUnattachedReference unattached, RequestedProofToken proofToken, Entropy entropy, Lifetime lifetime)	Create a collection of RequestSecurityTokenResponse(s)
RequestSecurityTokenResponseCollection	createRSTRCollectionFrom(javax.xml.bind.JAXBElement elem)	create an RSTR Collection from JAXBElement
RequestSecurityTokenResponseCollection	createRSTRCollectionFrom(Source src)	Create RSTR Collection from Source
RequestSecurityTokenResponseCollection	createRSTRCollectionFrom(Element elem)	Create RSTR Collection from Element
RequestSecurityTokenResponse	createRSTRForCancel()	Create an RSTR for a Successful Token Cancellation
RequestSecurityTokenResponse	createRSTRForIssue(URI tokenType, URI context, RequestedSecurityToken token, AppliesTo scopes, RequestedAttachedReference attachedReference, RequestedUnattachedReference unattachedRef, RequestedProofToken proofToken, Entropy entropy, Lifetime lifetime)	Create an RSTR for Issue from the given arguments.
RequestSecurityTokenResponse	createRSTRForRenew(URI tokenType, URI context, RequestedSecurityToken token, RequestedAttachedReference attachedReference, RequestedUnattachedReference unattachedRef, RequestedProofToken proofToken, Entropy entropy, Lifetime lifetime)	Create an RSTR for Renew from the given arguments.
RequestSecurityTokenResponse	createRSTRForValidate(URI tokenType, RequestedSecurityToken token, Status status)	create an RSTR for validate request.
RequestSecurityTokenResponse	createRSTRFrom(javax.xml.bind.JAXBElement elem)	create an RSTR from JAXBElement
RequestSecurityTokenResponse	createRSTRFrom(Source src)	create an RSTR from a Source
RequestSecurityTokenResponse	createRSTRFrom(Element elem)	create an RSTR from DOM Element
SecondaryParameters	createSecondaryParameters()	Create SecondaryParameters
SecurityContextToken	createSecurityContextToken(URI identifier, String instance, String wsuId)
SecurityTokenReference	createSecurityTokenReference(Reference ref)
SecurityTokenReference	createSecurityTokenReference(javax.xml.bind.JAXBElement elem)
Status	createStatus(String code, String reason)
UseKey	createUseKey(Token token, String sig)
ValidateTarget	createValidateTarget(Token token)
javax.xml.bind.Marshaller	getMarshaller()
Element	toElement(BaseSTSRequest request)
Element	toElement(BaseSTSResponse response)
Element	toElement(BinarySecret secret)	Marshal an BinarySecret to a DOM Element
Element	toElement(BinarySecret secret, Document doc)	Marshal an BinarySecret to a DOM Element.
Element	toElement(RequestSecurityToken rst)	Marshal an RST to a DOM Element.
Element	toElement(RequestSecurityTokenResponse rstr)	Marshal an RSTR to DOM Element
Element	toElement(RequestSecurityTokenResponseCollection rstrCollection)	Marshal an RSTR Collection to a DOM Element
Element	toElement(RequestSecurityTokenResponse rstr, Document doc)
Element	toElement(SecurityTokenReference str, Document doc)	Marshal an STR to a DOM Element.
javax.xml.bind.JAXBElement	toJAXBElement(BaseSTSRequest request)
javax.xml.bind.JAXBElement	toJAXBElement(BaseSTSResponse response)
javax.xml.bind.JAXBElement	toJAXBElement(Entropy entropy)	convert a Entropy to a JAXBElement
javax.xml.bind.JAXBElement	toJAXBElement(RequestSecurityToken rst)	convert an RST to a JAXBElement
javax.xml.bind.JAXBElement	toJAXBElement(RequestSecurityTokenResponse rstr)	convert an RSTR to a JAXBElement
javax.xml.bind.JAXBElement	toJAXBElement(RequestSecurityTokenResponseCollection rstrCollection)	convert an RSTR Collection to a JAXBElement
javax.xml.bind.JAXBElement	toJAXBElement(SecurityTokenReference str)	convert an SecurityTokenReference to a JAXBElement
Source	toSource(BaseSTSRequest request)
Source	toSource(BaseSTSResponse response)
Source	toSource(RequestSecurityToken rst)	Marshal an RST to a Source.
Source	toSource(RequestSecurityTokenResponse rstr)	Marshal an RSTR to a Source
Source	toSource(RequestSecurityTokenResponseCollection rstrCollection)	Marshal an RSTR Collection to a Source

Methods inherited from class com.sun.xml.ws.security.trust.WSTrustElementFactory

getContext, getContext, newInstance, newInstance, newInstance, newInstance, toElement

Methods inherited from class java.lang.Object

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

Constructor Detail

WSTrustElementFactoryImpl

public WSTrustElementFactoryImpl()

Method Detail

createRSTForIssue

public RequestSecurityToken createRSTForIssue(URI tokenType,
                                              URI requestType,
                                              URI context,
                                              AppliesTo scopes,
                                              Claims claims,
                                              Entropy entropy,
                                              Lifetime lifetime)
                                       throws WSTrustException

Create an RST for Issue from the given arguments Any of the arguments can be null since they are all optional, but one of tokenType and AppliesTo must be present

Specified by:

createRSTForIssue in class WSTrustElementFactory

Throws:

WSTrustException

createRSTRForIssue

public RequestSecurityTokenResponse createRSTRForIssue(URI tokenType,
                                                       URI context,
                                                       RequestedSecurityToken token,
                                                       AppliesTo scopes,
                                                       RequestedAttachedReference attachedReference,
                                                       RequestedUnattachedReference unattachedRef,
                                                       RequestedProofToken proofToken,
                                                       Entropy entropy,
                                                       Lifetime lifetime)
                                                throws WSTrustException

Create an RSTR for Issue from the given arguments. TokenType should be Issue. Any of the arguments can be null since they are all optional, but one of RequestedSecurityToken or RequestedProofToken should be returned

Specified by:

createRSTRForIssue in class WSTrustElementFactory

Throws:

WSTrustException

createRSTRCollectionForIssue

public RequestSecurityTokenResponseCollection createRSTRCollectionForIssue(URI tokenType,
                                                                           URI context,
                                                                           RequestedSecurityToken token,
                                                                           AppliesTo scopes,
                                                                           RequestedAttachedReference attached,
                                                                           RequestedUnattachedReference unattached,
                                                                           RequestedProofToken proofToken,
                                                                           Entropy entropy,
                                                                           Lifetime lifetime)
                                                                    throws WSTrustException

Create a collection of RequestSecurityTokenResponse(s)

Specified by:

createRSTRCollectionForIssue in class WSTrustElementFactory

Throws:

WSTrustException

createRSTRForRenew

public RequestSecurityTokenResponse createRSTRForRenew(URI tokenType,
                                                       URI context,
                                                       RequestedSecurityToken token,
                                                       RequestedAttachedReference attachedReference,
                                                       RequestedUnattachedReference unattachedRef,
                                                       RequestedProofToken proofToken,
                                                       Entropy entropy,
                                                       Lifetime lifetime)
                                                throws WSTrustException

Create an RSTR for Renew from the given arguments. TokenType should be Issue. Any of the arguments can be null since they are all optional, but one of RequestedSecurityToken or RequestedProofToken should be returned

Specified by:

createRSTRForRenew in class WSTrustElementFactory

Throws:

WSTrustException

createIssuedTokens

public IssuedTokens createIssuedTokens(RequestSecurityTokenResponseCollection issuedTokens)

Create a wst:IssuedTokens object

Specified by:

createIssuedTokens in class WSTrustElementFactory

createOnBehalfOf

public OnBehalfOf createOnBehalfOf(Token oboToken)

Specified by:

createOnBehalfOf in class WSTrustElementFactory

createValidateTarget

public ValidateTarget createValidateTarget(Token token)

Specified by:

createValidateTarget in class WSTrustElementFactory

createActAs

public ActAs createActAs(Token token)

Specified by:

createActAs in class WSTrustElementFactory

createEntropy

public Entropy createEntropy(BinarySecret secret)

Create an Entropy with a BinarySecret

Specified by:

createEntropy in class WSTrustElementFactory

createEntropy

public Entropy createEntropy(EncryptedKey key)

Create an Entropy with an xenc:EncryptedKey

Specified by:

createEntropy in class WSTrustElementFactory

createBinarySecret

public BinarySecret createBinarySecret(byte[] rawValue,
                                       String type)

Description copied from class: WSTrustElementFactory

Create a BinarySecret

Specified by:

createBinarySecret in class WSTrustElementFactory

createBinarySecret

public BinarySecret createBinarySecret(Element elem)
                                throws WSTrustException

Description copied from class: WSTrustElementFactory

Create a BinarySecret

Specified by:

createBinarySecret in class WSTrustElementFactory

Throws:

WSTrustException

createLifetime

public Lifetime createLifetime(AttributedDateTime created,
                               AttributedDateTime expires)

Create a Lifetime.

Specified by:

createLifetime in class WSTrustElementFactory

createClaims

public Claims createClaims(Element elem)
                    throws WSTrustException

Specified by:

createClaims in class WSTrustElementFactory

Throws:

WSTrustException

createClaims

public Claims createClaims(Claims claims)
                    throws WSTrustException

Specified by:

createClaims in class WSTrustElementFactory

Throws:

WSTrustException

createClaims

public Claims createClaims()
                    throws WSTrustException

Specified by:

createClaims in class WSTrustElementFactory

Throws:

WSTrustException

createStatus

public Status createStatus(String code,
                           String reason)

Specified by:

createStatus in class WSTrustElementFactory

createRequestedSecurityToken

public RequestedSecurityToken createRequestedSecurityToken(Token token)

Create a RequestedSecurityToken.

Specified by:

createRequestedSecurityToken in class WSTrustElementFactory

createRequestedSecurityToken

public RequestedSecurityToken createRequestedSecurityToken()

Create a RequestedSecurityToken.

Specified by:

createRequestedSecurityToken in class WSTrustElementFactory

createDirectReference

public DirectReference createDirectReference(String valueType,
                                             String uri)

Specified by:

createDirectReference in class WSTrustElementFactory

createDirectReference

public DirectReference createDirectReference(String valueType,
                                             String uri,
                                             String instanceId)

createKeyIdentifier

public KeyIdentifier createKeyIdentifier(String valueType,
                                         String encodingType)

Specified by:

createKeyIdentifier in class WSTrustElementFactory

createSecurityTokenReference

public SecurityTokenReference createSecurityTokenReference(Reference ref)

Specified by:

createSecurityTokenReference in class WSTrustElementFactory

createRequestedAttachedReference

public RequestedAttachedReference createRequestedAttachedReference(SecurityTokenReference str)

Create a RequestedAttachedReference.

Specified by:

createRequestedAttachedReference in class WSTrustElementFactory

createRequestedUnattachedReference

public RequestedUnattachedReference createRequestedUnattachedReference(SecurityTokenReference str)

Create a RequestedUnattachedReference.

Specified by:

createRequestedUnattachedReference in class WSTrustElementFactory

createRequestedProofToken

public RequestedProofToken createRequestedProofToken()

Create a RequestedProofToken.

Specified by:

createRequestedProofToken in class WSTrustElementFactory

createSecondaryParameters

public SecondaryParameters createSecondaryParameters()

Create SecondaryParameters

Specified by:

createSecondaryParameters in class WSTrustElementFactory

createUseKey

public UseKey createUseKey(Token token,
                           String sig)

Specified by:

createUseKey in class WSTrustElementFactory

createRSTForRenew

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

Create an RST for a Renewal Request

Specified by:

createRSTForRenew in class WSTrustElementFactory

createRenewTarget

public RenewTarget createRenewTarget(SecurityTokenReference str)

Specified by:

createRenewTarget in class WSTrustElementFactory

createCancelTarget

public CancelTarget createCancelTarget(SecurityTokenReference str)

Specified by:

createCancelTarget in class WSTrustElementFactory

createRSTForCancel

public RequestSecurityToken createRSTForCancel(URI requestType,
                                               CancelTarget target)

Create an RST for Token Cancellation

Specified by:

createRSTForCancel in class WSTrustElementFactory

createRSTRForCancel

public RequestSecurityTokenResponse createRSTRForCancel()

Create an RSTR for a Successful Token Cancellation

Specified by:

createRSTRForCancel in class WSTrustElementFactory

createRSTForValidate

public RequestSecurityToken createRSTForValidate(URI tokenType,
                                                 URI requestType)

Create an RST for Token Validation

TODO: Not clear from Spec whether the Token to be validated is ever sent ? TODO: There is a mention of special case where a SOAPEnvelope may be specified as a security token if the requestor desires the envelope to be validated.

Specified by:

createRSTForValidate in class WSTrustElementFactory

createRSTRForValidate

public RequestSecurityTokenResponse createRSTRForValidate(URI tokenType,
                                                          RequestedSecurityToken token,
                                                          Status status)

create an RSTR for validate request.

Specified by:

createRSTRForValidate in class WSTrustElementFactory

createRST

public RequestSecurityToken createRST()

Create an Empty RST

Specified by:

createRST in class WSTrustElementFactory

createRSTR

public RequestSecurityTokenResponse createRSTR()

Create an Empty RSTR

Specified by:

createRSTR in class WSTrustElementFactory

createRSTRC

public RequestSecurityTokenResponseCollection createRSTRC(List<RequestSecurityTokenResponse> rstrs)

Specified by:

createRSTRC in class WSTrustElementFactory

createRSTFrom

public RequestSecurityToken createRSTFrom(Source src)

create an RST from a Source

Specified by:

createRSTFrom in class WSTrustElementFactory

createRSTFrom

public RequestSecurityToken createRSTFrom(Element elem)

create an RST from DOM Element

Specified by:

createRSTFrom in class WSTrustElementFactory

createRSTRFrom

public RequestSecurityTokenResponse createRSTRFrom(Source src)

create an RSTR from a Source

Specified by:

createRSTRFrom in class WSTrustElementFactory

createRSTRFrom

public RequestSecurityTokenResponse createRSTRFrom(Element elem)

create an RSTR from DOM Element

Specified by:

createRSTRFrom in class WSTrustElementFactory

createRSTRCollectionFrom

public RequestSecurityTokenResponseCollection createRSTRCollectionFrom(Source src)

Create RSTR Collection from Source

Specified by:

createRSTRCollectionFrom in class WSTrustElementFactory

createRSTRCollectionFrom

public RequestSecurityTokenResponseCollection createRSTRCollectionFrom(Element elem)

Create RSTR Collection from Element

Specified by:

createRSTRCollectionFrom in class WSTrustElementFactory

createRSTFrom

public RequestSecurityToken createRSTFrom(javax.xml.bind.JAXBElement elem)

create an RST from JAXBElement

NOTE: an STS Implementor can call

 JAXBElement<RequestSecurityTokenType> elem=
 ObjectFactory.createRequestSecurityToken(<JAXBBean for RST>)
 

The JAXBBean for RST is the one generated from the ws-trust.xsd schema The default implementation expects the packagename of the generated JAXB Beans to be fixed.

Specified by:

createRSTFrom in class WSTrustElementFactory

createRSTRFrom

public RequestSecurityTokenResponse createRSTRFrom(javax.xml.bind.JAXBElement elem)

create an RSTR from JAXBElement

NOTE: an STS Implementor can call

 JAXBElement<RequestSecurityTokenResponseType> elem=
 ObjectFactory.createRequestSecurityTokenResponse(<JAXBBean for RSTR>);
 

The <JAXBBean for RSTR> is the one generated from the ws-trust.xsd schema The default implementation expects the packagename of the generated JAXB Beans to be fixed.

Specified by:

createRSTRFrom in class WSTrustElementFactory

createRSTRCollectionFrom

public RequestSecurityTokenResponseCollection createRSTRCollectionFrom(javax.xml.bind.JAXBElement elem)

create an RSTR Collection from JAXBElement

NOTE: an STS Implementor can call

 JAXBElement<RequestSecurityTokenResponseCollectionType> elem=
 ObjectFactory.createRequestSecurityTokenResponseCollection(<JAXBBean for RSTR Collection>
 

The <JAXBBean for RSTR Collection> is the one generated from the ws-trust.xsd schema The default implementation expects the packagename of the generated JAXB Beans to be fixed.

Specified by:

createRSTRCollectionFrom in class WSTrustElementFactory

createSecurityTokenReference

public SecurityTokenReference createSecurityTokenReference(javax.xml.bind.JAXBElement elem)

Specified by:

createSecurityTokenReference in class WSTrustElementFactory

createSecurityContextToken

public SecurityContextToken createSecurityContextToken(URI identifier,
                                                       String instance,
                                                       String wsuId)

Specified by:

createSecurityContextToken in class WSTrustElementFactory

toJAXBElement

public javax.xml.bind.JAXBElement toJAXBElement(BaseSTSRequest request)

Specified by:

toJAXBElement in class WSTrustElementFactory

toJAXBElement

public javax.xml.bind.JAXBElement toJAXBElement(BaseSTSResponse response)

Specified by:

toJAXBElement in class WSTrustElementFactory

toJAXBElement

public javax.xml.bind.JAXBElement toJAXBElement(SecurityTokenReference str)

convert an SecurityTokenReference to a JAXBElement

Specified by:

toJAXBElement in class WSTrustElementFactory

toJAXBElement

public javax.xml.bind.JAXBElement toJAXBElement(RequestSecurityToken rst)

convert an RST to a JAXBElement

Specified by:

toJAXBElement in class WSTrustElementFactory

toJAXBElement

public javax.xml.bind.JAXBElement toJAXBElement(RequestSecurityTokenResponse rstr)

convert an RSTR to a JAXBElement

Specified by:

toJAXBElement in class WSTrustElementFactory

toJAXBElement

public javax.xml.bind.JAXBElement toJAXBElement(Entropy entropy)

convert a Entropy to a JAXBElement

toJAXBElement

public javax.xml.bind.JAXBElement toJAXBElement(RequestSecurityTokenResponseCollection rstrCollection)

convert an RSTR Collection to a JAXBElement

Specified by:

toJAXBElement in class WSTrustElementFactory

toSource

public Source toSource(BaseSTSRequest request)

Specified by:

toSource in class WSTrustElementFactory

toSource

public Source toSource(BaseSTSResponse response)

Specified by:

toSource in class WSTrustElementFactory

toSource

public Source toSource(RequestSecurityToken rst)

Marshal an RST to a Source.

Note: Useful for Dispatch Client implementations

Specified by:

toSource in class WSTrustElementFactory

toSource

public Source toSource(RequestSecurityTokenResponse rstr)

Marshal an RSTR to a Source

Note: Useful for STS implementations which are JAXWS Providers

Specified by:

toSource in class WSTrustElementFactory

toSource

public Source toSource(RequestSecurityTokenResponseCollection rstrCollection)

Marshal an RSTR Collection to a Source

Note: Useful for STS implementations which are JAXWS Providers

Specified by:

toSource in class WSTrustElementFactory

toElement

public Element toElement(BaseSTSRequest request)

Specified by:

toElement in class WSTrustElementFactory

toElement

public Element toElement(BaseSTSResponse response)

Specified by:

toElement in class WSTrustElementFactory

toElement

public Element toElement(RequestSecurityToken rst)

Marshal an RST to a DOM Element.

Note: Useful for Dispatch Client implementations

Specified by:

toElement in class WSTrustElementFactory

toElement

public Element toElement(RequestSecurityTokenResponse rstr)

Marshal an RSTR to DOM Element

Note: Useful for STS implementations which are JAXWS Providers

Specified by:

toElement in class WSTrustElementFactory

toElement

public Element toElement(RequestSecurityTokenResponse rstr,
                         Document doc)

Specified by:

toElement in class WSTrustElementFactory

toElement

public Element toElement(RequestSecurityTokenResponseCollection rstrCollection)

Marshal an RSTR Collection to a DOM Element

Note: Useful for STS implementations which are JAXWS Providers

Specified by:

toElement in class WSTrustElementFactory

toElement

public Element toElement(BinarySecret secret)

Description copied from class: WSTrustElementFactory

Marshal an BinarySecret to a DOM Element

Note: Useful for STS implementations which are JAXWS Providers

Specified by:

toElement in class WSTrustElementFactory

toElement

public Element toElement(SecurityTokenReference str,
                         Document doc)

Marshal an STR to a DOM Element.

Note: Useful for Dispatch Client implementations

Specified by:

toElement in class WSTrustElementFactory

toElement

public Element toElement(BinarySecret secret,
                         Document doc)

Marshal an BinarySecret to a DOM Element.

Note: Useful for Dispatch Client implementations

Specified by:

toElement in class WSTrustElementFactory

getMarshaller

public javax.xml.bind.Marshaller getMarshaller()

Specified by:

getMarshaller in class WSTrustElementFactory