Package net.ltgt.oidc.servlet

Class CallbackServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

net.ltgt.oidc.servlet.CallbackServlet

All Implemented Interfaces:

Servlet, ServletConfig, Serializable

public class CallbackServlet
extends HttpServlet

Implements the OpenID Connect Redirect URI for the authorization code flow.

A Configuration instance must have been added as a ServletContext attribute under the name Configuration.CONTEXT_ATTRIBUTE_NAME.

If a HTTPRequestSender instance has been added as ServletContext attribute under the name Utils.HTTP_REQUEST_SENDER_CONTEXT_ATTRIBUTE_NAME, it'll be used to send requests to the OpenID Provider.

Authentication state must have been put in the session by an AuthenticationRedirector (generally through the LoginServlet or an authorization filter).

After validating the request, and if authentication was successful, the user will be redirected to the page stored in the authentication state.

If a UserPrincipalFactory is available in the ServletContext, it'll be called to possibly load additional data to the session, that can later be made available through the UserPrincipal.

See Also:

• OpenID Connect Core 1.0
• Serialized Form

Field Summary

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
CallbackServlet()
CallbackServlet(Configuration configuration, UserPrincipalFactory userPrincipalFactory)	Constructs a servlet with the given configuration and UserPrincipal factory, and no HTTP request sender.
CallbackServlet(Configuration configuration, UserPrincipalFactory userPrincipalFactory, @Nullable HTTPRequestSender httpRequestSender)	Constructs a servlet with the given configuration and UserPrincipal factory.

Method Summary

Modifier and Type	Method	Description
protected void	doGet(HttpServletRequest req, HttpServletResponse resp)
protected void	doPost(HttpServletRequest req, HttpServletResponse resp)
void	init()
protected void	sendError(HttpServletResponse resp, int statusCode, String message, @Nullable Throwable cause)

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, init, service, 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

Constructor Details

CallbackServlet

public CallbackServlet()

CallbackServlet

public CallbackServlet(Configuration configuration,
 UserPrincipalFactory userPrincipalFactory)

Constructs a servlet with the given configuration and UserPrincipal factory, and no HTTP request sender.

When this constructor is used, the servlet context attributes won't be read.

This is equivalent to new CallbackServlet(configuration, userPrincipalFactory, null).

CallbackServlet

public CallbackServlet(Configuration configuration,
 UserPrincipalFactory userPrincipalFactory,
 @Nullable HTTPRequestSender httpRequestSender)

Constructs a servlet with the given configuration and UserPrincipal factory.

When this constructor is used, the servlet context attributes won't be read.

Method Details

init

@OverridingMethodsMustInvokeSuper
public void init()
          throws ServletException

Overrides:

init in class GenericServlet

Throws:

ServletException

doGet

protected void doGet(HttpServletRequest req,
 HttpServletResponse resp)
              throws ServletException,
IOException

Overrides:

doGet in class HttpServlet

Throws:

ServletException

IOException

doPost

protected void doPost(HttpServletRequest req,
 HttpServletResponse resp)
               throws ServletException,
IOException

Overrides:

doPost in class HttpServlet

Throws:

ServletException

IOException

sendError

@ForOverride
protected void sendError(HttpServletResponse resp,
 int statusCode,
 String message,
 @Nullable Throwable cause)
                  throws IOException,
ServletException

Throws:

IOException

ServletException