org.openliberty.wsc

Class WSFMessage

java.lang.Object

org.openliberty.wsc.WSFMessage

public class WSFMessage
extends Object

WSFMessage models a round trip request/response ID-WSF SOAP transaction.

Field Summary

Fields

Modifier and Type	Field and Description
private String	actionString This is the action that the message is intended to perform
protected static org.opensaml.core.xml.XMLObjectBuilderFactory	builderFactory XMLObject builder factory.
private static boolean	debugJustSOAPBody If true, only the SOAP body is printed during a logger debug session
private boolean	endpointUpdated When an EndpointUpdate header is received and processed, this is set to true
private org.opensaml.soap.soap11.Envelope	envelope SOAP Request
protected static Logger	log
protected static org.opensaml.core.xml.io.MarshallerFactory	marshallerFactory XMLObject marshaller factory.
protected static net.shibboleth.utilities.java.support.xml.BasicParserPool	parser Parser manager used to parse XML.
private RedirectRequest	redirectRequest If the SOAP Response contains a Fault with a RedirectRequest element, it is stored here.
private String	response Response String
private org.opensaml.soap.soap11.Envelope	responseEnvelope SOAP Response
private BaseServiceClient	serviceClient This is the Service Client that is invoking a particular WSFMessage.
private List<String>	signatureIds Holds the reference IDs of the elements to be included in any signature
protected static org.opensaml.core.xml.io.UnmarshallerFactory	unmarshallerFactory XMLObject marshaller factory.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	WSFMessage(BaseServiceClient serviceClient)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSOAP11Attributes(org.opensaml.core.xml.AttributeExtensibleXMLObject obj, boolean mustUnderstand)
void	addWSUIdAttribute(org.opensaml.core.xml.AttributeExtensibleXMLObject obj, String id) This method adds an id to an AttributeExtensibleXMLObject and then places that Id in signatureIds for signing
static org.opensaml.soap.soap11.Envelope	buildSOAPEnvelope() This method creates the Basic SOAP Envelope
static WSFMessage	createWSFMessage(BaseServiceClient serviceClient, String actionString) Factory method to create a WSFMessage from an EPR.
static boolean	getDebugJustSOAPBody()
org.opensaml.soap.soap11.Envelope	getRequestEnvelope()
org.opensaml.soap.soap11.Envelope	getResponseEnvelope()
String	getResponseString()
protected BaseServiceClient	getServiceClient()
List<String>	getSignatureIds() Holds the reference ids of the SOAP Body element (the element itself), the security token associated with the signature, and all headers in the message that have been defined in the Liberty SOAP Bindings specification, including both required and optional header blocks.
private void	handleEndpointUpdatedState() After an EndpointUpdate, the original message is invoked again, with a different EPR
private boolean	handleInappropriateCredentials() Handles the InappropriateCredentials Fault.
private void	handleRedirectRequestState() If the WSC resends its request it MUST set the value of the wsa:RelatesTo SOAP Header to the same value of the wsa:MessageID SOAP Header of the SOAP Fault that carried the <RedirectRequest> element.
boolean	hasRedirectRequestBeenIssued() The RedirectRequest element instructs the WSC to redirect the user to the WSP.
boolean	hasUpdatedEndpointReference() This boolean indicates that there is an updated endpoint reference that needs to be processed by the service client.
private void	initializeRequestEnvelope() The WSFMessage class contains a global Envelope that is used for making a request, this method initializes the global request envelope including adding the security token from the message EPR
void	invoke() Invoke the WSFMessage sending the SOAP requestEvelope and placing the response in the responseEnvelope.
static String	prettyPrintRequestMessage(WSFMessage message) Prints a nice looking output of the request message
static String	prettyPrintResponseMessage(WSFMessage message) Prints a nice looking output of the response message
private boolean	processEndpointUpdated() This method handles the creation of a new EndpointReference from an EndpointUpdate element.
private void	processResponse(String responseString) This method will take care of all of the responsibilities required of a WSC when receiving a response from a WSP.
static void	setDebugJustSOAPBody(boolean _debugJustSOAPBody)
void	setHeaderProcessingContext(ProcessingContext processingContext) Adds this ProcessingContext to the header or replaces an existing ProcessingContext with this one
void	setRequestEnvelope(org.opensaml.soap.soap11.Envelope envelope)
void	setResponseEnvelope(org.opensaml.soap.soap11.Envelope envelope)
protected void	setServiceClient(BaseServiceClient serviceClient)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static Logger log

parser

protected static net.shibboleth.utilities.java.support.xml.BasicParserPool parser

Parser manager used to parse XML.

marshallerFactory

protected static org.opensaml.core.xml.io.MarshallerFactory marshallerFactory

XMLObject marshaller factory.

unmarshallerFactory

protected static org.opensaml.core.xml.io.UnmarshallerFactory unmarshallerFactory

XMLObject marshaller factory.

builderFactory

