Interface RestTokenTransformValidator<T>
-
@SupportedAll public interface RestTokenTransformValidator<T>
Defines the contract for token validators deployed in the context of token transformation. The generic type T corresponds to the type of the to-be-validated token. These types are currently limited to: 1. java.security.cert.X509Certificate[] 2. the classes in the org.forgerock.openam.sts.token.model package of the openam-sts-client package: RestUsernameToken, OpenAMSessionToken, OpenIdConnectIdToken. 3. JsonValue, which is the type common to all custom token validators.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.forgerock.openam.sts.rest.token.validator.RestTokenTransformValidatorResult
validateToken(RestTokenTransformValidatorParameters<T> restTokenTransformValidatorParameters)
Validates the token supplied in the providedRestTokenTransformValidatorParameters
-
-
-
Method Detail
-
validateToken
org.forgerock.openam.sts.rest.token.validator.RestTokenTransformValidatorResult validateToken(RestTokenTransformValidatorParameters<T> restTokenTransformValidatorParameters) throws TokenValidationException
Validates the token supplied in the providedRestTokenTransformValidatorParameters
- Parameters:
restTokenTransformValidatorParameters
- The token validation parameters which provide access to the to-be-validated token- Returns:
- The RestTokenTransformValidatorResult encapsulating the Principal and OpenAM session id corresponding to a successfully-validated token
- Throws:
TokenValidationException
- If the token could not be successfully validated.
-
-