AuthenticationSelector
interface instead.@Deprecated public interface AdapterSelector extends Plugin
See ConfigurablePlugin
for methods that need to be implemented to facilitate communication of
configuration information with the PingFederate server.
If your implementation of this method needs to operate asynchronously, it just needs to write to the
HttpServletResponse as appropriate and commit it. Right after invoking this method the PingFederate server
checks to see if the response has been committed. If the response has been committed, PingFederate saves
the state it needs and discontinues processing for the current transaction. Processing of the transaction is
continued when the user agent returns to the resumePath
at the PingFederate server at which
point the server invokes this method again. This series of events will be repeated until this method
returns without committing the response. When that happens (which could be the first invocation) PingFederate
will complete the protocol transaction processing with the return result of this method.
Modifier and Type | Field and Description |
---|---|
static String |
AUTHN_REQ_DOC_PARAM_NAME
Deprecated.
Use this value as a key in the map
extraParameters to access the AuthnRequestDocument of the SP-initiated
SSO request. |
static String |
EXTRA_PARAM_NAME_ORIGINAL_REQUEST_URI
Deprecated.
The parameter name in the extraParameters map for the original request URI, before redirection(during a async call).
|
static String |
EXTRA_PARAM_NAME_SCOPE
Deprecated.
The parameter name in the extraParameters map for the OAuth scope.
|
static String |
EXTRA_PARAMETER_NAME_AUTHN_POLICY
Deprecated.
The parameter name in the extraParameters map for the
AuthnPolicy |
static String |
EXTRA_PARAMETER_NAME_ENTITY_ID
Deprecated.
The parameter name in the extraParameters map for the entity id of the SP connection, if applicable.
|
static String |
EXTRA_PARAMETER_NAME_INSTANCE_ID
Deprecated.
The input parameter name for adapter selector instance id in extraParameters map.
|
Modifier and Type | Method and Description |
---|---|
void |
callback(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
Map authnIdentifiers,
String adapterInstanceId,
AdapterSelectorContext adapterSelectorContext)
Deprecated.
This is the method that the PingFederate server will invoke after the selected adapter completes the lookupAuthN(...) method.
|
AdapterSelectorContext |
selectContext(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
Map<String,String> mappedAdapterIdsNames,
Map<String,Object> extraParameters,
String resumePath)
Deprecated.
This is the method that the PingFederate server will invoke during Adapter Selection.
|
configure
getPluginDescriptor
static final String AUTHN_REQ_DOC_PARAM_NAME
extraParameters
to access the AuthnRequestDocument of the SP-initiated
SSO request.static final String EXTRA_PARAMETER_NAME_INSTANCE_ID
static final String EXTRA_PARAMETER_NAME_ENTITY_ID
static final String EXTRA_PARAMETER_NAME_AUTHN_POLICY
AuthnPolicy
static final String EXTRA_PARAM_NAME_SCOPE
static final String EXTRA_PARAM_NAME_ORIGINAL_REQUEST_URI
AdapterSelectorContext selectContext(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, Map<String,String> mappedAdapterIdsNames, Map<String,Object> extraParameters, String resumePath)
req
- the HttpServletRequest can be used to read cookies, parameters, headers, etc. It can also be used
to find out more about the request like the full URL the request was made to. Accessing the HttpSession from
the request is not recommended and doing so is deprecated. Use
SessionStateSupport
as an alternative.resp
- the HttpServletResponse.mappedAdapterIdsNames
- the map of name value pairs containing the mapped adapter information for the respective connection.extraParameters
- the map of extra object data used for facilitating specific adapter selection implementations. The
values found in this collection are stored in keys AUTHN_REQ_DOC_PARAM_NAME
and
AdapterSelector
.EXTRA_PARAMETER_*.resumePath
- the relative URL that the user agent needs to return to, if the implementation of this method
invocation needs to operate asynchronously. If this method operates synchronously, this parameter can
be ignored. The resumePath is the full path portion of the URL - everything after hostname and port. If
the hostname, port, or protocol are needed, they can be derived using the HttpServletRequest.void callback(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, Map authnIdentifiers, String adapterInstanceId, AdapterSelectorContext adapterSelectorContext)
req
- the HttpServletRequest can be used to read cookies, parameters, headers, etc. Accessing the HttpSession from
the request is not recommended and doing so is deprecated. Use
SessionStateSupport
as an alternative.resp
- the HttpServletResponse can be used to set cookies before continuing the SSO request.authnIdentifiers
- the map of attribute values resulting from the completion of the lookupAuthN(...) method of the selected adapter.adapterInstanceId
- the ID of the selected adapter.adapterSelectorContext
- the resulting context of the Adapter Selection selectContext(...) method.IdpAuthenticationAdapterV2
,
IdpAuthenticationAdapter
Copyright 2019 Ping Identity Corp. All rights reserved.