Package org.oa4mp.server.proxy

Class ProxyCallbackServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

edu.uiuc.ncsa.security.servlet.AbstractServlet

org.oa4mp.server.api.storage.servlet.EnvServlet

org.oa4mp.server.api.storage.servlet.OA4MPServlet

org.oa4mp.server.api.storage.servlet.AbstractAuthenticationServlet

org.oa4mp.server.proxy.OA2AuthenticationServer

org.oa4mp.server.proxy.ProxyCallbackServlet

All Implemented Interfaces:

edu.uiuc.ncsa.security.core.Logable, edu.uiuc.ncsa.security.servlet.Presentable, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, TransactionFilter

public class ProxyCallbackServlet
extends OA2AuthenticationServer

Created by Jeff Gaynor
on 3/3/22 at 4:33 PM

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.oa4mp.server.api.storage.servlet.AbstractAuthenticationServlet

AbstractAuthenticationServlet.AuthorizedState, AbstractAuthenticationServlet.MyHttpServletResponseWrapper, AbstractAuthenticationServlet.UserLoginException

Field Summary

Fields inherited from class org.oa4mp.server.api.storage.servlet.AbstractAuthenticationServlet

AUTHORIZATION_ACTION_DF_CONSENT_VALUE, AUTHORIZATION_ACTION_DONE, AUTHORIZATION_ACTION_DONE_VALUE, AUTHORIZATION_ACTION_KEY, AUTHORIZATION_ACTION_OK, AUTHORIZATION_ACTION_OK_VALUE, AUTHORIZATION_ACTION_PROXY_DF_CONSENT, AUTHORIZATION_ACTION_START, AUTHORIZATION_GRANT_KEY, AUTHORIZATION_PASSWORD_KEY, AUTHORIZATION_STATE_KEY, AUTHORIZATION_USER_NAME_KEY, AUTHORIZATION_USER_NAME_VALUE, DF_USER_CODE_KEY, ERROR_PAGE, INITIAL_PAGE, OK_PAGE, PROXY_KEY, REMOTE_USER_INITIAL_PAGE, RESPONSE_TYPE_DF_VALUE, RESPONSE_TYPE_KEY, RESPONSE_TYPE_TOKEN_VALUE, RETRY_MESSAGE, TOKEN_KEY_KEY

Fields inherited from class org.oa4mp.server.api.storage.servlet.OA4MPServlet

caThread, kpt, lastAccessedThread, transactionCleanup

Fields inherited from class org.oa4mp.server.api.storage.servlet.EnvServlet

ERROR_NOTIFICATION_BODY_KEY, ERROR_NOTIFICATION_SUBJECT_KEY, notificationListeners, storeUpdatesDone

Fields inherited from class edu.uiuc.ncsa.security.servlet.AbstractServlet

environment, initialization, IP_HEADERS, PING_PARAMETER

Constructor Summary

Constructors

Constructor	Description
ProxyCallbackServlet()

Method Summary

Modifier and Type	Method	Description
protected void	doIt(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Processes the callback from the proxy.
protected String	setClientConsentAttributes(OA2ServiceTransaction t, String contextPath)	Set the parameters for the local consent page.
protected void	setClientConsentAttributesOLD(javax.servlet.http.HttpServletRequest request, OA2ServiceTransaction t)
ServiceTransaction	verifyAndGet(IssuerResponse iResponse)	This is called after the response is received so that the system can get the approproate transaction.

Methods inherited from class org.oa4mp.server.proxy.OA2AuthenticationServer

createCallback, createRedirect, createRedirectInit, doProxy, getInitUtil, prepare, scopesToString, scopesToString, setClientRequestAttributes

Methods inherited from class org.oa4mp.server.api.storage.servlet.AbstractAuthenticationServlet

checkUser, getAndCheckTransaction, getInitialPage, getOkPage, getParam, getRemoteUserInitialPage, getState, handleError, present

Methods inherited from class org.oa4mp.server.api.storage.servlet.OA4MPServlet

checkAdminClientStatus, checkClientApproval, createDebugger, destroy, findSigningKey, getAGI, getATI, getClient, getClient, getClient, getFirstParameters, getFirstParameterValue, getGrantIDFromRequest, getServiceEnvironment, getTransaction, getTransactionByGrantID, getTransactionStore, isEmpty, loadProperties2, newTransaction, postprocess, preprocess, realStoreUpdates, say, shutdownCleanup, storeUpdates

Methods inherited from class org.oa4mp.server.api.storage.servlet.EnvServlet

addNotificationListener, checkCancel, checkCancel, isCancelled, loadEnvironment, processStoreCheck, removeNotificationListener

Methods inherited from class edu.uiuc.ncsa.security.servlet.AbstractServlet

checkContentType, CONST, debug, doGet, doPing, doPost, error, error, getConfigurationLoader, getEnvironment, getExceptionHandler, getInitialization, getMyLogger, getRequestIPAddress, handleException, info, init, isDebugOn, logOK, logOK, printAllParameters, printAllParameters, resetState, setConfigurationLoader, setDebugOn, setEnvironment, setExceptionHandler, setInitialization, warn

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

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

Constructor Detail

ProxyCallbackServlet

public ProxyCallbackServlet()

Method Detail

verifyAndGet

public ServiceTransaction verifyAndGet(IssuerResponse iResponse)
                                throws IOException

Description copied from class: OA4MPServlet

This is called after the response is received so that the system can get the approproate transaction. Checks for the validity of the transaction should be done here too.

Overrides:

verifyAndGet in class AbstractAuthenticationServlet

Returns:

Throws:

IOException

doIt

protected void doIt(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws Throwable

Processes the callback from the proxy. This will take the proxy's callback and transform it into the correct transaction at our end, then get the access token from the proxy.
The access token also includes the user's meta data (such as subject) and the is used to populate the username in the server. When this is done, the server is ready to do its callback.

Overrides:

doIt in class OA2AuthenticationServer

Parameters:

request -

response -

Throws:

Throwable

setClientConsentAttributes

protected String setClientConsentAttributes(OA2ServiceTransaction t,
                                            String contextPath)

Set the parameters for the local consent page. These must be passed as parameters for the redirect, which is a new HTTP request hence can have no state.

Parameters:

t -

contextPath -

Returns:

setClientConsentAttributesOLD

protected void setClientConsentAttributesOLD(javax.servlet.http.HttpServletRequest request,
                                             OA2ServiceTransaction t)