RestListener (Ibis AdapterFramework parent 7.9-20230330.214747 API)

java.lang.Object
- nl.nn.adapterframework.http.PushingListenerAdapter
- - nl.nn.adapterframework.http.RestListener

All Implemented Interfaces:

HasSpecialDefaultValues, HasPhysicalDestination, IConfigurable, IConfigurationAware, IListener<Message>, INamedObject, IPushingListener<Message>, IScopeProvider, ServiceClient, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
```
public class RestListener
extends PushingListenerAdapter
implements HasPhysicalDestination, HasSpecialDefaultValues
```
Listener that allows a Receiver to receive messages as a REST webservice. Prepends the configured URI pattern with rest/. When you are writing a new Frank config, you are recommended to use an ApiListener instead. You can find all serviced URI patterns in the Frank!Console: main menu item Webservice, heading Available REST Services.
Note: Servlets' multipart configuration expects a Content-Type of multipart/form-data (see http://docs.oracle.com/javaee/6/api/javax/servlet/annotation/MultipartConfig.html). So do not use other multipart content types like multipart/related

Author:

Niels Meijer, Gerrit van Brakel

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RestListener.MediaTypes

Nested Classes
Modifier and Type	Class and Description
`static class`	`RestListener.MediaTypes`

Field Summary
- Fields inherited from class nl.nn.adapterframework.http.PushingListenerAdapter
  log

Constructor Summary

Constructors
Constructor and Description

RestListener()

