|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.ws.soap.util.SOAPHelper
public final class SOAPHelper
Helper methods for working with SOAP.
Method Summary | |
---|---|
static void |
addActorAttribute(org.opensaml.xml.XMLObject soapObject,
String actorURI)
Deprecated. use instead addSOAP11ActorAttribute(XMLObject, String) . |
static void |
addEncodingStyle(org.opensaml.xml.XMLObject soapObject,
String encodingStyle)
Deprecated. use instead addSOAP11EncodingStyle(XMLObject, String) . |
static void |
addEncodingStyles(org.opensaml.xml.XMLObject soapObject,
List<String> encodingStyles)
Deprecated. use instead addSOAP11EncodingStyles(XMLObject, List) . |
static void |
addHeaderBlock(MessageContext messageContext,
org.opensaml.xml.XMLObject headerBlock)
Add a header block to the SOAP envelope contained within the specified message context's MessageContext.getOutboundMessage() . |
static void |
addMustUnderstandAttribute(org.opensaml.xml.XMLObject soapObject,
boolean mustUnderstand)
Deprecated. use instead addSOAP11MustUnderstandAttribute(XMLObject, boolean) . |
static void |
addSOAP11ActorAttribute(org.opensaml.xml.XMLObject soapObject,
String actorURI)
Adds a soap11:actor attribute to the given SOAP object. |
static void |
addSOAP11EncodingStyle(org.opensaml.xml.XMLObject soapObject,
String encodingStyle)
Adds a single encoding style to the given SOAP object. |
static void |
addSOAP11EncodingStyles(org.opensaml.xml.XMLObject soapObject,
List<String> encodingStyles)
Adds a soap11:encodingStyle attribute to the given SOAP object. |
static void |
addSOAP11HeaderBlock(Envelope envelope,
org.opensaml.xml.XMLObject headerBlock)
Add a header to the SOAP 1.1 Envelope. |
static void |
addSOAP11MustUnderstandAttribute(org.opensaml.xml.XMLObject soapObject,
boolean mustUnderstand)
Adds a soap11:mustUnderstand attribute to the given SOAP object. |
static void |
addSOAP12EncodingStyleAttribute(org.opensaml.xml.XMLObject soapObject,
String style)
Adds the soap12:encodingStyle attribute to the given soap object. |
static void |
addSOAP12MustUnderstandAttribute(org.opensaml.xml.XMLObject soapObject,
boolean mustUnderstand)
Adds a soap12:mustUnderstand attribute to the given SOAP object. |
static void |
addSOAP12RelayAttribute(org.opensaml.xml.XMLObject soapObject,
boolean relay)
Adds a soap12:relay attribute to the given SOAP object. |
static void |
addSOAP12RoleAttribute(org.opensaml.xml.XMLObject soapObject,
String role)
Adds the soap12:role attribute to the given soap object. |
static Fault |
buildSOAP11Fault(QName faultCode,
String faultString,
String faultActor,
List<org.opensaml.xml.XMLObject> detailChildren,
Map<QName,String> detailAttributes)
Build a SOAP 1.1. |
static List<org.opensaml.xml.XMLObject> |
getInboundHeaderBlock(MessageContext msgContext,
QName headerName,
Set<String> targetNodes,
boolean isFinalDestination)
Get a header block from the SOAP envelope contained within the specified message context's MessageContext.getInboundMessage() . |
static List<org.opensaml.xml.XMLObject> |
getOutboundHeaderBlock(MessageContext msgContext,
QName headerName,
Set<String> targetNodes,
boolean isFinalDestination)
Get a header block from the SOAP envelope contained within the specified message context's MessageContext.getOutboundMessage() . |
static String |
getSOAP11ActorAttribute(org.opensaml.xml.XMLObject soapObject)
Gets the soap11:actor attribute from a given SOAP object. |
static List<String> |
getSOAP11EncodingStyles(org.opensaml.xml.XMLObject soapObject)
Gets the list value of the soap11:encodingStyle attribute from the given SOAP object. |
static List<org.opensaml.xml.XMLObject> |
getSOAP11HeaderBlock(Envelope envelope,
QName headerName,
Set<String> targetNodes,
boolean isFinalDestination)
Get a header block from the SOAP 1.1 envelope. |
static boolean |
getSOAP11MustUnderstandAttribute(org.opensaml.xml.XMLObject soapObject)
Get the soap11:mustUnderstand attribute from a given SOAP object. |
static String |
getSOAP12EncodingStyleAttribute(org.opensaml.xml.XMLObject soapObject)
Gets the soap12:encodingStyle . |
static boolean |
getSOAP12MustUnderstandAttribute(org.opensaml.xml.XMLObject soapObject)
Get the soap12:mustUnderstand attribute from a given SOAP object. |
static boolean |
getSOAP12RelayAttribute(org.opensaml.xml.XMLObject soapObject)
Get the soap12:relay attribute from a given SOAP object. |
static String |
getSOAP12RoleAttribute(org.opensaml.xml.XMLObject soapObject)
Gets the soap12:role . |
static boolean |
isInboundSOAPMessage(MessageContext messageContext)
Determine whether the inbound message represented by the message context contains a SOAP Envelope. |
static boolean |
isSOAP11HeaderTargetedToNode(org.opensaml.xml.XMLObject header,
Set<String> nodeActors,
boolean isFinalDestination)
Evaluate whether the specified header block is targeted to a SOAP 1.1 node given the specified parameters. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static void addSOAP11MustUnderstandAttribute(org.opensaml.xml.XMLObject soapObject, boolean mustUnderstand)
soap11:mustUnderstand
attribute to the given SOAP object.
soapObject
- the SOAP object to add the attribute tomustUnderstand
- whether mustUnderstand is true or falsepublic static boolean getSOAP11MustUnderstandAttribute(org.opensaml.xml.XMLObject soapObject)
soap11:mustUnderstand
attribute from a given SOAP object.
soapObject
- the SOAP object to add the attribute to
public static void addSOAP11ActorAttribute(org.opensaml.xml.XMLObject soapObject, String actorURI)
soap11:actor
attribute to the given SOAP object.
soapObject
- the SOAP object to add the attribute toactorURI
- the URI of the actorpublic static String getSOAP11ActorAttribute(org.opensaml.xml.XMLObject soapObject)
soap11:actor
attribute from a given SOAP object.
soapObject
- the SOAP object to add the attribute to
public static void addSOAP11EncodingStyle(org.opensaml.xml.XMLObject soapObject, String encodingStyle)
soap11:encodingStyle
attribute
is present, the given style will be added to the existing list.
soapObject
- the SOAP object to add the attribute toencodingStyle
- the encoding style to addpublic static void addSOAP11EncodingStyles(org.opensaml.xml.XMLObject soapObject, List<String> encodingStyles)
soap11:encodingStyle
attribute to the given SOAP object.
soapObject
- the SOAP object to add the attribute toencodingStyles
- the list of encoding styles to addpublic static List<String> getSOAP11EncodingStyles(org.opensaml.xml.XMLObject soapObject)
soap11:encodingStyle
attribute from the given SOAP object.
soapObject
- the SOAP object to add the attribute to
public static void addSOAP12EncodingStyleAttribute(org.opensaml.xml.XMLObject soapObject, String style)
soap12:encodingStyle
attribute to the given soap object.
soapObject
- object to which the encoding style attribute should be addedstyle
- the encoding stylepublic static String getSOAP12EncodingStyleAttribute(org.opensaml.xml.XMLObject soapObject)
soap12:encodingStyle
.
soapObject
- the SOAP object which may contain the encoding style
public static void addSOAP12MustUnderstandAttribute(org.opensaml.xml.XMLObject soapObject, boolean mustUnderstand)
soap12:mustUnderstand
attribute to the given SOAP object.
soapObject
- the SOAP object to add the attribute tomustUnderstand
- whether mustUnderstand is true or falsepublic static boolean getSOAP12MustUnderstandAttribute(org.opensaml.xml.XMLObject soapObject)
soap12:mustUnderstand
attribute from a given SOAP object.
soapObject
- the SOAP object to add the attribute to
public static void addSOAP12RelayAttribute(org.opensaml.xml.XMLObject soapObject, boolean relay)
soap12:relay
attribute to the given SOAP object.
soapObject
- the SOAP object to add the attribute torelay
- whether relay is true or falsepublic static boolean getSOAP12RelayAttribute(org.opensaml.xml.XMLObject soapObject)
soap12:relay
attribute from a given SOAP object.
soapObject
- the SOAP object to add the attribute to
public static void addSOAP12RoleAttribute(org.opensaml.xml.XMLObject soapObject, String role)
soap12:role
attribute to the given soap object.
soapObject
- object to which the rol attribute should be addedrole
- the rolepublic static String getSOAP12RoleAttribute(org.opensaml.xml.XMLObject soapObject)
soap12:role
.
soapObject
- the SOAP object which may contain the role
public static void addActorAttribute(org.opensaml.xml.XMLObject soapObject, String actorURI)
addSOAP11ActorAttribute(XMLObject, String)
.
soap11:actor
attribute to the given SOAP object.
soapObject
- the SOAP object to add the attribute toactorURI
- the URI of the actorpublic static void addEncodingStyle(org.opensaml.xml.XMLObject soapObject, String encodingStyle)
addSOAP11EncodingStyle(XMLObject, String)
.
soap11:encodingStyle
attribute
is present, the given style will be added to the existing list.
soapObject
- the SOAP object to add the attribute toencodingStyle
- the encoding style to addpublic static void addEncodingStyles(org.opensaml.xml.XMLObject soapObject, List<String> encodingStyles)
addSOAP11EncodingStyles(XMLObject, List)
.
soap11:encodingStyle
attribute to the given SOAP object.
soapObject
- the SOAP object to add the attribute toencodingStyles
- the list of encoding styles to addpublic static void addMustUnderstandAttribute(org.opensaml.xml.XMLObject soapObject, boolean mustUnderstand)
addSOAP11MustUnderstandAttribute(XMLObject, boolean)
.
soap11:mustUnderstand
attribute to the given SOAP object.
soapObject
- the SOAP object to add the attribute tomustUnderstand
- whether mustUnderstand is true or falsepublic static void addHeaderBlock(MessageContext messageContext, org.opensaml.xml.XMLObject headerBlock)
MessageContext.getOutboundMessage()
.
messageContext
- the message context being processedheaderBlock
- the header block to addpublic static void addSOAP11HeaderBlock(Envelope envelope, org.opensaml.xml.XMLObject headerBlock)
envelope
- the SOAP 1.1 envelope to processheaderBlock
- the header to addpublic static List<org.opensaml.xml.XMLObject> getInboundHeaderBlock(MessageContext msgContext, QName headerName, Set<String> targetNodes, boolean isFinalDestination)
MessageContext.getInboundMessage()
.
msgContext
- the message context being processedheaderName
- the name of the header block to returntargetNodes
- the explicitly specified SOAP node actors (1.1) or roles (1.2) for which the header is desiredisFinalDestination
- true specifies that headers targeted for message final destination should be returned,
false means they should not be returned
public static List<org.opensaml.xml.XMLObject> getOutboundHeaderBlock(MessageContext msgContext, QName headerName, Set<String> targetNodes, boolean isFinalDestination)
MessageContext.getOutboundMessage()
.
msgContext
- the message context being processedheaderName
- the name of the header block to returntargetNodes
- the explicitly specified SOAP node actors (1.1) or roles (1.2) for which the header is desiredisFinalDestination
- true specifies that headers targeted for message final destination should be returned,
false specifies they should not be returned
public static List<org.opensaml.xml.XMLObject> getSOAP11HeaderBlock(Envelope envelope, QName headerName, Set<String> targetNodes, boolean isFinalDestination)
envelope
- the SOAP 1.1 envelope to processheaderName
- the name of the header block to returntargetNodes
- the explicitly specified SOAP node actors for which the header is desiredisFinalDestination
- true specifies that headers targeted for message final destination should be returned,
false specifies they should not be returned
public static boolean isSOAP11HeaderTargetedToNode(org.opensaml.xml.XMLObject header, Set<String> nodeActors, boolean isFinalDestination)
header
- the header to evaluatenodeActors
- the explicitly specified node actors for which the header is desiredisFinalDestination
- true specifies that headers targeted for message final destination should be returned,
false specifies they should not be returned
public static boolean isInboundSOAPMessage(MessageContext messageContext)
messageContext
- the current message context
public static Fault buildSOAP11Fault(QName faultCode, String faultString, String faultActor, List<org.opensaml.xml.XMLObject> detailChildren, Map<QName,String> detailAttributes)
faultCode
- the 'faultcode' QName (required)faultString
- the 'faultstring' value (required)faultActor
- the 'faultactor' value (may be null)detailChildren
- the 'detail' child elementsdetailAttributes
- the 'detail' element attributes
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |