TokenIssuerModule (Oracle Fusion Middleware Java API Reference for Oracle Access Management Security Token Service)

Class

Tree

Help

Oracle Fusion Middleware Java API Reference for Oracle Access Management Security Token Service
11g Release 2 (11.1.2)
E27138-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.security.fed.sts.token.tpe
Interface TokenIssuerModule

public interface TokenIssuerModule

This interface contains methods for custom token issuance. In order to support issuance of a custom token an implementation of this interface should be provided and registered with OSTS.

Method Summary
`void`	`init(java.util.Map options)` This method is called when the issuer module is initialized.
`TokenResult`	`issue(TokenContext context)` This method is called by OSTS when a custom token needs to be issued.

Method Detail

init

void init(java.util.Map options)
          throws TokenProcessingException

This method is called when the issuer module is initialized.

Parameters:: options, - a map containing issuance template properties.
Throws:: TokenProcessingException, - when there is an error during processing; TokenProcessingException

issue

TokenResult issue(TokenContext context)
                  throws TokenProcessingException

This method is called by OSTS when a custom token needs to be issued.

Parameters:: context - a TokenContext object containing parameters like token attributes that can be used during issuance.
Returns:: a TokenResult object containing the custom token being issued
Throws:: TokenProcessingException, - when there is an error during processing; TokenProcessingException

Package