Constructors
Constructor and Description
`RestListener()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getPhysicalDestinationName()`
`String`	`getRestUriPattern()`
`Object`	`getSpecialDefaultValue(String attributeName, Object defaultValue, Map<String,String> attributes)`
`boolean`	`isView()`
`void`	`open()` Prepares the listener for receiving messages.
`Message`	`processRequest(Message message, PipeLineSession session)`
`void`	`setAuthRoles(String string)` Comma separated list of authorization roles which are granted for this rest service
`void`	`setConsumes(RestListener.MediaTypes consumes)` Mediatype (e.g.
`void`	`setContentTypeSessionKey(String contentTypeSessionKey)` Key of Session variable that determines requested content type, overrides `produces`
`void`	`setEtagSessionKey(String etagSessionKey)` Key of session variable to store etag
`void`	`setGenerateEtag(boolean b)` If set to true the ibis will automatically create an etag
`void`	`setMethod(String method)` Method (e.g.
`void`	`setProduces(RestListener.MediaTypes produces)` Mediatype (e.g.
`void`	`setRestPath(String restPath)`
`void`	`setRetrieveMultipart(boolean b)` Indicates whether the parts of a multipart entity should be retrieved and put in session keys.
`void`	`setUriPattern(String uriPattern)` Uri pattern to match, the {uri} part in https://mydomain.com/ibis4something/rest/{uri}, where mydomain.com and ibis4something refer to 'your ibis'.
`void`	`setValidateEtag(boolean b)` If set to true the ibis will automatically validate and process etags
`void`	`setView(boolean b)` Indicates whether this listener supports a view (and a link should be put in the ibis console)
`void`	`setWriteSecLogMessage(boolean b)`
`void`	`setWriteToSecLog(boolean b)`
`Message`	`transformToJson(Message message)`
`Message`	`transformToXml(Message message)`

Methods inherited from class nl.nn.adapterframework.http.PushingListenerAdapter
afterMessageProcessed, extractMessage, getIdFromRawMessage, setApplicationFaultsAsExceptions, setExceptionListener, setHandler, setName, setRunning, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination
getDomain

Methods inherited from interface nl.nn.adapterframework.core.INamedObject
getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware
getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider
getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware
setApplicationContext

- Constructor Detail
  - RestListener
```
public RestListener()
```
- Method Detail
  - configure
```
public void configure()
               throws ConfigurationException
```
    initialize listener and register this to the JNDI
    
    Specified by:
    
    configure in interface IConfigurable
    
    Specified by:
    
    configure in interface IListener<Message>
    
    Overrides:
    
    configure in class PushingListenerAdapter
    
    Throws:
    
    ConfigurationException
  - open
```
public void open()
          throws ListenerException
```
    Description copied from interface: IListener
    
    Prepares the listener for receiving messages. open() is called once each time the listener is started.
    
    Specified by:
    
    open in interface IListener<Message>
    
    Overrides:
    
    open in class PushingListenerAdapter
    
    Throws:
    
    ListenerException
  - close
```
public void close()
```
    Description copied from interface: IListener
    
    Close all resources used for listening. Called once once each time the listener is stopped.
    
    Specified by:
    
    close in interface IListener<Message>
    
    Overrides:
    
    close in class PushingListenerAdapter
  - processRequest
```
public Message processRequest(Message message,
                              PipeLineSession session)
                       throws ListenerException
```
    Specified by:
    
    processRequest in interface ServiceClient
    
    Overrides:
    
    processRequest in class PushingListenerAdapter
    
    Throws:
    
    ListenerException
  - transformToJson
```
public Message transformToJson(Message message)
                        throws PipeRunException
```
    Throws:
    
    PipeRunException
  - transformToXml
```
public Message transformToXml(Message message)
                       throws PipeRunException
```
    Throws:
    
    PipeRunException
  - getSpecialDefaultValue
```
public Object getSpecialDefaultValue(String attributeName,
                                     Object defaultValue,
                                     Map<String,String> attributes)
```
    Specified by:
    
    getSpecialDefaultValue in interface HasSpecialDefaultValues
  - getPhysicalDestinationName
```
public String getPhysicalDestinationName()
```
    Specified by:
    
    getPhysicalDestinationName in interface HasPhysicalDestination
  - getRestUriPattern
```
public String getRestUriPattern()
```
  - setUriPattern
```
public void setUriPattern(String uriPattern)
```
    Uri pattern to match, the {uri} part in https://mydomain.com/ibis4something/rest/{uri}, where mydomain.com and ibis4something refer to 'your ibis'.
  - setMethod
```
public void setMethod(String method)
```
    Method (e.g. GET or POST) to match
  - setEtagSessionKey
```
public void setEtagSessionKey(String etagSessionKey)
```
    Key of session variable to store etag
  - setContentTypeSessionKey
```
public void setContentTypeSessionKey(String contentTypeSessionKey)
```
    Key of Session variable that determines requested content type, overrides produces
  - setRestPath
```
public void setRestPath(String restPath)
```
  - setView
```
public void setView(boolean b)
```
    Indicates whether this listener supports a view (and a link should be put in the ibis console)
    
    Default value
    
    if method=get then true, else false
  - isView
```
public boolean isView()
```
  - setAuthRoles
```
public void setAuthRoles(String string)
```
    Comma separated list of authorization roles which are granted for this rest service
    
    Default value
    
    IbisAdmin,IbisDataAdmin,IbisTester,IbisObserver,IbisWebService
  - setWriteToSecLog
```
public void setWriteToSecLog(boolean b)
```
  - setWriteSecLogMessage
```
public void setWriteSecLogMessage(boolean b)
```
  - setRetrieveMultipart
```
public void setRetrieveMultipart(boolean b)
```
    Indicates whether the parts of a multipart entity should be retrieved and put in session keys. This can only be done once!
    
    Default value
    
    true
  - setConsumes
```
public void setConsumes(RestListener.MediaTypes consumes)
```
    Mediatype (e.g. XML, JSON, TEXT) the RestServiceDispatcher receives as input
    
    Default value
    
    XML
  - setProduces
```
public void setProduces(RestListener.MediaTypes produces)
```
    Mediatype (e.g. XML, JSON, TEXT) the RestServiceDispatcher sends as output, if set to json the ibis will automatically try to convert the xml message
    
    Default value
    
    XML
  - setValidateEtag
```
public void setValidateEtag(boolean b)
```
    If set to true the ibis will automatically validate and process etags
    
    Default value
    
    false
  - setGenerateEtag
```
public void setGenerateEtag(boolean b)
```
    If set to true the ibis will automatically create an etag
    
    Default value
    
    false

Class RestListener

Nested Class Summary

Field Summary

Fields inherited from class nl.nn.adapterframework.http.PushingListenerAdapter

Constructor Summary

Method Summary

Methods inherited from class nl.nn.adapterframework.http.PushingListenerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

Methods inherited from interface org.springframework.context.ApplicationContextAware

Constructor Detail

RestListener

Method Detail

configure

open

close

processRequest

transformToJson

transformToXml

getSpecialDefaultValue

getPhysicalDestinationName

getRestUriPattern

setUriPattern

setMethod

setEtagSessionKey

setContentTypeSessionKey

setRestPath

setView

isView

setAuthRoles

setWriteToSecLog

setWriteSecLogMessage

setRetrieveMultipart

setConsumes

setProduces

setValidateEtag

setGenerateEtag