File Doc Category Size Date Package
WSTrustElementFactory.java API Doc Example 16634 Tue May 29 16:56:54 BST 2007 com.sun.xml.ws.security.trust

WSTrustElementFactory

java.lang.Object

public abstract class WSTrustElementFactory extends Object

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

The default Implementation classes for all these WS-Trust schema Elements would assume that JAXB Bindings were generated for ws-trust.xsd schema in a particular fixed namespace/package. The default implementation classes for all these WS-Trust Element Interfaces would hence wrap the schema generated classes.

An STS Service can create a RequestSecurityToken from the JAXBBean(i.e RequestSecurityTokenType) it receives, as an SEI method parameter, in the following manner

RequestSecurityTokenType tok=...//obtained as JAXWS SEI method paramater
ObjectFactory factory = new ObjectFactory();
JAXBElement<RequestSecurityTokenType> rst= factory.createRequestSecurityToken(tok);
WSTrustElementFactory fact= ..
RequestSecurityToken requestSecurityToken= fact.createRSTFrom(rst);

To get back a JAXB Bean from an instance of RequestSecurityToken the following can be done

JAXBElement<RequestSecurityTokenType> elem = fact.toJAXBElement(requestSecurityToken);
RequestSecurityTokenType tok = elem.getValue();

author: Kumar Jayanti

