Mediation

Overview

Package

Class

Tree

Deprecated

Index

Help

AdroitLogic UltraESB v1.7.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.adroitlogic.ultraesb.api
Interface Mediation

public interface Mediation

Defines the public API for mediation. This interface exposes many convenience functions for mediation of messages.

However, functions dependent on libraries that are not shipped with the main distribution may still be available with the UltraESB as additional beans (e.g. XQuerySupport)

Method Summary
`void`	`addPreemptiveBasicAuthentication(Message msg, java.lang.String username, java.lang.String password)` Deprecated. From v1.7,0 replaced by `HTTPSupport.addPreemptiveBasicAuthentication(Message, String, String)` Adds an HTTP transport header for pre-emptive basic authentication for this message. Note: Pre-emptive basic authentication will perform better than basic authentication after an initial request fails with an HTTP 401 authentication required response. However, basic authentication will not be secure as digest authentication or other such mechanisms. It is reccomended that basic authentication if used, should be over an SSL secured connection - in which case the authentication security would be acceptable
`void`	`addPreemptiveBasicAuthentication(Message msg, java.lang.String username, java.lang.String password, java.lang.String charset, boolean proxy)` Deprecated. From v1.7,0 replaced by `HTTPSupport.addPreemptiveBasicAuthentication(Message, String, String, String, boolean)` Adds an HTTP transport header for pre-emptive basic authentication for this message. Note: Pre-emptive basic authentication will perform better than basic authentication after an initial request fails with an HTTP 401 authentication required response. However, basic authentication will not be secure as digest authentication or other such mechanisms. It is reccomended that basic authentication if used, should be over an SSL secured connection - in which case the authentication security would be acceptable
`void`	`convertFromFI(Message m)` Deprecated. From v1.7,0 replaced by `XMLSupport.convertFromFI(Message)` or `SOAPSupport.convertFromFI(Message)` Convert the payload of the current message from a FastInfoset binary to an XML message (Note the XML payload is still kept as a RawFileMessage by default and maybe converted into a DOM message if required)
`void`	`convertJSONToStream(Message m, java.lang.Object o)` Deprecated. From v1.7,0 replaced by `JSONSupport.convertJSONToStream(Message, Object)` Convert an untyped Object (e.g. Map holding a JSON payload) to a streamed (file based) message
`void`	`convertSOAPToJSONStream(Message m)` Deprecated. From v1.7,0 replaced by `SOAPSupport.convertSOAPToJSONStream(Message)` or `JSONSupport.convertSOAPToJSONStream(Message)` Convert the current SOAP message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream
`void`	`convertSOAPToJSONStream(Message m, javax.xml.namespace.QName staringElement, boolean retainNSPrefixes)` Deprecated. From v1.7,0 replaced by `SOAPSupport.convertSOAPToJSONStream(Message, javax.xml.namespace.QName, boolean)` or `JSONSupport.convertSOAPToJSONStream(Message, javax.xml.namespace.QName, boolean)` Convert the current SOAP message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream
`void`	`convertToDOM(Message m)` Deprecated. From v1.7,0 replaced by `XMLSupport.convertToDOM(Message)` Convert the current message into a DOMMessage
`void`	`convertToFI(Message m)` Deprecated. From v1.7,0 replaced by `XMLSupport.convertToFI(Message)` or `SOAPSupport.convertToFI(Message)` Convert the XML message into a FastInfoset binary message
`java.lang.Object`	`convertToTypedJSON(Message m, java.lang.Class clazz)` Deprecated. From v1.7,0 replaced by `JSONSupport.convertToTypedJSON(Message, Class)` Convert the current message into a Typed JSON Object
`java.util.Map`	`convertToUntypedJSON(Message m)` Deprecated. From v1.7,0 replaced by `JSONSupport.convertToUntypedJSON(Message)` Convert the current message into an untyped JSON MapMessage
`void`	`convertXMLToJSONStream(Message m)` Deprecated. From v1.7,0 replaced by `XMLSupport.convertXMLToJSONStream(Message)` or `JSONSupport.convertXMLToJSONStream(Message)` Convert the current XML message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream
`void`	`convertXMLToJSONStream(Message m, javax.xml.namespace.QName staringElement, boolean retainNSPrefixes)` Deprecated. From v1.7,0 replaced by `XMLSupport.convertXMLToJSONStream(Message, javax.xml.namespace.QName, boolean)` or `JSONSupport.convertXMLToJSONStream(Message, javax.xml.namespace.QName, boolean)` Convert the current XML message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream
`org.w3c.dom.Document`	`createDOMDocument()` Deprecated. From v1.7,0 replaced by `XMLSupport.createDOMDocument()` Create a new DOM Document object and return
`void`	`dropMessage(Message m)` Mark this message as a 'Dropped' message.
`org.w3c.dom.NodeList`	`extractAsNodeListUsingXPath(Message m, java.lang.String exprn, java.lang.String[][] ns)` Deprecated. From v1.7,0 replaced by `XMLSupport.extractAsNodeListUsingXPath(Message, String, String[][])` Evaluate the given XPath expression against the XML payload, and return result as a NodeList This method converts the current payload into a DOMMessage
`java.lang.String`	`extractAsStringUsingXPath(Message m, java.lang.String exprn, java.lang.String[][] ns)` Deprecated. From v1.7,0 replaced by `XMLSupport.extractAsStringUsingXPath(Message, String, String[][])` or `SOAPSupport.extractAsStringUsingXPath(Message, String, String[][])` Evaluate the given XPath expression against the XML payload, and return result as a String This method converts the current payload into a DOMMessage
`boolean`	`filter(Message m, java.lang.String exprn, java.lang.String[][] ns)` Deprecated. From v1.7,0 replaced by `XMLSupport.filter(Message, String, String[][])` or `SOAPSupport.filter(Message, String, String[][])` Evaluate the given boolean XPath expression over the XML payload
`boolean`	`filter(Message m, java.lang.String exprn, java.lang.String[][] ns, java.lang.String regex)` Deprecated. From v1.7,0 replaced by `XMLSupport.filter(Message, String, String[][], String)` or `SOAPSupport.filter(Message, String, String[][], String)` Evaluate the given XPath expression over the XML payload and compare the resulting String value with the regular expression for a match. This method converts the current payload into a DOMMessage
`AS2Manager`	`getAS2Manager()` Get the AS2Manager from the bean with the id "as2Manager"
`AS2Manager`	`getAS2Manager(java.lang.String name)` Get the AS2Manager by the given name
`CachingSupport`	`getCachingSupport()` Access Caching support API
`java.sql.Connection`	`getConnection(java.lang.String dataSource)` Get a database connection from the datasource defined in the [Spring] configuration with the given id
`java.lang.String`	`getCookie(Message msg, java.lang.String name)` Deprecated. From v1.7,0 replaced by `HTTPSupport.getCookie(Message, String)` Return the value of the cookie with the given name
`javax.sql.DataSource`	`getDataSource(java.lang.String dataSource)` Get the DataSource with the specified id from the [Spring] configuration
`java.util.Date`	`getDateFromISO8601String(java.lang.String s)` Deprecated. From v1.7,0 replaced by `DateSupport.getDateFromISO8601String(String)` Returns a java.util.Date from an ISO8601 compliant date string yyyy-MM-dd
`java.util.Date`	`getDateFromUTCString(java.lang.String s)` Deprecated. From v1.7,0 replaced by `DateSupport.getDateFromUTCString(String)` Returns a java.util.Date from a UTC date string of the form yyyy-MM-dd'T'HH:mm:ss'Z'
`DateSupport`	`getDateSupport()` Access Date support API
`java.lang.String`	`getDefaultPlatformTM()` Get the ID of the only PlatformTransactionManager defined into the configuration Only supported when only one transaction manager is defined
`Cache`	`getDistributedCache()` Deprecated. From v1.7,0 replaced by `CachingSupport.getDistributedCache()` Applicable only when the clustering is enabled and deployed as a cluster. Characteristics of the cache returned by this method is equal to the cache that of `Mediation.getLocalCache()` but this replicates the content across the nodes in the cluster. Not like the local equivalent to which you can put any thing, this only accepts `Serializable` content as both key and value of the entries in the cache. This is because the content you put has to be serialized as the cache needs to replicate the content using RMI. If the node is starting up later in the cluster, (i.e. it joins a cluster with a state) the node bootstraps the cache content from one of its arbitrarily selected peers.
`Cache`	`getDistributedPermanentCache()` Deprecated. From v1.7,0 replaced by `CachingSupport.getDistributedPermanentCache()` Applicable only when the clustering is enabled and deployed as a cluster. Characteristics of the cache returned by this method is equal to the cache that of `Mediation.getLocalPermanentCache()` but this replicates the content across the nodes in the cluster. Not like the local equivalent to which you can put any thing, this only accepts `Serializable` content as both key and value of the entries in the cache. This is because the content you put has to be serialized as the cache needs to replicate the content using RMI. You should take extra care about the content life cycle, as the cache doesn't expire the entries that you put. If the node is starting up later in the cluster, (i.e. it joins a cluster with a state) the node bootstraps the cache content from one of its arbitrarily selected peers. Because of the above bootstrap, not like in the local equivalent unless the complete cluster goes off the content will be preserved even on a System/JVM restart on a single node, as it will bootstrap it's cache content from a peer in the cluster.
`Cache`	`getDistributedPersistentCache()` Deprecated. From v1.7,0 replaced by `CachingSupport.getDistributedPersistentCache()` Applicable only when the clustering is enabled and deployed as a cluster. Characteristics of the cache returned by this method is equal to the cache that of `Mediation.getLocalPersistentCache()` but this replicates the content across the nodes in the cluster. Not like the local equivalent to which you can put any thing, this only accepts `Serializable` content as both key and value of the entries in the cache. This is because the content you put has to be serialized as the cache needs to replicate the content using RMI. You should take extra care about the content life cycle, as the cache doesn't expire the entries that you put. If the node is starting up later in the cluster, (i.e. it joins a cluster with a state) the node bootstraps the cache content from one of its arbitrarily selected peers.
`HTTPSupport`	`getHTTPSupport()` Access HTTP support API
`java.lang.String`	`getISO8601FormattedString(java.util.Date date)` Deprecated. From v1.7,0 replaced by `DateSupport.getISO8601FormattedString(java.util.Date)` Returns an ISO8601 compliant date string as yyyy-MM-dd
`JSONSupport`	`getJSONSupport()` Access JSON support API
`java.lang.String`	`getJvmRoute(Message msg)` Deprecated. From v1.7,0 replaced by `HTTPSupport.getJvmRoute(Message)` Return the jvmRoute from the JSESSIONID cookie or jsessionid URL parameter of an HTTP/S request
`Cache`	`getLocalCache()` Deprecated. From v1.7,0 replaced by `CachingSupport.getLocalCache()` Gets the `Cache` instance which is available locally in the node, and expires it's entries in a given time. It also has a time to live and nothing is guaranteed to be present in this cache. If you need your content to be present through out the session, use the `Mediation.getLocalPermanentCache()` to get the cache which will give you the permanent cache. This cache overflows the content to disk in case of exceeding the in-memory cache size, which defaults to 10000 entries. How ever after storing another 1000 entries in the disk, the cache will permanently overflow, which sniffs something wrong in your mediation, as the content in this cache is automatically cleared in the expiration time.
`Cache`	`getLocalPermanentCache()` Deprecated. From v1.7,0 replaced by `CachingSupport.getLocalPermanentCache()` Gets the `Cache` instance which is available locally in the node, and keeps its contents in the cache within a session. The contents in this cache will never be expired but they are not persisted, so they will be lost at a System/JVM restart. If you want content to be available across JVM sessions, use `Mediation.getLocalPersistentCache()` instead. You should be using this with care, as the content life cycle is not managed by the cache it is your responsibility to manage the cache content life cycle. Otherwise you might get into a resource exhaustion. This cache overflows the content to disk in case of exceeding the in-memory cache size, which defaults to 1000 entries, while there is no limit to the content which will be overflowed to disk
`Cache`	`getLocalPersistentCache()` Deprecated. From v1.7,0 replaced by `CachingSupport.getLocalPersistentCache()` Gets the `Cache` instance which is available locally in the node, and keeps its contents in the cache forever across the sessions. In other words the content will be persisted to the disk. Once again you should be extra careful about the usage, as the content will be there even after a system/JVM restart. It is possible to crash the disk space and the data persisted in the disk be lost and the cache is not handling that case as it really cannot do anything for the data corruption. This cache by default keeps only 100 entries in-memory and it off-loads the content to disk and loads the content from disk depending on the demand for those entries. You could treat this as a NO-SQL persistent store, available locally in your node. If you want the content to be available among the cluster in the case of a clustered deployment, use the `Mediation.getDistributedPersistentCache()`
`ProtocolBufferSupport`	`getProtocolBufferSupport()` Access Protocol Buffer support API
`java.lang.String`	`getSoapAction(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapAction(Message)` Return the SOAPAction transport header
`java.lang.String`	`getSoapAddressingAction(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapAddressingAction(Message)` Get the WSA Action header
`java.lang.String`	`getSoapAddressingFaultTo(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapAddressingFaultTo(Message)` Get the WSA FaultTo header
`java.lang.String`	`getSoapAddressingFrom(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapAddressingFrom(Message)` Get the WSA From header
`java.lang.String`	`getSoapAddressingMessageID(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapAddressingMessageID(Message)` Get the WSA MessageID header
`java.lang.String`	`getSoapAddressingReplyTo(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapAddressingReplyTo(Message)` Get the WSA ReplyTo header
`java.lang.String`	`getSoapAddressingTo(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapAddressingTo(Message)` Get the WSA To header
`java.lang.String`	`getSoapFaultCode(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapFaultCode(Message)` Extract the SOAP 1.1 Fault/faultcode or SOAP 1.2 Fault/Code/Value if exists
`java.lang.String`	`getSoapFaultDetail(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapFaultDetail(Message)` Extract the SOAP 1.1 detail or SOAP 1.2 Detail if exists
`java.lang.String`	`getSoapFaultString(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapFaultString(Message)` Extract the SOAP 1.1 Fault/faultstring or SOAP 1.2 Reason/Text if exists
`java.lang.String`	`getSoapHeaderAsString(Message msg, java.lang.String namespace, java.lang.String name)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapHeaderAsString(Message, String, String)` Extract the SOAP 1.1/1.2 header value as a String
`java.util.Map`	`getSoapHeadersAsStrings(Message m)` Deprecated. From v1.7,0 replaced by `SOAPSupport.getSoapHeadersAsStrings(Message)` Extract the SOAP 1.1/1.2 header values as a Strings
`SOAPSupport`	`getSOAPSupport()` Access SOAP support API
`java.lang.Object`	`getSpringBean(java.lang.String id)` Get the Spring bean with the given ID from the [Spring] configuration
`java.lang.Object`	`getSpringBean(java.lang.String id, java.lang.Class clazz)` Get the Spring bean with the given ID from the [Spring] configuration
`java.sql.Date`	`getSQLDateFromISO8601String(java.lang.String s)` Deprecated. From v1.7,0 replaced by `DateSupport.getSQLDateFromISO8601String(String)` Returns a java.sql.Date from an ISO8601 compliant date string yyyy-MM-dd
`java.sql.Date`	`getSQLDateFromUTCString(java.lang.String s)` Deprecated. From v1.7,0 replaced by `DateSupport.getSQLDateFromUTCString(String)` Returns a java.sql.Date from a UTC date string of the form yyyy-MM-dd'T'HH:mm:ss'Z'
`ThrottleSupport`	`getThrottleSupport(java.lang.String id)` Gives the implementation of the `ThrottleSupport` defined in the UltraESB configuration with the given bean identifier.
`java.lang.String`	`getUTFFormattedString(java.util.Date date)` Deprecated. From v1.7,0 replaced by `DateSupport.getUTFFormattedString(java.util.Date)` Returns a UTC formatted date string as yyyy-MM-dd'T'HH:mm:ss'Z'
`WSSecurityManager`	`getWSSecurityManager()` Get the WS-Security Manager defined with the id "wssecMgr"
`XACMLSupport`	`getXACMLSupport()` Access XACML support API
`XMLSupport`	`getXMLSupport()` Access DOM support API
`void`	`invokeSequence(Message msg, java.lang.String sequenceName)` Invoke another sequence from within a sequence
`boolean`	`isHessian(Message msg)` Deprecated. From v1.7,0 replaced by `HTTPSupport.isHessian(Message)` Check the message content type to see if it indicates a Hessian message
`boolean`	`isPermitted(java.lang.String xacmlBeanId, java.util.Map custom)` Deprecated. From v1.7,0 replaced by `XACMLSupport.isPermitted(String, java.util.Map)` Is message allowed permission by the XACML processor bean selected.
`boolean`	`isPermitted(java.lang.String xacmlBeanId, Message msg)` Deprecated. From v1.7,0 replaced by `XACMLSupport.isPermitted(String, Message)` Is message allowed permission by the XACML processor bean selected. Automatically maps the following HTTP related transport properties to the specified attribute names action-id -> msg.getMessageProperty(HttpConstants.METHOD) subject-id -> msg.getMessageProperty(HttpConstants.USERNAME) role -> msg.getMessageProperty(HttpConstants.USERROLES) as a String[] client-dn -> msg.getMessageProperty(HttpConstants.SSL_CLIENT_DN) resource-id -> msg.getMessageProperty(HttpConstants.SERVICE_URL)
`boolean`	`isPermitted(java.lang.String xacmlBeanId, java.lang.String issuer, java.util.Map custom, Message msg)` Deprecated. From v1.7,0 replaced by `XACMLSupport.isPermitted(String, String, java.util.Map, Message)` Is message allowed permission by the XACML processor bean selected.
`boolean`	`isSoap(Message msg)` Deprecated. From v1.7,0 replaced by `SOAPSupport.isSoap(Message)` Check the message content type to see if it indicates a SOAP 1.1 or 1.2 message serialized as XML
`void`	`mergeXMLAttachmentsUnderElement(Message msg, java.lang.String rootElemName)` Deprecated. From v1.7,0 replaced by `XMLSupport.mergeXMLAttachmentsUnderElement(Message, String)` Replace the current XML payload with a top level element as specified, and merge the payloads from the current body, and attachments underneath that
`void`	`mergeXMLAttachmentsUnderElement(Message msg, java.lang.String rootElemName, java.lang.String rootNS)` Deprecated. From v1.7,0 replaced by `XMLSupport.mergeXMLAttachmentsUnderElement(Message, String, String)` Replace the current XML payload with a top level element as specified, and merge the payloads from the current body, and attachments underneath that
`void`	`processBasicJSONDataServiceRequest(Message msg, java.lang.String dataSvcBeanName, java.lang.String dataSourceName)` Deprecated. From v1.7,0 replaced by `JSONSupport.processBasicJSONDataServiceRequest(Message, String, String)` Process request message as a basic JSON data service request. The response would be generated by executing the specified queries of the JSON Data Service bean definition
`java.lang.String`	`readPayloadAsString(Message m)` Return the current message payload as a String limited to 8K
`boolean`	`remove(Message m, java.lang.String exprn, java.lang.String[][] ns)` Deprecated. From v1.7,0 replaced by `XMLSupport.remove(Message, String, String[][])` or `SOAPSupport.remove(Message, String, String[][])` Remove the XPath expression specified node from the XML payload. This method converts the current payload of the message into a DOMMessage
`void`	`retainElementAsPayload(Message m, java.lang.String exprn, java.lang.String[][] ns)` Deprecated. From v1.7,0 replaced by `XMLSupport.retainElementAsPayload(Message, String, String[][])` Replace the current XML payload with the resulting element from the XPath expression result
`void`	`savePayloadToFile(Message m, java.lang.String filePath)` Save the current message payload into the specified file
`void`	`sendPart(Message msg, int code, int part, int size)` Send the current payload as one single part of the complete payload.
`void`	`sendResponse(Message msg, int code)` Trigger off sending the current payload as a synchronous response message for the currently processing message If the response for the message has already been submitted, any duplicates calls are silently ignored
`void`	`sendResponseAndDrop(Message m, int code)` Trigger off sending the current payload as a synchronous response message for the currently processing message, and stop processing this message thereafter.
`void`	`sendToEndpoint(Message m, java.lang.String endpointName)` Send the current message to the endpoint with the given name.
`void`	`setCookie(Message msg, java.lang.String name, java.lang.String value)` Deprecated. From v1.7,0 replaced by `HTTPSupport.setCookie(Message, String, String)` Set a HTTP cookie on the message
`void`	`setCookie(Message msg, java.lang.String name, java.lang.String value, java.lang.String path, int age)` Deprecated. From v1.7,0 replaced by `HTTPSupport.setCookie(Message, String, String, String, int)` Set a HTTP cookie on the message
`void`	`setCookie(Message msg, java.lang.String name, java.lang.String value, java.lang.String path, java.lang.String domain, int age, boolean secure)` Deprecated. From v1.7,0 replaced by `HTTPSupport.setCookie(Message, String, String, String, String, int, boolean)` Set a HTTP cookie on the message
`void`	`setPayloadFromByteArray(Message m, byte[] bytes)` Set the payload of the current message to the byte array passed
`void`	`setPayloadFromFile(Message m, java.lang.String filePath)` Set the current payload of the message as the content of the given file
`void`	`setPayloadFromString(Message m, java.lang.String text)` Set the payload of the current message to the given String
`void`	`setPayloadToSOAP11Fault(Message m, java.lang.String code, java.lang.String faultString, java.lang.String detail)` Deprecated. From v1.7,0 replaced by `SOAPSupport.setPayloadToSOAP11Fault(Message, String, String, String)` Set the payload of the current message to a SOAP 1.1 fault message with the given code, faultString and detail
`void`	`setPayloadToSOAP12Fault(Message m, java.lang.String code, java.lang.String reason, java.lang.String detail)` Deprecated. From v1.7,0 replaced by `SOAPSupport.setPayloadToSOAP12Fault(Message, String, String, String)` Set the payload of the current message to a SOAP 1.2 fault message with the given code, reason and detail
`void`	`splitAndProcess(Message msg, java.lang.String exprn, java.lang.String[][] ns, java.lang.String sequenceName, boolean ignoreErrors)` Deprecated. From v1.7,0 replaced by `XMLSupport.splitAndProcess(Message, String, String[][], String, boolean)` or `SOAPSupport.splitAndProcess(Message, String, String[][], String, boolean)` Split current message into multiple messages using the given XPath expression, and hand over each such message to the given sequence
`void`	`transform(Message msg, java.lang.String xsltFilename)` Deprecated. From v1.7,0 replaced by `XMLSupport.transform(Message, String)` `SOAPSupport.transform(Message, String)` Transform the message payload by XSLT (without any parameters), assuming a non DOM result and assuming that the complete message payload will be used as the source of the transformation, and the result will replace the complete message payload
`void`	`transform(Message msg, java.lang.String xsltFilename, java.lang.String exprn, java.lang.String[][] ns)` Deprecated. From v1.7,0 replaced by `XMLSupport.transform(Message, String, String, String[][])` `SOAPSupport.transform(Message, String, String, String[][])` Transform the message payload by XSLT (without any parameters), assuming a non DOM result
`void`	`transform(Message msg, java.lang.String xsltFilename, java.lang.String exprn, java.lang.String[][] ns, boolean domResult, java.util.Map parameters)` Deprecated. From v1.7,0 replaced by `XMLSupport.transform(Message, String, String, String[][], boolean, java.util.Map)` or `SOAPSupport.transform(Message, String, String, String[][], boolean, java.util.Map)` Transform the message payload by XSLT
`void`	`validate(Message m, java.lang.String schema)` Deprecated. From v1.7,0 replaced by `SOAPSupport.validate(Message, String)` or `XMLSupport.validate(Message, String)` Validate the current message against one single schema
`void`	`validate(Message m, java.lang.String[] schemas)` Deprecated. From v1.7,0 replaced by `SOAPSupport.validate(Message, String[])` or `XMLSupport.validate(Message, String[])` Validate the current message against one or more schemas
`void`	`validate(Message m, java.lang.String[] schemas, java.lang.String exprn, java.lang.String[][] ns)` Deprecated. From v1.7,0 replaced by `SOAPSupport.validate(Message, String[], String, String[][])` or `XMLSupport.validate(Message, String[], String, String[][])` Validate the current message - or an element of it selected via an XPath expression - against one or more schemas

