nl.nn.adapterframework.http.rest

Class ApiListener

java.lang.Object

nl.nn.adapterframework.http.PushingListenerAdapter

nl.nn.adapterframework.http.rest.ApiListener

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IListener<Message>, INamedObject, IPushingListener<Message>, IScopeProvider, ReceiverAware<String>, ServiceClient, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ApiListener
extends PushingListenerAdapter
implements HasPhysicalDestination, ReceiverAware<String>

Listener that allows a Receiver to receive messages as a REST webservice. Prepends the configured URI pattern with api/. The structure of REST messages is described by OpenAPI specifications. The Frank!Framework generates an OpenAPI specification for each ApiListener and also an OpenAPI specification for all ApiListeners in all configurations. You can find them in the Frank!Console under main menu item Webservices, heading Available ApiListeners. The generated OpenAPI specifications have servers and paths objects and therefore they document the full URLs of the provided services.

Author:

Niels Meijer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiListener.AuthenticationMethods
static class	ApiListener.HttpMethod

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
ApiListener()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(String acceptHeader) Match request 'Accept' header to produces enum to see if the client accepts the message
void	close() Close all resources used for listening.
void	configure() initialize listener and register this to the JNDI
List<String>	getAuthenticationRoleList()
String	getCleanPattern() returns the clear pattern, replaces everything between {} to *
String	getMultipartBodyName()
boolean	isConsumable(String contentType) Match request 'Content-Type' (eg.
void	open() Prepares the listener for receiving messages.
Message	processRequest(Message message, PipeLineSession session) Method to implement for processing a request.
void	setAuthenticationMethod(ApiListener.AuthenticationMethods authenticationMethod) Enables security for this listener.
void	setAuthenticationRoles(String authRoles) Only active when AuthenticationMethod=AUTHROLE.
void	setCharacterEncoding(String charset) The specified character encoding on the response contentType header.
void	setConsumes(MediaTypes value) The required contentType on requests, if it doesn't match the request will fail
void	setContentDispositionHeaderSessionKey(String key) Session key that provides the Content-Disposition header in the response
void	setCorrelationIdHeader(String correlationIdHeader) Name of the header which contains the Correlation-Id.
void	setExactMatchClaims(String string) Comma separated key value pairs to match with JWT payload.
void	setHeaderParams(String headerParams) Comma separated list of parameters passed as http header.
void	setJwksURL(String string) Keysource URL to validate JWT
void	setJwtHeader(String string) Header to extract JWT from
void	setMessageIdHeader(String messageIdHeader) Name of the header which contains the Message-Id.
void	setMethod(ApiListener.HttpMethod method) HTTP method to listen to
void	setMultipartBodyName(String multipartBodyName) Specify the form-part you wish to enter the pipeline
void	setOperationId(String operationId) Unique string used to identify the operation.
void	setPrincipalNameClaim(String principalNameClaim) Claim name which specifies the principal name (maps to GetPrincipalPipe)
void	setProduces(MediaTypes value) The specified contentType on response.
void	setRequiredClaims(String string) Comma separated list of required claims
void	setRequiredIssuer(String issuer) Issuer to validate JWT
void	setRoleClaim(String roleClaim) Claim name which specifies the role
void	setUpdateEtag(boolean updateEtag) Automatically generate and validate etags
void	setUriPattern(String uriPattern) URI pattern to register this listener on, eq.
String	toString()

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

afterMessageProcessed, extractMessage, setApplicationFaultsAsExceptions, setExceptionListener, setHandler, setName, setRunning, wrapRawMessage

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, getPhysicalDestinationName

Methods inherited from interface nl.nn.adapterframework.receivers.ReceiverAware

getReceiver, setReceiver

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

ApiListener

public ApiListener()

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 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

Description copied from interface: ServiceClient

Method to implement for processing a request. This will usually delegate to a IListener implementation.
TODO: We may want to add the correlationId parameter back to this method, for cleaner calling and cleaner implementation.

Specified by:

processRequest in interface ServiceClient

Overrides:

processRequest in class PushingListenerAdapter

Parameters:

message - Message to process

session - PipeLineSession of the request. If the request has a correlation ID, it should be put into this session.

Returns:

Resulting Message.

Throws:

ListenerException - Thrown if an exception occurs.

getCleanPattern

public String getCleanPattern()

returns the clear pattern, replaces everything between {} to *

Returns:

null if no pattern is found

isConsumable

public boolean isConsumable(@Nullable
                            String contentType)

Match request 'Content-Type' (eg. on POST) to consumes enum to see if the listener accepts the message

accepts

public boolean accepts(@Nullable
                       String acceptHeader)

Match request 'Accept' header to produces enum to see if the client accepts the message

setMethod

public void setMethod(ApiListener.HttpMethod method)

HTTP method to listen to

Default value

GET

setUriPattern

public void setUriPattern(String uriPattern)

URI pattern to register this listener on, eq. `/my-listener/{something}/here`

setConsumes

public void setConsumes(@Nonnull
                        MediaTypes value)

The required contentType on requests, if it doesn't match the request will fail

Default value

ANY

setProduces

public void setProduces(@Nonnull
                        MediaTypes value)

The specified contentType on response. When ANY the response will determine the content type based on the return data.

Default value

ANY

setCharacterEncoding

public void setCharacterEncoding(String charset)

The specified character encoding on the response contentType header. NULL or empty values will be ignored.

Default value

UTF-8

setUpdateEtag

public void setUpdateEtag(boolean updateEtag)

Automatically generate and validate etags

Default value

false, can be changed by setting the property api.etag.enabled.

setAuthenticationMethod

public void setAuthenticationMethod(ApiListener.AuthenticationMethods authenticationMethod)

Enables security for this listener. If you wish to use the application servers authorisation roles [AUTHROLE], you need to enable them globally for all ApiListeners with the `servlet.ApiListenerServlet.securityRoles=IbisTester,IbisWebService` property

Default value

NONE

setAuthenticationRoles

public void setAuthenticationRoles(String authRoles)

Only active when AuthenticationMethod=AUTHROLE. Comma separated list of authorization roles which are granted for this service, eq. IbisTester,IbisObserver", ""})

getAuthenticationRoleList

public List<String> getAuthenticationRoleList()

setMultipartBodyName

public void setMultipartBodyName(String multipartBodyName)

Specify the form-part you wish to enter the pipeline

Default value

name of the first form-part

getMultipartBodyName

public String getMultipartBodyName()

setMessageIdHeader

@Default(value="Message-Id")
public void setMessageIdHeader(String messageIdHeader)

Name of the header which contains the Message-Id.

setCorrelationIdHeader

@Default(value="Correlation-Id")
public void setCorrelationIdHeader(String correlationIdHeader)

Name of the header which contains the Correlation-Id.

setOperationId

public void setOperationId(String operationId)

Unique string used to identify the operation. The id MUST be unique among all operations described in the OpenApi schema.

setHeaderParams

public void setHeaderParams(String headerParams)

Comma separated list of parameters passed as http header. Parameters will be stored in 'headers' sessionkey.

setContentDispositionHeaderSessionKey

public void setContentDispositionHeaderSessionKey(String key)

Session key that provides the Content-Disposition header in the response

setRequiredIssuer

public void setRequiredIssuer(String issuer)

Issuer to validate JWT

setJwksURL

public void setJwksURL(String string)

Keysource URL to validate JWT

setJwtHeader

public void setJwtHeader(String string)

Header to extract JWT from

setRequiredClaims

public void setRequiredClaims(String string)

Comma separated list of required claims

setExactMatchClaims

public void setExactMatchClaims(String string)

Comma separated key value pairs to match with JWT payload. e.g. "sub=UnitTest, aud=test"

setRoleClaim

public void setRoleClaim(String roleClaim)

Claim name which specifies the role

setPrincipalNameClaim

public void setPrincipalNameClaim(String principalNameClaim)

Claim name which specifies the principal name (maps to GetPrincipalPipe)

toString

public String toString()

Overrides:

toString in class PushingListenerAdapter