com.atlassian.asap.service.api

Interface AsapService

All Known Implementing Classes:

DefaultAsapService

public interface AsapService

Point of contact of service-to-service authentication tools.

Since:

2.8

Method Summary

Modifier and Type	Method and Description
AuthorizationBuilder	authorizationBuilder() Creates a builder for generating an HTTP Authorization header value containing an ASAP token.
TokenValidator	tokenValidator() Create a validator for verifying the contents of an HTTP Authorization header value.
default ValidationResult	validate(AsapAuth annotation, Optional<String> authHeader) Creates a validator and populates it with the provided annotation's settings, then applies it to the given Authorization header value.

Method Detail

authorizationBuilder

AuthorizationBuilder authorizationBuilder()

Creates a builder for generating an HTTP Authorization header value containing an ASAP token.

Returns:

a new authorization builder

tokenValidator

TokenValidator tokenValidator()

Create a validator for verifying the contents of an HTTP Authorization header value.

Returns:

a new token validator

validate

default ValidationResult validate(AsapAuth annotation,
                                  Optional<String> authHeader)

Creates a validator and populates it with the provided annotation's settings, then applies it to the given Authorization header value.

This convenience method creates a token validator, applies all of the settings from the annotation to it, then calls validate using the supplied authorization header.

Parameters:

annotation - an @AsapAuth annotation with the settings to apply

authHeader - the Authorization header that was provided for the request

Returns:

the result of validating authHeader against the settings specified by annotation