com.atlassian.asap.service.core.impl

Class AbstractTokenValidator

java.lang.Object

com.atlassian.asap.service.core.impl.AbstractTokenValidator

All Implemented Interfaces:

TokenValidator

Direct Known Subclasses:

TokenValidatorImpl

public abstract class AbstractTokenValidator
extends Object
implements TokenValidator

Implements the builder logic for a token validator.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.asap.service.api.TokenValidator

TokenValidator.Policy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTokenValidator(AsapConfiguration config)

Method Summary

Modifier and Type	Method and Description
protected Set<String>	acceptableAudienceValues()
TokenValidator	audience(Iterable<String> additionalAudienceValues) As for TokenValidator.audience(String...).
protected Set<String>	authorizedIssuers()
protected Set<String>	authorizedSubjects()
protected Set<String>	impersonationAuthorizedIssuers()
TokenValidator	impersonationIssuer(Iterable<String> impersonationIssuers) As for TokenValidator.impersonationIssuer(String...).
TokenValidator	issuer(Iterable<String> authorizedIssuers) As for TokenValidator.issuer(String...).
protected TokenValidator.Policy	policy()
TokenValidator	policy(TokenValidator.Policy policy) Specifies the validation policy for this validator.
TokenValidator	subject(Iterable<String> authorizedSubjects) As for TokenValidator.subject(String...).
protected boolean	subjectImpersonation()
TokenValidator	subjectImpersonation(boolean subjectImpersonation) Deprecated. move/copy issuers that are allowed to impersonate users from the 'issuer' to the 'impersonationIssuer' list
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.asap.service.api.TokenValidator

audience, impersonationIssuer, issuer, subject, validate

Constructor Detail

AbstractTokenValidator

protected AbstractTokenValidator(AsapConfiguration config)

Method Detail

issuer

public TokenValidator issuer(Iterable<String> authorizedIssuers)

Description copied from interface: TokenValidator

As for TokenValidator.issuer(String...).

Specified by:

issuer in interface TokenValidator

Parameters:

authorizedIssuers - as for TokenValidator.issuer(String...)

Returns:

this

impersonationIssuer

public TokenValidator impersonationIssuer(Iterable<String> impersonationIssuers)

Description copied from interface: TokenValidator

As for TokenValidator.impersonationIssuer(String...).

Specified by:

impersonationIssuer in interface TokenValidator

Parameters:

impersonationIssuers - as for TokenValidator.impersonationIssuer(String...)

Returns:

this

subjectImpersonation

@Deprecated
public TokenValidator subjectImpersonation(boolean subjectImpersonation)

Deprecated. move/copy issuers that are allowed to impersonate users from the 'issuer' to the 'impersonationIssuer' list

Description copied from interface: TokenValidator

Specifies that the subject is to be interpreted as identifying a specific user whose identity should be assumed for this request.

The subject is ignored by default. If subject impersonation is enabled, then the subject is understood to identify a user known to the application, or anonymous access when the subject is not specified. If subject impersonation is enabled, then the issuer whitelist MUST be provided, or all tokens will be rejected.

The validation service only approves the request for subject impersonation. The actual implementation is left up to the surrounding framework.

Specified by:

subjectImpersonation in interface TokenValidator

Parameters:

subjectImpersonation - true to use subject impersonation

Returns:

this

subject

public TokenValidator subject(Iterable<String> authorizedSubjects)

Description copied from interface: TokenValidator

As for TokenValidator.subject(String...).

Specified by:

subject in interface TokenValidator

Parameters:

authorizedSubjects - as for TokenValidator.subject(String...)

Returns:

this

audience

public TokenValidator audience(Iterable<String> additionalAudienceValues)

Description copied from interface: TokenValidator

As for TokenValidator.audience(String...).

Specified by:

audience in interface TokenValidator

Parameters:

additionalAudienceValues - as for TokenValidator.audience(String...)

Returns:

this

policy

public TokenValidator policy(TokenValidator.Policy policy)

Description copied from interface: TokenValidator

Specifies the validation policy for this validator.

By default, the validator will use TokenValidator.Policy.REQUIRE. If those are not the desired authentication semantics, then this method can be used to specify one of the other policies, instead. The most useful ones are probably TokenValidator.Policy.IGNORE (to disable ASAP authentication when it might otherwise have been inherited from a superclass or the surrounding context) and TokenValidator.Policy.OPTIONAL, to allow ASAP authentication to be validated when it is attempted, but without mandating its use.

Specified by:

policy in interface TokenValidator

Parameters:

policy - the enforcement policy to use

Returns:

this

authorizedIssuers

protected Set<String> authorizedIssuers()

impersonationAuthorizedIssuers

protected Set<String> impersonationAuthorizedIssuers()

authorizedSubjects

protected Set<String> authorizedSubjects()

acceptableAudienceValues

protected Set<String> acceptableAudienceValues()

subjectImpersonation

protected boolean subjectImpersonation()

policy

protected TokenValidator.Policy policy()

toString

public String toString()

Overrides:

toString in class Object