public class DefaultSOAPAPICallHandler extends Object implements APICallPreHandler
DefaultSOAPAPICallHandler acts as a basic SOAP
APICallPreHandler. The interface method returns defaults for HTTP
headers which may be an empty Map. If SOAP:HEADERS are added as
headerString property and Namespace (to be added to SOAP:ENVELOPE) as
namespace property then DefaultSOAPAPICallHandler returns a String for
getPayLoad method that includes place-holders in the form {i} where i = 0, 1,
2.. that can be used by any upper level classes to replace them with
appropriate values.| Modifier and Type | Class and Description |
|---|---|
static interface |
DefaultSOAPAPICallHandler.XmlNamespaceProvider
XML Namespace provider for SOAP serialization
|
| Constructor and Description |
|---|
DefaultSOAPAPICallHandler(String rawPayLoad,
String namespaces,
String headerString)
Deprecated.
|
DefaultSOAPAPICallHandler(String rawPayLoad,
String namespaces,
String headerString,
Map<String,String> configurationMap)
DefaultSOAPAPICallHandler acts as the base SOAPAPICallHandler.
|
DefaultSOAPAPICallHandler(XMLMessageSerializer soapBodyContent,
BaseAPIContext baseAPIContext,
Map<String,String> configurationMap,
String methodName)
DefaultSOAPAPICallHandler taking
XMLMessageSerializer instance for SOAP Body part. |
| Modifier and Type | Method and Description |
|---|---|
ICredential |
getCredential()
Returns
ICredential configured for the api call |
String |
getEndPoint()
Returns the endpoint for the API call.
|
Map<String,String> |
getHeaderMap()
Returns headers for HTTP call
|
String |
getHeaderString() |
String |
getNamespaces() |
String |
getPayLoad()
Returns the payload for the API call.
|
void |
setHeaderString(String headerString) |
void |
setNamespaces(String namespaces) |
static void |
setXmlNamespaceProvider(DefaultSOAPAPICallHandler.XmlNamespaceProvider xmlNamespaceProvider)
Sets an implemenation of
XMLMessageSerializer |
void |
validate()
Validates settings and integrity before call
|
public DefaultSOAPAPICallHandler(String rawPayLoad, String namespaces, String headerString)
rawPayLoad - Raw SOAP payload that goes into SOAP:BODYnamespaces - Namespace attributes that should be appended to SOAP:ENVELOPE,
this argument can take any valid String value, empty String or
NULL. If the value is NULL {0} value is sandwiched between
SOAP:HEADER element that can be used for decorating purposeheaderString - SOAP header String that should be appended to SOAP:HEADER,
this argument can take any valid String value, empty String or
NULL. If the value is NULL {1} value is sandwiched between
SOAP:HEADER element that can be used for decorating purposepublic DefaultSOAPAPICallHandler(String rawPayLoad, String namespaces, String headerString, Map<String,String> configurationMap)
rawPayLoad - Raw SOAP payload that goes into SOAP:BODYnamespaces - Namespace attributes that should be appended to SOAP:ENVELOPE,
this argument can take any valid String value, empty String or
NULL. If the value is NULL, {0} value is added to
SOAP:ENVELOPE (ex: headerString - SOAP header String that should be appended to SOAP:HEADER,
this argument can take any valid String value, empty String or
NULL. If the value is NULL, {1} is placed between SOAP:HEADER
(ex: configurationMap - Map used for Dynamic configuration, mandatory
parameterpublic DefaultSOAPAPICallHandler(XMLMessageSerializer soapBodyContent, BaseAPIContext baseAPIContext, Map<String,String> configurationMap, String methodName)
DefaultSOAPAPICallHandler taking
XMLMessageSerializer instance for SOAP Body part. SOAP Header
part is set in BaseAPIContext as Application Header property (The
Application Header should be an instance of XMLMessageSerializer
). Dynamic configuration can be set using the configurationMap property
of BaseAPIContext which will take higher precedence than the one
set in the Service level. ConfigurationMap is treated as a mandatory
parameter picked either from BaseAPIContext
configurationMap parameter or configurationMap argument in that order of precedence.soapBodyContent - SOAP Body SerializerbaseAPIContext - BaseAPIContext instanceconfigurationMap - ConfigurationMap used for Dynamic configurationmethodName - SOAP API operation namepublic static void setXmlNamespaceProvider(DefaultSOAPAPICallHandler.XmlNamespaceProvider xmlNamespaceProvider)
XMLMessageSerializerxmlNamespaceProvider - public String getHeaderString()
public void setHeaderString(String headerString)
headerString - the headerString to setpublic String getNamespaces()
public void setNamespaces(String namespaces)
namespaces - the namespaces to setpublic Map<String,String> getHeaderMap()
APICallPreHandlergetHeaderMap in interface APICallPreHandlerpublic String getPayLoad()
APICallPreHandlergetPayLoad in interface APICallPreHandlerpublic String getEndPoint()
APICallPreHandlerConstants)are taken to be default for the API call.getEndPoint in interface APICallPreHandlerpublic ICredential getCredential()
APICallPreHandlerICredential configured for the api callgetCredential in interface APICallPreHandlerpublic void validate()
throws ClientActionRequiredException
APICallPreHandlervalidate in interface APICallPreHandlerClientActionRequiredExceptionCopyright © 2016. All Rights Reserved.