Fields Summary
private static JAXBContext
jaxbContext
private static WSTrustElementFactory
trustElemFactory
Constructors Summary
Methods Summary
public abstract com.sun.xml.ws.security.trust.elements.BinarySecret createBinarySecret(org.w3c.dom.Element elem)
Create a BinarySecret
public abstract com.sun.xml.ws.security.trust.elements.BinarySecret createBinarySecret(byte[] rawValue, java.lang.String type)
Create a BinarySecret
public abstract com.sun.xml.ws.security.trust.elements.CancelTarget createCancelTarget(com.sun.xml.ws.security.trust.elements.str.SecurityTokenReference str)
public abstract com.sun.xml.ws.security.trust.elements.str.DirectReference createDirectReference(java.lang.String valueType, java.lang.String uri)
public abstract com.sun.xml.ws.security.trust.elements.Entropy createEntropy(com.sun.xml.ws.security.trust.elements.BinarySecret secret)
Create an Entropy with a BinarySecret
public abstract com.sun.xml.ws.security.trust.elements.Entropy createEntropy(com.sun.xml.ws.security.EncryptedKey key)
Create an Entropy with an xenc:EncryptedKey
public abstract com.sun.xml.ws.security.trust.elements.IssuedTokens createIssuedTokens(com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponseCollection issuedTokens)
Create a wst:IssuedTokens object
public abstract com.sun.xml.ws.security.trust.elements.str.KeyIdentifier createKeyIdentifier(java.lang.String valueType, java.lang.String encodingType)
public abstract com.sun.xml.ws.security.trust.elements.Lifetime createLifetime(com.sun.xml.ws.security.wsu10.AttributedDateTime created, com.sun.xml.ws.security.wsu10.AttributedDateTime expires)
Create a Lifetime.
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityToken createRST()
Create an Empty RST
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityToken createRSTForCancel(java.net.URI requestType, com.sun.xml.ws.security.trust.elements.CancelTarget target)
Create an RST for Token Cancellation
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityToken createRSTForIssue(java.net.URI tokenType, java.net.URI requestType, java.net.URI context, com.sun.xml.ws.policy.impl.bindings.AppliesTo scopes, com.sun.xml.ws.api.security.trust.Claims claims, com.sun.xml.ws.security.trust.elements.Entropy entropy, com.sun.xml.ws.security.trust.elements.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
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityToken createRSTForRenew(java.net.URI tokenType, java.net.URI requestType, java.net.URI context, com.sun.xml.ws.security.trust.elements.RenewTarget target, com.sun.xml.ws.security.trust.elements.AllowPostdating apd, com.sun.xml.ws.security.trust.elements.Renewing renewingInfo)
Create an RST for a Renewal Request
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityToken createRSTForValidate(java.net.URI tokenType, java.net.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.
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityToken createRSTFrom(javax.xml.transform.Source src)
create an RST from a Source
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityToken createRSTFrom(org.w3c.dom.Element elem)
create an RST from DOM Element
public abstract com.sun.xml.ws.security.trust.elements.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.
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse createRSTR()
Create an Empty RSTR
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponseCollection createRSTRCollectionForIssue(java.net.URI tokenType, java.net.URI context, com.sun.xml.ws.security.trust.elements.RequestedSecurityToken token, com.sun.xml.ws.policy.impl.bindings.AppliesTo scopes, com.sun.xml.ws.security.trust.elements.RequestedAttachedReference attachedRef, com.sun.xml.ws.security.trust.elements.RequestedUnattachedReference unattachedRef, com.sun.xml.ws.security.trust.elements.RequestedProofToken proofToken, com.sun.xml.ws.security.trust.elements.Entropy entropy, com.sun.xml.ws.security.trust.elements.Lifetime lifetime)
Create a collection of RequestSecurityTokenResponse(s)
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponseCollection createRSTRCollectionFrom(javax.xml.transform.Source src)
Create RSTR Collection from Source
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponseCollection createRSTRCollectionFrom(org.w3c.dom.Element elem)
Create RSTR Collection from Element
public abstract com.sun.xml.ws.security.trust.elements.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.
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse createRSTRForCancel()
Create an RSTR for a Successful Token Cancellation
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse createRSTRForIssue(java.net.URI tokenType, java.net.URI context, com.sun.xml.ws.security.trust.elements.RequestedSecurityToken token, com.sun.xml.ws.policy.impl.bindings.AppliesTo scopes, com.sun.xml.ws.security.trust.elements.RequestedAttachedReference attachedRef, com.sun.xml.ws.security.trust.elements.RequestedUnattachedReference unattachedRef, com.sun.xml.ws.security.trust.elements.RequestedProofToken proofToken, com.sun.xml.ws.security.trust.elements.Entropy entropy, com.sun.xml.ws.security.trust.elements.Lifetime lifetime)
create an RSTR for Issue from the given arguments Any of the arguments can be null since they are all optional, but one of RequestedSecurityToken or RequestedProofToken should be returned
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse createRSTRForValidate(java.net.URI tokenType, com.sun.xml.ws.security.trust.elements.RequestedSecurityToken token, com.sun.xml.ws.security.trust.elements.Status status)
create an RSTR for validate request.
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse createRSTRFrom(javax.xml.transform.Source src)
create an RSTR from a Source
public abstract com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse createRSTRFrom(org.w3c.dom.Element elem)
create an RSTR from DOM Element
public abstract com.sun.xml.ws.security.trust.elements.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.
public abstract com.sun.xml.ws.security.trust.elements.RequestedAttachedReference createRequestedAttachedReference(com.sun.xml.ws.security.trust.elements.str.SecurityTokenReference str)
Create a RequestedAttachedReference.
public abstract com.sun.xml.ws.security.trust.elements.RequestedProofToken createRequestedProofToken()
Create a RequestedProofToken.
public abstract com.sun.xml.ws.security.trust.elements.RequestedSecurityToken createRequestedSecurityToken(com.sun.xml.ws.security.Token token)
Create a RequestedSecurityToken.
public abstract com.sun.xml.ws.security.trust.elements.RequestedSecurityToken createRequestedSecurityToken()
public abstract com.sun.xml.ws.security.trust.elements.RequestedUnattachedReference createRequestedUnattachedReference(com.sun.xml.ws.security.trust.elements.str.SecurityTokenReference str)
Create a RequestedUnattachedReference.
public abstract com.sun.xml.ws.security.trust.elements.str.SecurityTokenReference createSecurityTokenReference(com.sun.xml.ws.security.trust.elements.str.Reference ref)
public abstract com.sun.xml.ws.security.trust.elements.str.SecurityTokenReference createSecurityTokenReference(javax.xml.bind.JAXBElement elem)
public static javax.xml.bind.JAXBContext getContext()
return jaxbContext;
public static com.sun.xml.ws.security.trust.WSTrustElementFactory newInstance()
return trustElemFactory;
public abstract org.w3c.dom.Element toElement(com.sun.xml.ws.security.trust.elements.RequestSecurityToken rst)
Marshal an RST to a DOM Element.
Note: Useful for Dispatch Client implementations
public abstract org.w3c.dom.Element toElement(com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse rstr)
Marshal an RSTR to DOM Element
Note: Useful for STS implementations which are JAXWS Providers
public abstract org.w3c.dom.Element toElement(com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse rstr, org.w3c.dom.Document doc)
public abstract org.w3c.dom.Element toElement(com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponseCollection rstrCollection)
Marshal an RSTR Collection to a DOM Element
Note: Useful for STS implementations which are JAXWS Providers
public abstract org.w3c.dom.Element toElement(com.sun.xml.ws.security.trust.elements.BinarySecret binarySecret)
Marshal an BinarySecret to a DOM Element
Note: Useful for STS implementations which are JAXWS Providers
public abstract org.w3c.dom.Element toElement(com.sun.xml.ws.security.trust.elements.str.SecurityTokenReference str, org.w3c.dom.Document doc)
Marshal an STR to a DOM Element.
Note: Useful for Dispatch Client implementations
public abstract org.w3c.dom.Element toElement(com.sun.xml.ws.security.trust.elements.BinarySecret binarySecret, org.w3c.dom.Document doc)
Marshal an BinarySecret to a DOM Element.
Note: Useful for Dispatch Client implementations
public abstract javax.xml.bind.JAXBElement toJAXBElement(com.sun.xml.ws.security.trust.elements.str.SecurityTokenReference str)
convert an SecurityTokenReference to a JAXBElement
public abstract javax.xml.bind.JAXBElement toJAXBElement(com.sun.xml.ws.security.trust.elements.RequestSecurityToken rst)
convert an RST to a JAXBElement
public abstract javax.xml.bind.JAXBElement toJAXBElement(com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse rstr)
convert an RSTR to a JAXBElement
public abstract javax.xml.bind.JAXBElement toJAXBElement(com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponseCollection rstrCollection)
convert an RSTR Collection to a JAXBElement
public abstract javax.xml.transform.Source toSource(com.sun.xml.ws.security.trust.elements.RequestSecurityToken rst)
Marshal an RST to a Source.
Note: Useful for Dispatch Client implementations
public abstract javax.xml.transform.Source toSource(com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse rstr)
Marshal an RSTR to a Source
Note: Useful for STS implementations which are JAXWS Providers
public abstract javax.xml.transform.Source toSource(com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponseCollection rstrCollection)
Marshal an RSTR Collection to a Source
Note: Useful for STS implementations which are JAXWS Providers