protected static org.opensaml.core.xml.XMLObjectBuilderFactory builderFactory

XMLObject builder factory.

serviceClient

private BaseServiceClient serviceClient

This is the Service Client that is invoking a particular WSFMessage. It is referenced here so that we can do EPR updates.

envelope

private org.opensaml.soap.soap11.Envelope envelope

SOAP Request

response

private String response

Response String

responseEnvelope

private org.opensaml.soap.soap11.Envelope responseEnvelope

SOAP Response

actionString

private String actionString

This is the action that the message is intended to perform

signatureIds

private List<String> signatureIds

Holds the reference IDs of the elements to be included in any signature

redirectRequest

private RedirectRequest redirectRequest

If the SOAP Response contains a Fault with a RedirectRequest element, it is stored here.

endpointUpdated

private boolean endpointUpdated

When an EndpointUpdate header is received and processed, this is set to true

debugJustSOAPBody

private static boolean debugJustSOAPBody

If true, only the SOAP body is printed during a logger debug session

Constructor Detail

WSFMessage

private WSFMessage(BaseServiceClient serviceClient)

Method Detail

addWSUIdAttribute

public void addWSUIdAttribute(org.opensaml.core.xml.AttributeExtensibleXMLObject obj,
                     String id)

This method adds an id to an AttributeExtensibleXMLObject and then places that Id in signatureIds for signing

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd

  <xsd:attribute name="Id" type="xsd:ID">
      <xsd:annotation>
          <xsd:documentation>
              This global attribute supports annotating arbitrary elements with an ID.
           </xsd:documentation>
      </xsd:annotation>
  </xsd:attribute>
  

addSOAP11Attributes

public void addSOAP11Attributes(org.opensaml.core.xml.AttributeExtensibleXMLObject obj,
                       boolean mustUnderstand)

createWSFMessage

public static WSFMessage createWSFMessage(BaseServiceClient serviceClient,
                          String actionString)
                                   throws net.shibboleth.utilities.java.support.xml.XMLParserException,
                                          org.opensaml.core.xml.io.UnmarshallingException

Factory method to create a WSFMessage from an EPR.

Returns:

Throws:

org.opensaml.core.xml.io.UnmarshallingException

net.shibboleth.utilities.java.support.xml.XMLParserException

setDebugJustSOAPBody

public static void setDebugJustSOAPBody(boolean _debugJustSOAPBody)

getDebugJustSOAPBody

public static boolean getDebugJustSOAPBody()

initializeRequestEnvelope

private void initializeRequestEnvelope()
                                throws net.shibboleth.utilities.java.support.xml.XMLParserException,
                                       org.opensaml.core.xml.io.UnmarshallingException

The WSFMessage class contains a global Envelope that is used for making a request, this method initializes the global request envelope including adding the security token from the message EPR

Throws:

net.shibboleth.utilities.java.support.xml.XMLParserException

org.opensaml.core.xml.io.UnmarshallingException

getSignatureIds

public List<String> getSignatureIds()

Holds the reference ids of the SOAP Body element (the element itself), the security token associated with the signature, and all headers in the message that have been defined in the Liberty SOAP Bindings specification, including both required and optional header blocks.

Returns:

getServiceClient

protected BaseServiceClient getServiceClient()

setServiceClient

protected void setServiceClient(BaseServiceClient serviceClient)

setHeaderProcessingContext

public void setHeaderProcessingContext(ProcessingContext processingContext)

Adds this ProcessingContext to the header or replaces an existing ProcessingContext with this one

Parameters:

processingContext -

invoke

public void invoke()
            throws IOException,
                   org.opensaml.core.xml.io.MarshallingException,
                   net.shibboleth.utilities.java.support.xml.XMLParserException,
                   org.opensaml.core.xml.io.UnmarshallingException,
                   WSCException,
                   GeneralSecurityException

Invoke the WSFMessage sending the SOAP requestEvelope and placing the response in the responseEnvelope. Signing is done based on the message level setting of "signed"

Throws:

IOException

org.opensaml.core.xml.io.MarshallingException

net.shibboleth.utilities.java.support.xml.XMLParserException

org.opensaml.core.xml.io.UnmarshallingException

WSCException

GeneralSecurityException

processResponse

private void processResponse(String responseString)
                      throws net.shibboleth.utilities.java.support.xml.XMLParserException,
                             org.opensaml.core.xml.io.UnmarshallingException,
                             WSCException,
                             IOException,
                             org.opensaml.core.xml.io.MarshallingException,
                             GeneralSecurityException

This method will take care of all of the responsibilities required of a WSC when receiving a response from a WSP.

e.g. Fault:

         <se:Fault xmlns:sb-ext="urn:liberty:sb:2004-04">
             <faultcode>se:Client</faultcode>
             <faultstring>soap fault</faultstring>
              <detail namespace="urn:liberty:sb:2003-08">
                <lu:Status xmlns:lu="urn:liberty:util:2006-08" code="IDStarMsgNotUnderstood"/>
             </detail>
          </se:Fault>
 

