Skip navigation links

oracle.security.jazn.collector.oc4j
Class TokenCollectorImpl

java.lang.Object
oracle.security.jazn.collector.oc4j.TokenCollectorImpl

All Implemented Interfaces:

TokenCollector

public abstract class TokenCollectorImpl

extends java.lang.Object

implements TokenCollector

This is an abstract class of Token Collector. It provides the most basic implementation of the token collector interface. The abstract method(s) must be implemented by the concrete class. Based on the token type passed, it will return the appropriate token to OC4J.

Constructor Summary

TokenCollectorImpl()

Method Summary

abstract 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenCollectorImpl

public TokenCollectorImpl()

Method Detail

getToken

public 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.

Specified by:

getToken in interface TokenCollector

Parameters:

tokenType - Valid token types are HTTP_COOKIE, HTTP_HEADER or HTTP_REQUEST

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

public abstract 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

Specified by:

fail in interface TokenCollector

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