Method Detail

getConnection

java.sql.Connection getConnection(java.lang.String dataSource)

Get a database connection from the datasource defined in the [Spring] configuration with the given id

Parameters:: dataSource - the datasource id in the Spring configuration
Returns:: a database connection from the specified data source

getDataSource

javax.sql.DataSource getDataSource(java.lang.String dataSource)

Get the DataSource with the specified id from the [Spring] configuration

Parameters:: dataSource - the data source id
Returns:: the corresponding DataSource

readPayloadAsString

java.lang.String readPayloadAsString(Message m)

Return the current message payload as a String limited to 8K

Parameters:: m - the current message
Returns:: a String representation of the payload limited to 8K

setPayloadFromString

void setPayloadFromString(Message m,
                          java.lang.String text)

Set the payload of the current message to the given String

Parameters:: m - the current message; text - the text to which the payload should be set

setPayloadFromByteArray

void setPayloadFromByteArray(Message m,
                             byte[] bytes)

Set the payload of the current message to the byte array passed

Parameters:: m - the current message; bytes - the byte array to set as the current payload

setPayloadFromFile

void setPayloadFromFile(Message m,
                        java.lang.String filePath)

Set the current payload of the message as the content of the given file

Parameters:: m - current message; filePath - the path for the file to load

savePayloadToFile

