public class WebServiceListener extends PushingListenerAdapter implements HasPhysicalDestination, HasSpecialDefaultValues
Receiver
to receive messages as a SOAP webservice.
The structure of the SOAP messages is expressed in a WSDL (Web Services Description Language) document.
The Frank!Framework generates a WSDL document for each adapter that contains WebServiceListeners. You can
find these documents in the Frank!Console under main menu item Webservices, heading Available WSDL's.
The WSDL documents that we generate document how the SOAP services can be accessed. In particular, the
URL of a SOAP service can be found in an XML element <soap:address>
with
soap
pointing to namespace http://schemas.xmlsoap.org/wsdl/soap/
.
address
is set, then for each request:log
Constructor and Description |
---|
WebServiceListener() |
Modifier and Type | Method and Description |
---|---|
void |
close()
Close all resources used for listening.
|
void |
configure()
initialize listener and register
this to the JNDI |
String |
getLogPrefix() |
String |
getPhysicalDestinationName() |
Object |
getSpecialDefaultValue(String attributeName,
Object defaultValue,
Map<String,String> attributes) |
void |
open()
Prepares the listener for receiving messages.
|
Message |
processRequest(Message message,
PipeLineSession session)
Method to implement for processing a request.
|
void |
setAddress(String address)
The address to listen to, e.g the part <address> in https://mydomain.com/ibis4something/services/<address>,
where mydomain.com and ibis4something refer to 'your ibis'.
|
void |
setApplicationFaultsAsSoapFaults(boolean b) |
void |
setAttachmentSessionKeys(String attachmentSessionKeys)
Comma separated list of session keys to hold contents of attachments of the request
|
void |
setMtomEnabled(boolean mtomEnabled)
If set, MTOM is enabled on the SOAP binding
|
void |
setMultipartXmlSessionKey(String multipartXmlSessionKey)
Key of session variable that holds the description (name, sessionKey, mimeType) of the parts present in the request.
|
void |
setServiceNamespaceURI(String string)
Namespace of the service that is provided by the adapter of this listener.
|
void |
setSoap(boolean b)
If
true the SOAP envelope is removed from received messages and a SOAP envelope is added to returned messages (SOAP envelope will not be visible to the pipeline) |
afterMessageProcessed, extractMessage, setApplicationFaultsAsExceptions, setExceptionListener, setHandler, setName, setRunning, toString, wrapRawMessage
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getDomain
getName
getApplicationContext, getName
getConfigurationClassLoader
public void configure() throws ConfigurationException
this
to the JNDIconfigure
in interface IConfigurable
configure
in interface IListener<Message>
configure
in class PushingListenerAdapter
ConfigurationException
public void open() throws ListenerException
IListener
open()
is called once each time the listener is started.open
in interface IListener<Message>
open
in class PushingListenerAdapter
ListenerException
public void close()
IListener
close
in interface IListener<Message>
close
in class PushingListenerAdapter
public Message processRequest(Message message, PipeLineSession session) throws ListenerException
ServiceClient
IListener
implementation.
processRequest
in interface ServiceClient
processRequest
in class PushingListenerAdapter
message
- Message
to processsession
- PipeLineSession
of the request. If the request has a correlation ID, it should be put into this session.Message
.ListenerException
- Thrown if an exception occurs.public String getLogPrefix()
public String getPhysicalDestinationName()
getPhysicalDestinationName
in interface HasPhysicalDestination
public void setSoap(boolean b)
true
the SOAP envelope is removed from received messages and a SOAP envelope is added to returned messages (SOAP envelope will not be visible to the pipeline)public void setServiceNamespaceURI(String string)
public void setApplicationFaultsAsSoapFaults(boolean b)
public void setAddress(String address)
public void setMtomEnabled(boolean mtomEnabled)
public void setAttachmentSessionKeys(String attachmentSessionKeys)
public void setMultipartXmlSessionKey(String multipartXmlSessionKey)
public Object getSpecialDefaultValue(String attributeName, Object defaultValue, Map<String,String> attributes)
getSpecialDefaultValue
in interface HasSpecialDefaultValues
Copyright © 2023 Frank!Framework. All rights reserved.