com.atlassian.asap.api.client.http

Interface AuthorizationHeaderGenerator

All Known Implementing Classes:

AuthorizationHeaderGeneratorImpl, DefaultAuthorizationHeaderGenerator

public interface AuthorizationHeaderGenerator

HTTP clients can use this service to generate the value of the Authorization header to be included in outgoing requests.

See Also:

ASAP Authentication

Method Summary

Modifier and Type	Method and Description
String	generateAuthorizationHeader(Jwt jwt) Generates an HTTP Authorization header that includes a signed JWT.

Method Detail

generateAuthorizationHeader

String generateAuthorizationHeader(Jwt jwt)
                            throws InvalidTokenException,
                                   CannotRetrieveKeyException

Generates an HTTP Authorization header that includes a signed JWT.

Parameters:

jwt - the JWT object to be included in the authorization header

Returns:

the complete value of the Authorization header including the authentication scheme and the signed and serialized JWT

Throws:

InvalidTokenException - if the JWT is invalid or cannot be serialized

CannotRetrieveKeyException - if the private key is not available