-
- All Superinterfaces:
- Map<String,Object>, MessageContext
public interface SOAPMessageContext extends MessageContext
The interfaceSOAPMessageContext
provides access to the SOAP message for either RPC request or response. Thejavax.xml.soap.SOAPMessage
specifies the standard Java API for the representation of a SOAP 1.1 message with attachments.- Since:
- JAX-WS 2.0
- See Also:
SOAPMessage
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface javax.xml.ws.handler.MessageContext
MessageContext.Scope
-
-
Field Summary
-
Fields inherited from interface javax.xml.ws.handler.MessageContext
HTTP_REQUEST_HEADERS, HTTP_REQUEST_METHOD, HTTP_RESPONSE_CODE, HTTP_RESPONSE_HEADERS, INBOUND_MESSAGE_ATTACHMENTS, MESSAGE_OUTBOUND_PROPERTY, OUTBOUND_MESSAGE_ATTACHMENTS, PATH_INFO, QUERY_STRING, REFERENCE_PARAMETERS, SERVLET_CONTEXT, SERVLET_REQUEST, SERVLET_RESPONSE, WSDL_DESCRIPTION, WSDL_INTERFACE, WSDL_OPERATION, WSDL_PORT, WSDL_SERVICE
-
-
Method Summary
Methods Modifier and Type Method and Description Object[]
getHeaders(QName header, JAXBContext context, boolean allRoles)
Gets headers that have a particular qualified name from the message in the message context.SOAPMessage
getMessage()
Gets theSOAPMessage
from this message context.Set<String>
getRoles()
Gets the SOAP actor roles associated with an execution of the handler chain.void
setMessage(SOAPMessage message)
Sets the SOAPMessage in this message context
-
-
-
Method Detail
-
getMessage
SOAPMessage getMessage()
Gets theSOAPMessage
from this message context. Modifications to the returnedSOAPMessage
change the message in-place, there is no need to subsequently callsetMessage
.- Returns:
- Returns the
SOAPMessage
; returnsnull
if noSOAPMessage
is present in this message context
-
setMessage
void setMessage(SOAPMessage message)
Sets the SOAPMessage in this message context- Parameters:
message
- SOAP message- Throws:
WebServiceException
- If any error during the setting of theSOAPMessage
in this message contextUnsupportedOperationException
- If this operation is not supported
-
getHeaders
Object[] getHeaders(QName header, JAXBContext context, boolean allRoles)
Gets headers that have a particular qualified name from the message in the message context. Note that a SOAP message can contain multiple headers with the same qualified name.- Parameters:
header
- The XML qualified name of the SOAP header(s).context
- The JAXBContext that should be used to unmarshall the headerallRoles
- Iftrue
then returns headers for all SOAP roles, iffalse
then only returns headers targetted at the roles currently being played by this SOAP node, seegetRoles
.- Returns:
- An array of unmarshalled headers; returns an empty array if no message is present in this message context or no headers match the supplied qualified name.
- Throws:
WebServiceException
- If an error occurs when using the suppliedJAXBContext
to unmarshall. The cause of theWebServiceException
is the originalJAXBException
.
-
getRoles
Set<String> getRoles()
Gets the SOAP actor roles associated with an execution of the handler chain. Note that SOAP actor roles apply to the SOAP node and are managed usingSOAPBinding.setRoles(java.util.Set<java.lang.String>)
andSOAPBinding.getRoles()
.Handler
instances in the handler chain use this information about the SOAP actor roles to process the SOAP header blocks. Note that the SOAP actor roles are invariant during the processing of SOAP message through the handler chain.- Returns:
- Array of
String
for SOAP actor roles
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/11/2024 09:15:21 Cette version de la page est en cache (à la date du 22/11/2024 09:15:21) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/xml/ws/handler/soap/soapmessagecontext.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.