TokenValidatorModule (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 TokenValidatorModule

public interface TokenValidatorModule

This interface contains methods for custom token validation. In order to support validation of an incoming 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 validator module is initialized.
`TokenResult`	`validate(TokenContext context)` This method is called by OSTS when a custom token needs to be validated.

Method Detail

init

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

This method is called when the validator module is initialized.

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

validate

TokenResult validate(TokenContext context)
                     throws TokenProcessingException

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

Parameters:: context - a TokenContext object containing parameters like the token xml.
Returns:: a TokenResult object containing the result of the validation operation
Throws:: TokenProcessingException, - when there is an error during processing; TokenProcessingException

Package