Package com.aquima.interactions.communication

Interface ISoapMessageContext

All Superinterfaces:

IPortalContext, Serializable

All Known Implementing Classes:

SoapMessageContext

public interface ISoapMessageContext
extends IPortalContext

Context interface for manipulating SOAP messages

Since:

9.5

Author:

Radu Batori

Method Summary

Modifier and Type	Method	Description
IXmlElementContext	addHeader(QualifiedName header)	Add a SOAP header
IXmlElementContext	getHeader(QualifiedName headerName)	Get a SOAP header by name
Collection<IXmlElementContext>	getHeaders()	Get a 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 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

Method Details

getHeaders

Collection<IXmlElementContext> getHeaders()

Get a Collection of the SOAP headers

Returns:

The SOAP header collection

getHeader

IXmlElementContext getHeader(QualifiedName headerName)

Get a SOAP header by name

Parameters:

headerName - The name of the SOAP header to be returned

Returns:

The SOAP header if found or null otherwise

addHeader

IXmlElementContext addHeader(QualifiedName header)

Add a SOAP header

Parameters:

header - The name of the header to be added

Returns:

The added header

removeHeader

void removeHeader(IXmlElementContext header)

Remove a SOAP header

Parameters:

header - The header to be removed

setNamespace

void setNamespace(String prefix,
 String namespace)

Set an XML namespace

Parameters:

prefix - The namespace prefix

namespace - The actual namespace

getSoapBody

String getSoapBody()

Get the XML body as string

Returns:

The XML body

setSoapBody

void setSoapBody(String xmlBody)

Replace the current XML SOAP body with the string provided

Parameters:

xmlBody - The new XML body

Throws:

XmlParseException - when the parsing of the xmlBody fails

getOperationName

String getOperationName()

Get the operation name

Returns:

the operation name used for this message context

getServiceDefinition

ISoapServiceDefinition getServiceDefinition()

Get the SOAP service definition

Returns:

The service definition