org.sourceid.wstrust.plugin.process

Interface TokenProcessor<T extends org.sourceid.wstrust.model.SecurityToken>

Type Parameters:

T - Type of SecurityToken - must be org.sourceid.wstrust.model.BinarySecurityToken for custom token processor implementations.

All Superinterfaces:

ConfigurablePlugin, DescribablePlugin, Plugin

public interface TokenProcessor<T extends org.sourceid.wstrust.model.SecurityToken>
extends Plugin

A base interface for common methods across the token processors. This interface defines the method that the PingFederate server uses to discover metadata about a token processor implementation getPluginDescriptor(). It also defines the method that the PingFederate server calls to push administrator entered GUI configuration values into the token processor ConfigurablePlugin.configure(Configuration). Type <T> must be org.sourceid.wstrust.model.BinarySecurityToken for custom token processor implementations.

See Also:

TokenPluginDescriptor, SecurityToken

Method Summary

Modifier and Type	Method and Description
TokenPluginDescriptor	getPluginDescriptor() The PingFederate server will invoke this method on your token processor implementation to discover metadata about the implementation.
TokenContext	processToken(T token) This is the method that the PingFederate server will invoke when it consumes a token.

Methods inherited from interface com.pingidentity.sdk.ConfigurablePlugin

configure

Method Detail

processToken

TokenContext processToken(T token)
                   throws TokenProcessingException

This is the method that the PingFederate server will invoke when it consumes a token. The appropriate TokenProcessor instance will be invoked using the value from PluginDescriptor.getType() via getPluginDescriptor().

The returned TokenContext contains attributes resulting from token processing. At a minimum, TokenContext.getSubjectAttributes() should return a name/value pair denoting the 'subject' of the token being processed.

Parameters:

token -

Returns:

TokenContext

Throws:

TokenProcessingException

getPluginDescriptor

TokenPluginDescriptor getPluginDescriptor()

The PingFederate server will invoke this method on your token processor implementation to discover metadata about the implementation. This included the token processor's attribute contract and a description of what configuration fields to render in the GUI.

Your implementation of this method should return the same TokenPluginDescriptor object from call to call - behaviour of the system is undefined if this convention is not followed.

Specified by:

getPluginDescriptor in interface DescribablePlugin

Returns:

a TokenPluginDescriptor object that describes this token processor implementation.