Package org.frankframework.http

Class RestListenerServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.frankframework.http.AbstractHttpServlet

org.frankframework.http.RestListenerServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

RestPublicListenerServlet

@IbisInitializer
public class RestListenerServlet
extends AbstractHttpServlet

Servlet that listens for REST requests, and handles them over to the RestServiceDispatcher.

Author:

Gerrit van Brakel

See Also:

• Serialized Form

Nested Class Summary

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

DynamicRegistration.Servlet, DynamicRegistration.ServletWithParameters

Field Summary

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
RestListenerServlet()

Method Summary

Modifier and Type	Method	Description
String[]	getAccessGrantingRoles()	The default authorization roles giving access to the Servlet, or null to disable.
String	getUrlMapping()	The URL the Servlet should be mapped to.
void	init()
protected void	service(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

Methods inherited from class org.frankframework.http.AbstractHttpServlet

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

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

destroy, getServletConfig, getServletInfo, init, service

Constructor Details

RestListenerServlet

public RestListenerServlet()

Method Details

init

public void init()
          throws jakarta.servlet.ServletException

Overrides:

init in class jakarta.servlet.GenericServlet

Throws:

jakarta.servlet.ServletException

service

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

Overrides:

service in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

getUrlMapping

public String getUrlMapping()

Description copied from interface: DynamicRegistration.Servlet

The URL the Servlet should be mapped to. This value may be overridden by setting property servlet.servlet-name.urlMapping to change path the servlet listens to

getAccessGrantingRoles

public String[] getAccessGrantingRoles()

Description copied from interface: DynamicRegistration.Servlet

The default authorization roles giving access to the Servlet, or null to disable. This value may be overridden by setting property servlet.servlet-name.securityRoles to the roles that should be granted access. see ServletManager for more information.

Specified by:

getAccessGrantingRoles in interface DynamicRegistration.Servlet

Overrides:

getAccessGrantingRoles in class AbstractHttpServlet