Package com.aquima.interactions.portal.model.session

Class SoapMessageContext

java.lang.Object

com.aquima.interactions.portal.model.session.PortalContextDelegate

com.aquima.interactions.portal.model.session.SoapMessageContext

All Implemented Interfaces:

ISoapMessageContext, IPortalContext, IInternalPortalContext, Serializable

public class SoapMessageContext
extends PortalContextDelegate
implements ISoapMessageContext

ISoapMessageContext default implementation. It provides methods to retrieve and to manipulate a soap message in a ISoapMessageHandler instance.

Since:

9.5

Author:

Radu Batori

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SoapMessageContext(ISoapServiceDefinition soapDefinition, IInternalPortalContext context, IXmlElementContext soapDocument, IXmlElementContext soapHeader, IXmlElementContext soapBody, String operationName)	Constructs a SoapMessageContext.

Method Summary

Modifier and Type	Method	Description
IXmlElementContext	addHeader(QualifiedName headerName)	Add a SOAP header
IXmlElementContext	getHeader(QualifiedName headerName)	Get a SOAP header by name
Collection<IXmlElementContext>	getHeaders()	Get an modifiable Collection of the SOAP headers.
String	getOperationName()	Get the operation name
ISoapServiceDefinition	getServiceDefinition()	Get the SOAP service definition
String	getSoapBody()	Get the XML body as string
void	removeHeader(IXmlElementContext header)	Remove a SOAP header
void	setNamespace(String prefix, String namespace)	Set an XML namespace
void	setSoapBody(String xmlBody)	Replace the current XML SOAP body with the string provided.

Methods inherited from class com.aquima.interactions.portal.model.session.PortalContextDelegate

forModule, forModule, getActiveInstance, getApplication, getApplicationMode, getApplicationModel, getAuditEngine, getCaseEngineClient, getCommentsManager, getCommunicationEngine, getComposer, getConfiguration, getConnectionManager, getContentManagerFactory, getContentManagerFactory, getContext, getCurrentFlow, getCurrentLanguage, getDebugger, getDocumentEngine, getElementComposer, getExpressionParser, getFactoryManager, getFlowEngine, getFlowScope, getFunctionCallDefinitionManager, getId, getMappingComposer, getMappingManager, getMaskManager, getMatchEngine, getMetaModel, getPageScope, getProcessScope, getProfile, getProject, getRequestScope, getResourceManager, getRuleEngine, getServiceManager, getSessionId, getSessionScope, getState, getTraceEngine, getTreeEngine, getUserProfile, getUserScope, getWebServices, pushActiveInstance, restore

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.portal.IPortalContext

forModule, forModule, getActiveInstance, getApplicationMode, getAuditEngine, getCaseEngineClient, getCommentsManager, getCommunicationEngine, getConnectionManager, getContentManagerFactory, getContentManagerFactory, getCurrentFlow, getCurrentLanguage, getDebugger, getDocumentEngine, getElementComposer, getExpressionParser, getFlowEngine, getFlowScope, getFunctionCallDefinitionManager, getMappingComposer, getMappingManager, getMaskManager, getMatchEngine, getMetaModel, getPageScope, getProcessScope, getProfile, getProject, getRequestScope, getResourceManager, getRuleEngine, getServiceManager, getSessionId, getSessionScope, getState, getTraceEngine, getTreeEngine, getUserProfile, getUserScope, getWebServices, pushActiveInstance, restore

Constructor Details

SoapMessageContext

public SoapMessageContext(ISoapServiceDefinition soapDefinition,
 IInternalPortalContext context,
 IXmlElementContext soapDocument,
 IXmlElementContext soapHeader,
 IXmlElementContext soapBody,
 String operationName)

Constructs a SoapMessageContext.

Parameters:

soapDefinition - The soap service definition

context - The underlying context

soapDocument - The document XML element

soapHeader - The SOAP header XML element

soapBody - The SOAP body XML element

operationName - The SOAP operation name

Method Details

getHeaders

public Collection<IXmlElementContext> getHeaders()

Get an modifiable Collection of the SOAP headers. Use getHeader(QualifiedName), addHeader(QualifiedName) and removeHeader(IXmlElementContext) to modify the SOAP headers.

Specified by:

getHeaders in interface ISoapMessageContext

Returns:

The SOAP header unmodifiable collection

getHeader

public IXmlElementContext getHeader(QualifiedName headerName)

Get a SOAP header by name

Specified by:

getHeader in interface ISoapMessageContext

Parameters:

headerName - The name of the SOAP header to be returned

Returns:

The SOAP header if found or null otherwise

addHeader

public IXmlElementContext addHeader(QualifiedName headerName)

Add a SOAP header

Specified by:

addHeader in interface ISoapMessageContext

Parameters:

headerName - The name of the header to be added

Returns:

The added header

removeHeader

public void removeHeader(IXmlElementContext header)

Remove a SOAP header

Specified by:

removeHeader in interface ISoapMessageContext

Parameters:

header - The header to be removed

getSoapBody

public String getSoapBody()

Get the XML body as string

Specified by:

getSoapBody in interface ISoapMessageContext

Returns:

The XML body

setSoapBody

public void setSoapBody(String xmlBody)

Replace the current XML SOAP body with the string provided.

Specified by:

setSoapBody in interface ISoapMessageContext

Parameters:

xmlBody - The new XML body. Must be valid XML.

Throws:

XmlParseException

getOperationName

public String getOperationName()

Get the operation name

Specified by:

getOperationName in interface ISoapMessageContext

Returns:

setNamespace

public void setNamespace(String prefix,
 String namespace)

Set an XML namespace

Specified by:

setNamespace in interface ISoapMessageContext

Parameters:

prefix - The namespace prefix

namespace - The actual namespace

getServiceDefinition

public ISoapServiceDefinition getServiceDefinition()

Get the SOAP service definition

Specified by:

getServiceDefinition in interface ISoapMessageContext

Returns:

The service definition