Package org.frankframework.http.rest

Class ApiListenerServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.frankframework.http.AbstractHttpServlet

org.frankframework.http.rest.ApiListenerServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, DynamicRegistration, DynamicRegistration.Servlet

@IbisInitializer
public class ApiListenerServlet
extends AbstractHttpServlet

Author:

Niels Meijer

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.frankframework.lifecycle.DynamicRegistration

DynamicRegistration.Servlet, DynamicRegistration.ServletWithParameters

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHENTICATION_COOKIE_NAME
static final String	UPDATE_ETAG_CONTEXT_KEY

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Fields inherited from interface org.frankframework.lifecycle.DynamicRegistration

ALL_IBIS_ROLES, ALL_IBIS_USER_ROLES, IBIS_FULL_SERVICE_ACCESS_ROLES

Constructor Summary

Constructors

Constructor	Description
ApiListenerServlet()

Method Summary

Modifier and Type	Method	Description
void	destroy()
String	getUrlMapping()	Tomcat matches /api to /api/*.
void	init()
void	returnJson(jakarta.servlet.http.HttpServletResponse response, int status, jakarta.json.JsonObject json)
protected void	service(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

Methods inherited from class org.frankframework.http.AbstractHttpServlet

getAccessGrantingRoles, getName

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPatch, doPost, doPut, doTrace, getLastModified, init, isSensitiveHeader, service

Methods inherited from class jakarta.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.frankframework.lifecycle.DynamicRegistration

loadOnStartUp

Methods inherited from interface org.frankframework.lifecycle.DynamicRegistration.Servlet

isEnabled

Methods inherited from interface jakarta.servlet.Servlet

getServletConfig, getServletInfo, init, service

Field Details

AUTHENTICATION_COOKIE_NAME

public static final String AUTHENTICATION_COOKIE_NAME

See Also:

• Constant Field Values

UPDATE_ETAG_CONTEXT_KEY

public static final String UPDATE_ETAG_CONTEXT_KEY

See Also:

• Constant Field Values

Constructor Details

ApiListenerServlet

public ApiListenerServlet()

Method Details

init

public void init()
          throws jakarta.servlet.ServletException

Overrides:

init in class jakarta.servlet.GenericServlet

Throws:

jakarta.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Servlet

Overrides:

destroy in class jakarta.servlet.GenericServlet

returnJson

public void returnJson(jakarta.servlet.http.HttpServletResponse response,
 int status,
 jakarta.json.JsonObject json)
                throws IOException

Throws:

IOException

service

protected void service(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                throws IOException

Overrides:

service in class jakarta.servlet.http.HttpServlet

Throws:

IOException

getUrlMapping

public String getUrlMapping()

Tomcat matches /api to /api/*. Not every application server does this. In order to both fix Authentication request matching and the different Application Servers matching on different methods, explicitly add `/api`.