com.atlassian.asap.service.api

Interface AuthorizationBuilder

All Known Implementing Classes:

AuthorizationBuilderImpl

public interface AuthorizationBuilder

A builder-style tool for generating an HTTP Authorization header value that contains an ASAP token.

Since:

2.8

Method Summary

Modifier and Type	Method and Description
AuthorizationBuilder	audience(Iterable<String> audience) Specifies the intended audience(s) for the token.
default AuthorizationBuilder	audience(String... audience) Specifies the intended audience(s) for the token.
String	build() Generates a signed token and forms a value that is appropriate to use as an "Authorization" HTTP header.
AuthorizationBuilder	customClaims(Optional<javax.json.JsonObject> claims) Permits the inclusion of additional parameters that are not covered by any of the standard JWT claims.
AuthorizationBuilder	expiration(Optional<Duration> duration) Specifies how long the token will remain valid.
AuthorizationBuilder	subject(Optional<String> subject) Specifies the subject of the token.

Method Detail

subject

AuthorizationBuilder subject(Optional<String> subject)

Specifies the subject of the token.

Parameters:

subject - the subject to specify, or empty() to omit this field from the token

Returns:

this

audience

default AuthorizationBuilder audience(String... audience)

Specifies the intended audience(s) for the token.

Parameters:

audience - the audience(s) to specify in the token

Returns:

this

audience

AuthorizationBuilder audience(Iterable<String> audience)

Specifies the intended audience(s) for the token.

Parameters:

audience - the audience(s) to specify in the token

Returns:

this

expiration

AuthorizationBuilder expiration(Optional<Duration> duration)

Specifies how long the token will remain valid.

Parameters:

duration - how long the token should remain valid (empty() to use the default)

Returns:

this

customClaims

AuthorizationBuilder customClaims(Optional<javax.json.JsonObject> claims)

Permits the inclusion of additional parameters that are not covered by any of the standard JWT claims.

Other than the requirement that it must be expressible in JSON, no other explicit restrictions are given for the contents of this field. Practical restrictions, such as any maximum size for this information or what the consequences might be for exceeding it, are left unspecified.

Parameters:

claims - the additional information, if any, to include as extended information in the token

Returns:

this

build

String build()
      throws InvalidTokenException,
             CannotRetrieveKeyException

Generates a signed token and forms a value that is appropriate to use as an "Authorization" HTTP header.

Returns:

the value that should be specified as an Authorization header in HTTP requests

Throws:

CannotRetrieveKeyException - the private key cannot be loaded

InvalidTokenException - the parameters supplied for the token were invalid