void savePayloadToFile(Message m,
                       java.lang.String filePath)
                       throws java.io.IOException

Save the current message payload into the specified file

Parameters:: m - current message; filePath - file path to save to
Throws:: java.io.IOException - on IO exceptions

setPayloadToSOAP11Fault

@Deprecated
void setPayloadToSOAP11Fault(Message m,
                                        java.lang.String code,
                                        java.lang.String faultString,
                                        java.lang.String detail)

Deprecated. From v1.7,0 replaced by SOAPSupport.setPayloadToSOAP11Fault(Message, String, String, String) Set the payload of the current message to a SOAP 1.1 fault message with the given code, faultString and detail

Parameters:: m - the current message; code - Local Name of the fault code - See http://www.w3.org/TR/2000/NOTE-SOAP-20000508/#_Toc478383510 (null will default to "Server"); faultString - fault string, or null (defaults to "General Error"); detail - fault detail, or null (defaults to "Not available")

setPayloadToSOAP12Fault

@Deprecated
void setPayloadToSOAP12Fault(Message m,
                                        java.lang.String code,
                                        java.lang.String reason,
                                        java.lang.String detail)

Deprecated. From v1.7,0 replaced by SOAPSupport.setPayloadToSOAP12Fault(Message, String, String, String) Set the payload of the current message to a SOAP 1.2 fault message with the given code, reason and detail

