org.sourceid.wstrust.plugin.generate

Interface TokenGenerator

All Superinterfaces:

ConfigurablePlugin, DescribablePlugin, Plugin

public interface TokenGenerator
extends Plugin

A base interface for common methods across the token generators. This interface defines the method that the PingFederate server uses to discover metadata about a token processor implementation DescribablePlugin.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). For custom token generator implementations, a org.sourceid.wstrust.model.BinarySecurityToken should be returned.

See Also:

TokenPluginDescriptor, SecurityToken

Method Summary

Modifier and Type	Method and Description
org.sourceid.wstrust.model.SecurityToken	generateToken(TokenContext attributeContext) This is the method that the PingFederate server will invoke when constructing a new token.

Methods inherited from interface com.pingidentity.sdk.ConfigurablePlugin

configure

Methods inherited from interface com.pingidentity.sdk.DescribablePlugin

getPluginDescriptor

Method Detail

generateToken

org.sourceid.wstrust.model.SecurityToken generateToken(TokenContext attributeContext)
                                                throws TokenProcessingException

This is the method that the PingFederate server will invoke when constructing a new token. The appropriate token generator instance will be invoked using the value from PluginDescriptor.getType() via DescribablePlugin.getPluginDescriptor().

Parameters:

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

Returns:

SecurityToken as a BinarySecurityToken instance

Throws:

TokenProcessingException