Skip navigation links

oracle.security.jps.service.idm.collector
Interface TokenCollector

public interface TokenCollector

User must implement this interface for any custom collection machanism implementation.

Method Summary

void	fail(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, int reason) This method will be called when the required token is not found in the HttpRequest object while accessing the getToken method.
IdentityToken	getToken(java.lang.String tokenType, javax.servlet.http.HttpServletRequest request, java.util.List tokenNames, java.util.Properties properties) This method will be called by OC4J with an appropriate token type, request object and properties This method will create the appropriate token and return to the OC4J.

Method Detail

getToken

IdentityToken getToken(java.lang.String tokenType,
                       javax.servlet.http.HttpServletRequest request,
                       java.util.List tokenNames,
                       java.util.Properties properties)
                       throws CollectorException,
                              TokenNotFoundException

This method will be called by OC4J with an appropriate token type, request object and properties This method will create the appropriate token and return to the OC4J.

Parameters:

tokenType - Valid token types are COOKIE_TOKEN, HEADER_TOKEN, REQUEST_TOKEN or CUSTOM_TOKEN

request - The HTTP Servlet Request Object

tokenNames - This is the list of all the header token names configured in the config file

properties - This is the list of custom properties defined in the config file

Returns:

IdentityToken

Throws:

CollectorException

TokenNotFoundException

fail

void fail(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response,
          int reason)
          throws CollectorException

This method will be called when the required token is not found in the HttpRequest object while accessing the getToken method. The concrete class must implement this method

Parameters:

request - The OC4J Http servlet request object

response - The OC4J Http response object

reason - The reason for failure. One of the IdmAuthenticator values.

Throws:

CollectorException

Skip navigation links