Parameters:: m - the current message; code - Local Name of the fault code value - See http://www.w3.org/TR/soap12-part1/#faultcodes (null will default to "Receiver"); reason - fault reason, or null (defaults to "General Error" if null); detail - fault detail, or null (defaults to "Not available")

isSoap

@Deprecated
boolean isSoap(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.isSoap(Message) Check the message content type to see if it indicates a SOAP 1.1 or 1.2 message serialized as XML

Parameters:: msg - the message to detect
Returns:: true if either SOAP 1.1 or 1.2 is indicated

getSoapFaultCode

@Deprecated
java.lang.String getSoapFaultCode(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapFaultCode(Message) Extract the SOAP 1.1 Fault/faultcode or SOAP 1.2 Fault/Code/Value if exists

Parameters:: msg - the message to use
Returns:: the fault code if exists

getSoapFaultString

@Deprecated
java.lang.String getSoapFaultString(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapFaultString(Message) Extract the SOAP 1.1 Fault/faultstring or SOAP 1.2 Reason/Text if exists

Parameters:: msg - the message to use
Returns:: the fault code if exists

getSoapFaultDetail

@Deprecated
java.lang.String getSoapFaultDetail(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapFaultDetail(Message) Extract the SOAP 1.1 detail or SOAP 1.2 Detail if exists

Parameters:: msg - the message to use
Returns:: the fault code if exists

getSoapHeaderAsString

@Deprecated
java.lang.String getSoapHeaderAsString(Message msg,
                                                  java.lang.String namespace,
                                                  java.lang.String name)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapHeaderAsString(Message, String, String) Extract the SOAP 1.1/1.2 header value as a String

Parameters:: msg - the SOAP message; namespace - namespace of the header element; name - the name of the header element
Returns:: the String value of the header

getSoapHeadersAsStrings

@Deprecated
java.util.Map getSoapHeadersAsStrings(Message m)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapHeadersAsStrings(Message) Extract the SOAP 1.1/1.2 header values as a Strings

Parameters:: m - the SOAP message
Returns:: a Map of QNames and Strings of the text value

getSoapAddressingTo

@Deprecated
java.lang.String getSoapAddressingTo(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapAddressingTo(Message) Get the WSA To header

Parameters:: msg - message to extract the header from
Returns:: the header value

getSoapAction

@Deprecated
java.lang.String getSoapAction(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapAction(Message) Return the SOAPAction transport header

Parameters:: msg - message to extract the header from
Returns:: the SOAPAction transport header

getSoapAddressingAction

@Deprecated
java.lang.String getSoapAddressingAction(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapAddressingAction(Message) Get the WSA Action header

Parameters:: msg - message to extract the header from
Returns:: the header value

getSoapAddressingReplyTo

@Deprecated
java.lang.String getSoapAddressingReplyTo(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapAddressingReplyTo(Message) Get the WSA ReplyTo header

Parameters:: msg - message to extract the header from
Returns:: the header value

getSoapAddressingFaultTo

@Deprecated
java.lang.String getSoapAddressingFaultTo(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapAddressingFaultTo(Message) Get the WSA FaultTo header

Parameters:: msg - message to extract the header from
Returns:: the header value

getSoapAddressingFrom

@Deprecated
java.lang.String getSoapAddressingFrom(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapAddressingFrom(Message) Get the WSA From header

Parameters:: msg - message to extract the header from
Returns:: the header value

getSoapAddressingMessageID

@Deprecated
java.lang.String getSoapAddressingMessageID(Message msg)

Deprecated. From v1.7,0 replaced by SOAPSupport.getSoapAddressingMessageID(Message) Get the WSA MessageID header

Parameters:: msg - message to extract the header from
Returns:: the header value

isHessian

@Deprecated
boolean isHessian(Message msg)

Deprecated. From v1.7,0 replaced by HTTPSupport.isHessian(Message) Check the message content type to see if it indicates a Hessian message

Parameters:: msg - the message to detect
Returns:: true if a Hessian message is indicated

setCookie

@Deprecated
void setCookie(Message msg,
                          java.lang.String name,
                          java.lang.String value,
                          java.lang.String path,
                          java.lang.String domain,
                          int age,
                          boolean secure)

Deprecated. From v1.7,0 replaced by HTTPSupport.setCookie(Message, String, String, String, String, int, boolean) Set a HTTP cookie on the message

Parameters:: msg - the response message to set the cookie on; name - name of the cookie; value - value of the cookie; path - the path for the cookie; domain - the domain for the cookie; age - the max age for the cookie; secure - true if cookie is secure

setCookie

@Deprecated
void setCookie(Message msg,
                          java.lang.String name,
                          java.lang.String value,
                          java.lang.String path,
                          int age)

Deprecated. From v1.7,0 replaced by HTTPSupport.setCookie(Message, String, String, String, int) Set a HTTP cookie on the message

Parameters:: msg - the response message to set the cookie on; name - name of the cookie; value - value of the cookie; path - the path for the cookie; age - the max age for the cookie

setCookie

@Deprecated
void setCookie(Message msg,
                          java.lang.String name,
                          java.lang.String value)

Deprecated. From v1.7,0 replaced by HTTPSupport.setCookie(Message, String, String) Set a HTTP cookie on the message

Parameters:: msg - the response message to set the cookie on; name - name of the cookie; value - value of the cookie

getCookie

@Deprecated
java.lang.String getCookie(Message msg,
                                      java.lang.String name)

Deprecated. From v1.7,0 replaced by HTTPSupport.getCookie(Message, String) Return the value of the cookie with the given name

Parameters:: msg - message to extract cookie from; name - the name of the cookie
Returns:: the value of the cookie

sendResponse

void sendResponse(Message msg,
                  int code)

Trigger off sending the current payload as a synchronous response message for the currently processing message If the response for the message has already been submitted, any duplicates calls are silently ignored

Parameters:: msg - the message to be sent as the response; code - an optional transport level status code to set (e.g. SOAP faults usually are sent with an HTTP 500 error, but sometimes may be expected as a HTTP 200 response)

sendPart

void sendPart(Message msg,
              int code,
              int part,
              int size)

Send the current payload as one single part of the complete payload. This is currently only supported over HTTP/S (See sample #211 for a Json example)

Parameters:: msg - the current message to be sent as a part of the response. If this is the first part, this message dictates the headers etc for the response; code - the response code to use; part - the part number as "part i of n" ; with i = 1 for first and i = size for last; size - the total parts for the final message

sendResponseAndDrop

void sendResponseAndDrop(Message m,
                         int code)

Trigger off sending the current payload as a synchronous response message for the currently processing message, and stop processing this message thereafter. (e.g. do not send this message to any endpoints) If the response for the message has already been submitted, any duplicates calls are silently ignored

Parameters:: m - the message to be sent as the response; code - an optional transport level status code to set. (e.g. SOAP faults usually are sent with an HTTP 500 error, but sometimes may be expected as a HTTP 200 response)

dropMessage

void dropMessage(Message m)

Mark this message as a 'Dropped' message. Dropped messages are not sent to any endpoints following the in/out sequence

Parameters:: m - the message to be marked as a dropped message

convertFromFI

@Deprecated
void convertFromFI(Message m)

Deprecated. From v1.7,0 replaced by XMLSupport.convertFromFI(Message) or SOAPSupport.convertFromFI(Message) Convert the payload of the current message from a FastInfoset binary to an XML message (Note the XML payload is still kept as a RawFileMessage by default and maybe converted into a DOM message if required)

Parameters:: m - the current message to be transformed

convertToFI

@Deprecated
void convertToFI(Message m)

Deprecated. From v1.7,0 replaced by XMLSupport.convertToFI(Message) or SOAPSupport.convertToFI(Message) Convert the XML message into a FastInfoset binary message

Parameters:: m - the current message to be transformed

convertToDOM

@Deprecated
void convertToDOM(Message m)

Deprecated. From v1.7,0 replaced by XMLSupport.convertToDOM(Message) Convert the current message into a DOMMessage

Parameters:: m - the current message to be transformed

convertXMLToJSONStream

@Deprecated
void convertXMLToJSONStream(Message m)

Deprecated. From v1.7,0 replaced by XMLSupport.convertXMLToJSONStream(Message) or JSONSupport.convertXMLToJSONStream(Message) Convert the current XML message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream

Parameters:: m - the message to be converted

convertJSONToStream

@Deprecated
void convertJSONToStream(Message m,
                                    java.lang.Object o)

Deprecated. From v1.7,0 replaced by JSONSupport.convertJSONToStream(Message, Object) Convert an untyped Object (e.g. Map holding a JSON payload) to a streamed (file based) message

Parameters:: m - current message to hold final stream; o - untyped object to conver to JSON

convertSOAPToJSONStream

@Deprecated
void convertSOAPToJSONStream(Message m)

Deprecated. From v1.7,0 replaced by SOAPSupport.convertSOAPToJSONStream(Message) or JSONSupport.convertSOAPToJSONStream(Message) Convert the current SOAP message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream

Parameters:: m - the message to be converted

convertXMLToJSONStream

@Deprecated
void convertXMLToJSONStream(Message m,
                                       javax.xml.namespace.QName staringElement,
                                       boolean retainNSPrefixes)

Deprecated. From v1.7,0 replaced by XMLSupport.convertXMLToJSONStream(Message, javax.xml.namespace.QName, boolean) or JSONSupport.convertXMLToJSONStream(Message, javax.xml.namespace.QName, boolean) Convert the current XML message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream

Parameters:: m - the message to be converted; staringElement - an optional starting element to begin conversion (e.g. first element of the SOAP body); retainNSPrefixes - retain the namespace prefixes into JSON names for elements

convertSOAPToJSONStream

@Deprecated
void convertSOAPToJSONStream(Message m,
                                        javax.xml.namespace.QName staringElement,
                                        boolean retainNSPrefixes)

Deprecated. From v1.7,0 replaced by SOAPSupport.convertSOAPToJSONStream(Message, javax.xml.namespace.QName, boolean) or JSONSupport.convertSOAPToJSONStream(Message, javax.xml.namespace.QName, boolean) Convert the current SOAP message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream

Parameters:: m - the message to be converted; staringElement - an optional starting element to begin conversion (e.g. first element of the SOAP body); retainNSPrefixes - retain the namespace prefixes into JSON names for elements

convertToUntypedJSON

@Deprecated
java.util.Map convertToUntypedJSON(Message m)

Deprecated. From v1.7,0 replaced by JSONSupport.convertToUntypedJSON(Message) Convert the current message into an untyped JSON MapMessage

Parameters:: m - the current message to be transformed
Returns:: an untyped Map created using the Jackson JSON parser

convertToTypedJSON

@Deprecated
java.lang.Object convertToTypedJSON(Message m,
                                               java.lang.Class clazz)

Deprecated. From v1.7,0 replaced by JSONSupport.convertToTypedJSON(Message, Class) Convert the current message into a Typed JSON Object

Parameters:: m - the current message to be transformed; clazz - the class of the return message
Returns:: the Object instance of the JSON message

validate

@Deprecated
void validate(Message m,
                         java.lang.String[] schemas,
                         java.lang.String exprn,
                         java.lang.String[][] ns)

Deprecated. From v1.7,0 replaced by SOAPSupport.validate(Message, String[], String, String[][]) or XMLSupport.validate(Message, String[], String, String[][]) Validate the current message - or an element of it selected via an XPath expression - against one or more schemas

Parameters:: m - the message holding the payload for validation; schemas - an array of XSD filename to validate against. Note: the validator is sensitive to the order in which the Schemas are given. Otherwise you may end up with an error such as "SAXParseException: cvc-elt.1: Cannot find the declaration of element"; exprn - an optional XPath expression selecting the node for validation; ns - an optional array of namespace prefixes and namespaces used within the XPath expression

validate

@Deprecated
void validate(Message m,
                         java.lang.String[] schemas)

Deprecated. From v1.7,0 replaced by SOAPSupport.validate(Message, String[]) or XMLSupport.validate(Message, String[]) Validate the current message against one or more schemas

Parameters:: m - the message holding the payload for validation; schemas - an array of XSD filename to validate against Note: the validator is sensitive to the order in which the Schemas are given. Otherwise you may end up with an error such as "SAXParseException: cvc-elt.1: Cannot find the declaration of element"

validate

@Deprecated
void validate(Message m,
                         java.lang.String schema)

Deprecated. From v1.7,0 replaced by SOAPSupport.validate(Message, String) or XMLSupport.validate(Message, String) Validate the current message against one single schema

Parameters:: m - the message holding the payload for validation; schema - a XSD filename to validate against

filter

@Deprecated
boolean filter(Message m,
                          java.lang.String exprn,
                          java.lang.String[][] ns,
                          java.lang.String regex)

Deprecated. From v1.7,0 replaced by XMLSupport.filter(Message, String, String[][], String) or SOAPSupport.filter(Message, String, String[][], String) Evaluate the given XPath expression over the XML payload and compare the resulting String value with the regular expression for a match. This method converts the current payload into a DOMMessage

Parameters:: m - the current message; exprn - the XPath expression to evaluate against the message payload; ns - an optional array of namespace prefixes and namespace urls; regex - an optional regular expression to evaluate the XPath results' String value against
Returns:: true if the regular expression matches the String result of the XPath expression

filter

@Deprecated
boolean filter(Message m,
                          java.lang.String exprn,
                          java.lang.String[][] ns)

Deprecated. From v1.7,0 replaced by XMLSupport.filter(Message, String, String[][]) or SOAPSupport.filter(Message, String, String[][]) Evaluate the given boolean XPath expression over the XML payload

Parameters:: m - the current message; exprn - the XPath expression to evaluate against the message payload; ns - an optional array of namespace prefixes and namespace urls
Returns:: true if the XPath expression evaluates to true

remove

@Deprecated
boolean remove(Message m,
                          java.lang.String exprn,
                          java.lang.String[][] ns)

Deprecated. From v1.7,0 replaced by XMLSupport.remove(Message, String, String[][]) or SOAPSupport.remove(Message, String, String[][]) Remove the XPath expression specified node from the XML payload. This method converts the current payload of the message into a DOMMessage

Parameters:: m - the current message; exprn - the XPath expression to evaluate against the message payload; ns - an optional array of namespace prefixes and namespace urls
Returns:: true if the node was removed, false if not

extractAsStringUsingXPath

@Deprecated
java.lang.String extractAsStringUsingXPath(Message m,
                                                      java.lang.String exprn,
                                                      java.lang.String[][] ns)

Deprecated. From v1.7,0 replaced by XMLSupport.extractAsStringUsingXPath(Message, String, String[][]) or SOAPSupport.extractAsStringUsingXPath(Message, String, String[][]) Evaluate the given XPath expression against the XML payload, and return result as a String This method converts the current payload into a DOMMessage

Parameters:: m - the current message; exprn - the XPath expression to evaluate against the message payload; ns - an optional array of namespace prefixes and namespace urls
Returns:: the result of the XPath expression as a String, or null

extractAsNodeListUsingXPath

@Deprecated
org.w3c.dom.NodeList extractAsNodeListUsingXPath(Message m,
                                                            java.lang.String exprn,
                                                            java.lang.String[][] ns)

Deprecated. From v1.7,0 replaced by XMLSupport.extractAsNodeListUsingXPath(Message, String, String[][]) Evaluate the given XPath expression against the XML payload, and return result as a NodeList This method converts the current payload into a DOMMessage

Parameters:: m - the current message; exprn - the XPath expression to evaluate against the message payload; ns - an optional array of namespace prefixes and namespace urls
Returns:: the result of the XPath expression as a NodeList, or null

sendToEndpoint

void sendToEndpoint(Message m,
                    java.lang.String endpointName)

Send the current message to the endpoint with the given name. This stops the message from being processed by the default destination endpoint after the in/out sequence completes (i.e. marked as 'Dropped')

Parameters:: m - the current name; endpointName - the name of the endpoint to send

transform

@Deprecated
void transform(Message msg,
                          java.lang.String xsltFilename,
                          java.lang.String exprn,
                          java.lang.String[][] ns,
                          boolean domResult,
                          java.util.Map parameters)

Deprecated. From v1.7,0 replaced by XMLSupport.transform(Message, String, String, String[][], boolean, java.util.Map) or SOAPSupport.transform(Message, String, String, String[][], boolean, java.util.Map) Transform the message payload by XSLT

Parameters:: msg - current message; xsltFilename - the XSLT filename; exprn - an optional XPath expression to select the source node for XSLT, and node to replace with the result; ns - an optional array of namespace prefixes and namespace urls; domResult - is the result desired as a DOM payload? (useful for further XML processing); parameters - any XSLT parameters to be passed to the transformation

transform

@Deprecated
void transform(Message msg,
                          java.lang.String xsltFilename,
                          java.lang.String exprn,
                          java.lang.String[][] ns)

Deprecated. From v1.7,0 replaced by XMLSupport.transform(Message, String, String, String[][]) SOAPSupport.transform(Message, String, String, String[][]) Transform the message payload by XSLT (without any parameters), assuming a non DOM result

Parameters:: msg - current message; xsltFilename - the XSLT filename; exprn - an optional XPath expression to select the source node for XSLT, and node to replace with the result; ns - an optional array of namespace prefixes and namespace urls

transform

@Deprecated
void transform(Message msg,
                          java.lang.String xsltFilename)

Deprecated. From v1.7,0 replaced by XMLSupport.transform(Message, String) SOAPSupport.transform(Message, String) Transform the message payload by XSLT (without any parameters), assuming a non DOM result and assuming that the complete message payload will be used as the source of the transformation, and the result will replace the complete message payload

Parameters:: msg - current message; xsltFilename - the XSLT filename

retainElementAsPayload

@Deprecated
void retainElementAsPayload(Message m,
                                       java.lang.String exprn,
                                       java.lang.String[][] ns)

Deprecated. From v1.7,0 replaced by XMLSupport.retainElementAsPayload(Message, String, String[][]) Replace the current XML payload with the resulting element from the XPath expression result

Parameters:: m - the current message; exprn - XPath expression selecting the node to retain; ns - optional namespaces array

mergeXMLAttachmentsUnderElement

@Deprecated
void mergeXMLAttachmentsUnderElement(Message msg,
                                                java.lang.String rootElemName)

Deprecated. From v1.7,0 replaced by XMLSupport.mergeXMLAttachmentsUnderElement(Message, String) Replace the current XML payload with a top level element as specified, and merge the payloads from the current body, and attachments underneath that

Parameters:: msg - the message to transform; rootElemName - the new root element created

mergeXMLAttachmentsUnderElement

@Deprecated
void mergeXMLAttachmentsUnderElement(Message msg,
                                                java.lang.String rootElemName,
                                                java.lang.String rootNS)

Deprecated. From v1.7,0 replaced by XMLSupport.mergeXMLAttachmentsUnderElement(Message, String, String) Replace the current XML payload with a top level element as specified, and merge the payloads from the current body, and attachments underneath that

Parameters:: msg - the message to transform; rootElemName - the new root element created; rootNS - optional namespace for the root element, or null

addPreemptiveBasicAuthentication

@Deprecated
void addPreemptiveBasicAuthentication(Message msg,
                                                 java.lang.String username,
                                                 java.lang.String password,
                                                 java.lang.String charset,
                                                 boolean proxy)

Deprecated. From v1.7,0 replaced by HTTPSupport.addPreemptiveBasicAuthentication(Message, String, String, String, boolean) Adds an HTTP transport header for pre-emptive basic authentication for this message. Note: Pre-emptive basic authentication will perform better than basic authentication after an initial request fails with an HTTP 401 authentication required response. However, basic authentication will not be secure as digest authentication or other such mechanisms. It is reccomended that basic authentication if used, should be over an SSL secured connection - in which case the authentication security would be acceptable

Parameters:: msg - the message to add an HTTP 'Authorization' header for basic authentication; username - the username; password - the password; charset - the character set for the credentials; proxy - if header should be for proxy authentication or WWW authentication

addPreemptiveBasicAuthentication

@Deprecated
void addPreemptiveBasicAuthentication(Message msg,
                                                 java.lang.String username,
                                                 java.lang.String password)

Deprecated. From v1.7,0 replaced by HTTPSupport.addPreemptiveBasicAuthentication(Message, String, String) Adds an HTTP transport header for pre-emptive basic authentication for this message. Note: Pre-emptive basic authentication will perform better than basic authentication after an initial request fails with an HTTP 401 authentication required response. However, basic authentication will not be secure as digest authentication or other such mechanisms. It is reccomended that basic authentication if used, should be over an SSL secured connection - in which case the authentication security would be acceptable

Parameters:: msg - the message to add an HTTP 'Authorization' header for basic authentication; username - the username in US-ASCII character set; password - the password in US-ASCII character set

getJvmRoute

@Deprecated
java.lang.String getJvmRoute(Message msg)

Deprecated. From v1.7,0 replaced by HTTPSupport.getJvmRoute(Message) Return the jvmRoute from the JSESSIONID cookie or jsessionid URL parameter of an HTTP/S request

Parameters:: msg - the current message
Returns:: the Tomcat jvmRoute from the session

splitAndProcess

@Deprecated
void splitAndProcess(Message msg,
                                java.lang.String exprn,
                                java.lang.String[][] ns,
                                java.lang.String sequenceName,
                                boolean ignoreErrors)
                     throws java.lang.Exception

Deprecated. From v1.7,0 replaced by XMLSupport.splitAndProcess(Message, String, String[][], String, boolean) or SOAPSupport.splitAndProcess(Message, String, String[][], String, boolean) Split current message into multiple messages using the given XPath expression, and hand over each such message to the given sequence

Parameters:: msg - the current message to be split and processed; exprn - the XPath expression to split the message at; ns - name spaces used; sequenceName - the sequence to invoke on each resulting message; ignoreErrors - ignore any errors encountered during sequence execution
Throws:: java.lang.Exception - if the invoked sequence throws an exception

processBasicJSONDataServiceRequest

@Deprecated
void processBasicJSONDataServiceRequest(Message msg,
                                                   java.lang.String dataSvcBeanName,
                                                   java.lang.String dataSourceName)
                                        throws java.lang.Exception

Deprecated. From v1.7,0 replaced by JSONSupport.processBasicJSONDataServiceRequest(Message, String, String) Process request message as a basic JSON data service request. The response would be generated by executing the specified queries of the JSON Data Service bean definition

Parameters:: msg - the request message; dataSvcBeanName - the name of the bean defining the JSON data service; dataSourceName - the name of the data source bean
Throws:: java.lang.Exception - on an error

createDOMDocument

@Deprecated
org.w3c.dom.Document createDOMDocument()

Deprecated. From v1.7,0 replaced by XMLSupport.createDOMDocument() Create a new DOM Document object and return

Returns:: a new DOM Document

invokeSequence

void invokeSequence(Message msg,
                    java.lang.String sequenceName)
                    throws java.lang.Exception

Invoke another sequence from within a sequence

Parameters:: msg - the current message to be passed to the invoked sequence; sequenceName - the name of the invoked sequence
Throws:: java.lang.Exception - if the sequence logic raises an exception

isPermitted

@Deprecated
boolean isPermitted(java.lang.String xacmlBeanId,
                               Message msg)

Deprecated. From v1.7,0 replaced by XACMLSupport.isPermitted(String, Message) Is message allowed permission by the XACML processor bean selected. Automatically maps the following HTTP related transport properties to the specified attribute names action-id -> msg.getMessageProperty(HttpConstants.METHOD) subject-id -> msg.getMessageProperty(HttpConstants.USERNAME) role -> msg.getMessageProperty(HttpConstants.USERROLES) as a String[] client-dn -> msg.getMessageProperty(HttpConstants.SSL_CLIENT_DN) resource-id -> msg.getMessageProperty(HttpConstants.SERVICE_URL)

Parameters:: xacmlBeanId - the bean Id of the XACML Processor; msg - the current message
Returns:: true if message is allowed permission

isPermitted

@Deprecated
boolean isPermitted(java.lang.String xacmlBeanId,
                               java.util.Map custom)

Deprecated. From v1.7,0 replaced by XACMLSupport.isPermitted(String, java.util.Map) Is message allowed permission by the XACML processor bean selected.

Parameters:: xacmlBeanId - the bean Id of the XACML Processor; custom - a Map map of attribute values keyed as per the XACML Processor bean configuration
Returns:: true if message is allowed permission

isPermitted

@Deprecated
boolean isPermitted(java.lang.String xacmlBeanId,
                               java.lang.String issuer,
                               java.util.Map custom,
                               Message msg)

Deprecated. From v1.7,0 replaced by XACMLSupport.isPermitted(String, String, java.util.Map, Message) Is message allowed permission by the XACML processor bean selected.

Parameters:: xacmlBeanId - the bean Id of the XACML Processor; issuer - an optional issuer field, or null; custom - a Map map of attribute values keyed as per the XACML Processor bean configuration; msg - the current message to extract attribute values - if message properties are keyed as per the XACML Processor bean configuration
Returns:: true if message is allowed permission

getISO8601FormattedString

@Deprecated
java.lang.String getISO8601FormattedString(java.util.Date date)

Deprecated. From v1.7,0 replaced by DateSupport.getISO8601FormattedString(java.util.Date) Returns an ISO8601 compliant date string as yyyy-MM-dd

Parameters:: date - A java.util.Date object
Returns:: the formatted String as yyyy-MM-dd

getDateFromISO8601String

@Deprecated
java.util.Date getDateFromISO8601String(java.lang.String s)
                                        throws java.text.ParseException

Deprecated. From v1.7,0 replaced by DateSupport.getDateFromISO8601String(String) Returns a java.util.Date from an ISO8601 compliant date string yyyy-MM-dd

Parameters:: s - String formatted in yyyy-MM-dd
Returns:: date
Throws:: java.text.ParseException - if the date string is not parsable as ISO 8601

getSQLDateFromISO8601String

@Deprecated
java.sql.Date getSQLDateFromISO8601String(java.lang.String s)
                                          throws java.text.ParseException

Deprecated. From v1.7,0 replaced by DateSupport.getSQLDateFromISO8601String(String) Returns a java.sql.Date from an ISO8601 compliant date string yyyy-MM-dd

Parameters:: s - String formatted in yyyy-MM-dd
Returns:: date
Throws:: java.text.ParseException - if the date string is not parsable as ISO 8601

getUTFFormattedString

@Deprecated
java.lang.String getUTFFormattedString(java.util.Date date)

Deprecated. From v1.7,0 replaced by DateSupport.getUTFFormattedString(java.util.Date) Returns a UTC formatted date string as yyyy-MM-dd'T'HH:mm:ss'Z'

Parameters:: date - A java.util.Date object
Returns:: the formatted String as yyyy-MM-dd'T'HH:mm:ss'Z'

getDateFromUTCString

@Deprecated
java.util.Date getDateFromUTCString(java.lang.String s)
                                    throws java.text.ParseException

Deprecated. From v1.7,0 replaced by DateSupport.getDateFromUTCString(String) Returns a java.util.Date from a UTC date string of the form yyyy-MM-dd'T'HH:mm:ss'Z'

Parameters:: s - String formatted as yyyy-MM-dd'T'HH:mm:ss'Z'
Returns:: the extracted Date
Throws:: java.text.ParseException - if the date string is not parsable as ISO 8601

getSQLDateFromUTCString

@Deprecated
java.sql.Date getSQLDateFromUTCString(java.lang.String s)
                                      throws java.text.ParseException

Deprecated. From v1.7,0 replaced by DateSupport.getSQLDateFromUTCString(String) Returns a java.sql.Date from a UTC date string of the form yyyy-MM-dd'T'HH:mm:ss'Z'

Parameters:: s - String formatted as yyyy-MM-dd'T'HH:mm:ss'Z'
Returns:: the extracted Date
Throws:: java.text.ParseException - if the date string is not parsable as ISO 8601

getSpringBean

java.lang.Object getSpringBean(java.lang.String id)

Get the Spring bean with the given ID from the [Spring] configuration

Parameters:: id - the ID of the Spring bean to return
Returns:: the Spring bean with the given ID

getSpringBean

java.lang.Object getSpringBean(java.lang.String id,
                               java.lang.Class clazz)

Get the Spring bean with the given ID from the [Spring] configuration

Parameters:: id - the ID of the Spring bean to return; clazz - the class of the bean requested
Returns:: the Spring bean with the given ID

getDefaultPlatformTM

java.lang.String getDefaultPlatformTM()

Get the ID of the only PlatformTransactionManager defined into the configuration Only supported when only one transaction manager is defined

Returns:: the bean ID for the only PlatformTransactionManager instance defined in the configuration

getAS2Manager

AS2Manager getAS2Manager()

Get the AS2Manager from the bean with the id "as2Manager"

Returns:: the AS2Manager instance defined to the configuration as bean with id "as2Manager"

getAS2Manager

AS2Manager getAS2Manager(java.lang.String name)

Get the AS2Manager by the given name

Returns:: the AS2Manager instance defined to the configuration with the given name

getWSSecurityManager

WSSecurityManager getWSSecurityManager()

Get the WS-Security Manager defined with the id "wssecMgr"

Returns:: the WS-Security Manager instance defined to the configuration as bean with id "wssecMgr"

getLocalCache

@Deprecated
Cache getLocalCache()

Deprecated. From v1.7,0 replaced by CachingSupport.getLocalCache() Gets the Cache instance which is available locally in the node, and expires it's entries in a given time. It also has a time to live and nothing is guaranteed to be present in this cache. If you need your content to be present through out the session, use the Mediation.getLocalPermanentCache() to get the cache which will give you the permanent cache.

This cache overflows the content to disk in case of exceeding the in-memory cache size, which defaults to 10000 entries. How ever after storing another 1000 entries in the disk, the cache will permanently overflow, which sniffs something wrong in your mediation, as the content in this cache is automatically cleared in the expiration time.

Returns:: local cache with a expiration time for all the entries in it

getLocalPermanentCache

@Deprecated
Cache getLocalPermanentCache()

Deprecated. From v1.7,0 replaced by CachingSupport.getLocalPermanentCache() Gets the Cache instance which is available locally in the node, and keeps its contents in the cache within a session. The contents in this cache will never be expired but they are not persisted, so they will be lost at a System/JVM restart. If you want content to be available across JVM sessions, use Mediation.getLocalPersistentCache() instead.

You should be using this with care, as the content life cycle is not managed by the cache it is your responsibility to manage the cache content life cycle. Otherwise you might get into a resource exhaustion. This cache overflows the content to disk in case of exceeding the in-memory cache size, which defaults to 1000 entries, while there is no limit to the content which will be overflowed to disk

Returns:: local cache with a content life time which is equal to the session up time

getLocalPersistentCache

@Deprecated
Cache getLocalPersistentCache()

Deprecated. From v1.7,0 replaced by CachingSupport.getLocalPersistentCache() Gets the Cache instance which is available locally in the node, and keeps its contents in the cache forever across the sessions. In other words the content will be persisted to the disk.

Once again you should be extra careful about the usage, as the content will be there even after a system/JVM restart. It is possible to crash the disk space and the data persisted in the disk be lost and the cache is not handling that case as it really cannot do anything for the data corruption. This cache by default keeps only 100 entries in-memory and it off-loads the content to disk and loads the content from disk depending on the demand for those entries.

You could treat this as a NO-SQL persistent store, available locally in your node. If you want the content to be available among the cluster in the case of a clustered deployment, use the Mediation.getDistributedPersistentCache()

Returns:: local cache which persists the content into the disk

getDistributedCache

@Deprecated
Cache getDistributedCache()

Deprecated. From v1.7,0 replaced by CachingSupport.getDistributedCache() Applicable only when the clustering is enabled and deployed as a cluster. Characteristics of the cache returned by this method is equal to the cache that of Mediation.getLocalCache() but this replicates the content across the nodes in the cluster.

Not like the local equivalent to which you can put any thing, this only accepts Serializable content as both key and value of the entries in the cache. This is because the content you put has to be serialized as the cache needs to replicate the content using RMI.

If the node is starting up later in the cluster, (i.e. it joins a cluster with a state) the node bootstraps the cache content from one of its arbitrarily selected peers.

Returns:: distributed cache with a expiration time for all the entries in it

getDistributedPermanentCache

@Deprecated
Cache getDistributedPermanentCache()

Deprecated. From v1.7,0 replaced by CachingSupport.getDistributedPermanentCache() Applicable only when the clustering is enabled and deployed as a cluster. Characteristics of the cache returned by this method is equal to the cache that of Mediation.getLocalPermanentCache() but this replicates the content across the nodes in the cluster.

Not like the local equivalent to which you can put any thing, this only accepts Serializable content as both key and value of the entries in the cache. This is because the content you put has to be serialized as the cache needs to replicate the content using RMI.

You should take extra care about the content life cycle, as the cache doesn't expire the entries that you put. If the node is starting up later in the cluster, (i.e. it joins a cluster with a state) the node bootstraps the cache content from one of its arbitrarily selected peers. Because of the above bootstrap, not like in the local equivalent unless the complete cluster goes off the content will be preserved even on a System/JVM restart on a single node, as it will bootstrap it's cache content from a peer in the cluster.

Returns:: distributed cache with a content life time which is equal to the cluster up time

getDistributedPersistentCache

@Deprecated
Cache getDistributedPersistentCache()

Deprecated. From v1.7,0 replaced by CachingSupport.getDistributedPersistentCache() Applicable only when the clustering is enabled and deployed as a cluster. Characteristics of the cache returned by this method is equal to the cache that of Mediation.getLocalPersistentCache() but this replicates the content across the nodes in the cluster.

Not like the local equivalent to which you can put any thing, this only accepts Serializable content as both key and value of the entries in the cache. This is because the content you put has to be serialized as the cache needs to replicate the content using RMI.

Returns:: distributed cache which persists the content into the local disk

getThrottleSupport

ThrottleSupport getThrottleSupport(java.lang.String id)
                                   throws BusRuntimeException

Gives the implementation of the ThrottleSupport defined in the UltraESB configuration with the given bean identifier.

Usage of this ThrottleSupport is to provide the mediation logic development to use the throttling functionality as a condition.

For example if the throttling configuration is defined with myThrottleConfig the relevant mediation logic would be; if (mediation.getThrottleSupport("myThrottleConfig").isAllowed()) { ... throttle success ... } else { ... throttle hit failure ... }

Parameters:: id - bean identifier of the throttle implementation
Returns:: the defined throttle support with the given id, in the configuration
Throws:: BusRuntimeException - if the specified bean id is not referring to a ThrottleSupport

getXMLSupport

XMLSupport getXMLSupport()

Access DOM support API

Returns:: the DOM support for mediation

getSOAPSupport

SOAPSupport getSOAPSupport()

Access SOAP support API

Returns:: the SOAP support for mediation

getJSONSupport

JSONSupport getJSONSupport()

Access JSON support API

Returns:: the JSON support for mediation

getCachingSupport

CachingSupport getCachingSupport()

Access Caching support API

Returns:: the Caching support for mediation

getDateSupport

DateSupport getDateSupport()

Access Date support API

Returns:: the Date support for mediation

getHTTPSupport

HTTPSupport getHTTPSupport()

Access HTTP support API

Returns:: the HTTP support for mediation

getXACMLSupport

XACMLSupport getXACMLSupport()

Access XACML support API

Returns:: the XACML support for mediation

getProtocolBufferSupport

ProtocolBufferSupport getProtocolBufferSupport()

Access Protocol Buffer support API

Returns:: the Protocol Buffer support for mediation

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.adroitlogic.ultraesb.api Interface Mediation

getConnection

getDataSource

readPayloadAsString

setPayloadFromString

setPayloadFromByteArray

setPayloadFromFile

savePayloadToFile

setPayloadToSOAP11Fault

setPayloadToSOAP12Fault

isSoap

getSoapFaultCode

getSoapFaultString

getSoapFaultDetail

getSoapHeaderAsString

getSoapHeadersAsStrings

getSoapAddressingTo

getSoapAction

getSoapAddressingAction

getSoapAddressingReplyTo

getSoapAddressingFaultTo

getSoapAddressingFrom

getSoapAddressingMessageID

isHessian

setCookie

setCookie

setCookie

getCookie

sendResponse

sendPart

sendResponseAndDrop

dropMessage

convertFromFI

convertToFI

convertToDOM

convertXMLToJSONStream

convertJSONToStream

convertSOAPToJSONStream

convertXMLToJSONStream

convertSOAPToJSONStream

convertToUntypedJSON

convertToTypedJSON

validate

validate

validate

filter

filter

remove

extractAsStringUsingXPath

extractAsNodeListUsingXPath

sendToEndpoint

transform

transform

transform

retainElementAsPayload

mergeXMLAttachmentsUnderElement

mergeXMLAttachmentsUnderElement

addPreemptiveBasicAuthentication

addPreemptiveBasicAuthentication

getJvmRoute

splitAndProcess

processBasicJSONDataServiceRequest

createDOMDocument

invokeSequence

isPermitted

isPermitted

isPermitted

getISO8601FormattedString

getDateFromISO8601String

getSQLDateFromISO8601String

getUTFFormattedString

getDateFromUTCString

getSQLDateFromUTCString

getSpringBean

getSpringBean

getDefaultPlatformTM

getAS2Manager

getAS2Manager

getWSSecurityManager

getLocalCache

org.adroitlogic.ultraesb.api
Interface Mediation