Package org.nuxeo.ecm.tokenauth.servlet

Class TokenAuthenticationServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.nuxeo.ecm.tokenauth.servlet.TokenAuthenticationServlet

All Implemented Interfaces:

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

public class TokenAuthenticationServlet
extends jakarta.servlet.http.HttpServlet

Servlet that allows to get a unique authentication token given the request Principal and some device information passed as request parameters: application name, device id, device description, permission. An error response will be sent with a 400 status code if one of the required parameters is null or empty. All parameters are required except for the device description.

The token is provided by the TokenAuthenticationService.

Since:

5.7

Author:

Antoine Taillefer ([email protected])

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_NAME_PARAM
static final String	DEVICE_DESCRIPTION_PARAM
static final String	DEVICE_ID_PARAM
static final String	PERMISSION_PARAM
static final String	REVOKE_PARAM
static final String	TOKEN_AUTH_PLUGIN_NAME

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
TokenAuthenticationServlet()

Method Summary

Modifier and Type	Method	Description
void	doGet(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp)
protected void	sendTextResponse(jakarta.servlet.http.HttpServletResponse resp, String textResponse, int statusCode)

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, init, service, service

Methods inherited from class jakarta.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Details

TOKEN_AUTH_PLUGIN_NAME

public static final String TOKEN_AUTH_PLUGIN_NAME

See Also:

• Constant Field Values

APPLICATION_NAME_PARAM

public static final String APPLICATION_NAME_PARAM

See Also:

• Constant Field Values

DEVICE_ID_PARAM

public static final String DEVICE_ID_PARAM

See Also:

• Constant Field Values

DEVICE_DESCRIPTION_PARAM

public static final String DEVICE_DESCRIPTION_PARAM

See Also:

• Constant Field Values

PERMISSION_PARAM

public static final String PERMISSION_PARAM

See Also:

• Constant Field Values

REVOKE_PARAM

public static final String REVOKE_PARAM

See Also:

• Constant Field Values

Constructor Details

TokenAuthenticationServlet

public TokenAuthenticationServlet()

Method Details

doGet

public void doGet(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse resp)
           throws jakarta.servlet.ServletException,
IOException

Overrides:

doGet in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

sendTextResponse

protected void sendTextResponse(jakarta.servlet.http.HttpServletResponse resp,
 String textResponse,
 int statusCode)
                         throws IOException

Throws:

IOException