Parameters:

responseString -

Throws:

net.shibboleth.utilities.java.support.xml.XMLParserException

org.opensaml.core.xml.io.UnmarshallingException

WSCException

org.opensaml.core.xml.io.MarshallingException

IOException

GeneralSecurityException

handleInappropriateCredentials

private boolean handleInappropriateCredentials()

Handles the InappropriateCredentials Fault.

In the case of a Fault with a Status code "InappropriateCredentials" this method examines the CredentialsContext header and attempts to renegotiate with the DS for a more appropriate SecurityMechanism or reauthenticate with the AS in the case of a RequestedAuthnContext element being present in the CredentialsContext header.

Returns:

processEndpointUpdated

private boolean processEndpointUpdated()

This method handles the creation of a new EndpointReference from an EndpointUpdate element.

For a COMPLETE Update:

If updateType is not present or has the value urn:liberty:sb:2006-08:EndpointUpdate:Complete, the <wsa:EndpointUpdate> is a completely specified endpoint reference.

For a PARTIAL Update:

1. Take the <wsa:Address> from the <wsa:EndpointUpdate>. If the value is urn:liberty:sb:2006-08:EndpointUpdate:NoChange, then take the <wsa:Address> from the original endpoint reference.

2. Take the <wsa:ReferenceParameters> from the <wsa:EndpointUpdate>, if present. Then, if <wsa:ReferenceParameters> is present in the orginal endpoint reference, take each direct child from that element that does not match an element already taken from the update (comparing the namespace qualified names of the elements).

3. Take the <wsa:Metadata> from the <wsa:EndpointUpdate>, if present. Then, if <wsa:Metadata> is present in the orginal endpoint reference, take each direct child from that element that does not match an element already taken from the update (comparing the namespace qualified names of the elements).

4. Take any extension elements from the <wsa:EndpointUpdate>, if present. Then, if any extension elements are present in the orginal endpoint reference, take each one that does not match * @return

handleEndpointUpdatedState

private void handleEndpointUpdatedState()
                                 throws net.shibboleth.utilities.java.support.xml.XMLParserException,
                                        org.opensaml.core.xml.io.UnmarshallingException

After an EndpointUpdate, the original message is invoked again, with a different EPR

Throws:

org.opensaml.core.xml.io.UnmarshallingException

net.shibboleth.utilities.java.support.xml.XMLParserException

handleRedirectRequestState

private void handleRedirectRequestState()
                                 throws net.shibboleth.utilities.java.support.xml.XMLParserException,
                                        org.opensaml.core.xml.io.UnmarshallingException

If the WSC resends its request it MUST set the value of the wsa:RelatesTo SOAP Header to the same value of the wsa:MessageID SOAP Header of the SOAP Fault that carried the <RedirectRequest> element.

(From Section 7 [LibertySOAPBinding] document http://www.projectliberty.org/specs )

Throws:

org.opensaml.core.xml.io.UnmarshallingException

net.shibboleth.utilities.java.support.xml.XMLParserException

prettyPrintRequestMessage

public static String prettyPrintRequestMessage(WSFMessage message)

Prints a nice looking output of the request message

Parameters:

message -

prettyPrintResponseMessage

public static String prettyPrintResponseMessage(WSFMessage message)

Prints a nice looking output of the response message

Parameters:

message -

buildSOAPEnvelope

public static org.opensaml.soap.soap11.Envelope buildSOAPEnvelope()
                                                           throws net.shibboleth.utilities.java.support.xml.XMLParserException,
                                                                  org.opensaml.core.xml.io.UnmarshallingException

This method creates the Basic SOAP Envelope

Read in a SOAP Envelope and unmarshall it Currently being built by reading in SOAP template file (is) This may ultimately be built from scratch to improve performance

Parameters:

is -

Returns:

Throws:

net.shibboleth.utilities.java.support.xml.XMLParserException

org.opensaml.core.xml.io.UnmarshallingException

getRequestEnvelope

public org.opensaml.soap.soap11.Envelope getRequestEnvelope()

setRequestEnvelope

public void setRequestEnvelope(org.opensaml.soap.soap11.Envelope envelope)

getResponseEnvelope

public org.opensaml.soap.soap11.Envelope getResponseEnvelope()

setResponseEnvelope

public void setResponseEnvelope(org.opensaml.soap.soap11.Envelope envelope)

getResponseString

public String getResponseString()

hasRedirectRequestBeenIssued

public boolean hasRedirectRequestBeenIssued()

The RedirectRequest element instructs the WSC to redirect the user to the WSP. It is an indication of the WSP that it cannot service a request made by the WSC before it obtains some more information from the user. If the SOAP response contains a Fault with the <RedirectRequest> element, this will return true.

hasUpdatedEndpointReference

public boolean hasUpdatedEndpointReference()

This boolean indicates that there is an updated endpoint reference that needs to be processed by the service client.

Returns: