com.atlassian.asap.service.api

Interface ValidationResult

public interface ValidationResult

The result from evaluating an Authorization header against a TokenValidator.

Since:

2.8

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ValidationResult.Decision The overall decision as to whether or not the request has satisfied the validator's requirements.

Method Summary

Modifier and Type	Method and Description
ValidationResult.Decision	decision() The overall decision as to whether or not the Authorization header has satisfied the validator's requirements.
Optional<Jwt>	token() The token, if any, that was used to authorize this request.
Optional<String>	untrustedIssuer() The issuer, if any, that provided a token to the request.

Method Detail

decision

ValidationResult.Decision decision()

The overall decision as to whether or not the Authorization header has satisfied the validator's requirements.

Returns:

the decision as to whether or not the request is authorized

token

Optional<Jwt> token()

The token, if any, that was used to authorize this request.

Note: The value will only be present when decision() is ValidationResult.Decision.AUTHORIZED.

Returns:

the token, if any, that was used to satisfy the authorization requirements

untrustedIssuer

Optional<String> untrustedIssuer()

The issuer, if any, that provided a token to the request.

WARNING: This is the issuer that the token claimed to be from, but since the token has been rejected, this information MUST NOT be trusted. It is provided for information / logging purposes, only.

Returns:

the issuer, if any, that an untrusted token claimed as its issuer