A B C E F G H I J M N P Q R S T V W

A

ADD_ON_ID_ATTRIBUTE_NAME - Static variable in class com.atlassian.jwt.JwtConstants.HttpRequests

The name of an attribute set on incoming requests by authentication filters so that later filters can discover the id of the authenticated add-on (if any).

ADD_ON_ID_PROPERTY_NAME - Static variable in class com.atlassian.jwt.JwtConstants.AppLinks

The name of the property containing the unique identifier of an add-on.

ADD_ON_USER_KEY_PROPERTY_NAME - Static variable in class com.atlassian.jwt.JwtConstants.AppLinks

The key of the user assigned to this add-on.

AppLinks() - Constructor for class com.atlassian.jwt.JwtConstants.AppLinks

AsymmetricSigningInfo - Interface in com.atlassian.jwt

audience(String) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

Sets the 'aud' parameter.

AUTH_METHOD_PROPERTY_NAME - Static variable in class com.atlassian.jwt.JwtConstants.AppLinks

The name of the property containing the String value of the add-on's authentication method.

AUTHORIZATION_HEADER - Static variable in class com.atlassian.jwt.JwtConstants.HttpRequests

B

build(CanonicalHttpRequest) - Method in interface com.atlassian.jwt.reader.JwtClaimVerifiersBuilder

Encapsulate the building of requirements that we place upon JWTs in incoming requests.

build() - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

C

CanonicalHttpRequest - Interface in com.atlassian.jwt

HTTP request that can be signed for use as a JWT claim.

claim(String, Object) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

Adds an arbitrary claim.

Claims() - Constructor for class com.atlassian.jwt.JwtConstants.Claims

ClaimVerifiers() - Constructor for class com.atlassian.jwt.JwtConstants.ClaimVerifiers

com.atlassian.jwt - package com.atlassian.jwt

com.atlassian.jwt.exception - package com.atlassian.jwt.exception

com.atlassian.jwt.reader - package com.atlassian.jwt.reader

com.atlassian.jwt.writer - package com.atlassian.jwt.writer

E

expirationTime(long) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

Sets the 'exp' parameter.

F

forName(String) - Static method in enum com.atlassian.jwt.SigningAlgorithm

G

getIssuer() - Method in exception com.atlassian.jwt.exception.JwtSignatureMismatchException

getIssuer() - Method in interface com.atlassian.jwt.Jwt

getJsonPayload() - Method in interface com.atlassian.jwt.Jwt

getMethod() - Method in interface com.atlassian.jwt.CanonicalHttpRequest

HTTP method (e.g.

getParameterMap() - Method in interface com.atlassian.jwt.CanonicalHttpRequest

The Map of parameter-name to parameter-values.

getPrivateKey() - Method in interface com.atlassian.jwt.AsymmetricSigningInfo

getReader(String) - Method in interface com.atlassian.jwt.reader.JwtReaderFactory

Returns a jwt reader to be used for verifying tokens signed using a symmetric algorithm.

getReader(String, Date) - Method in interface com.atlassian.jwt.reader.JwtReaderFactory

This method is similar to JwtReaderFactory.getReader(String) but allows to specify the Date to be used when operating with the time-based claims of the JWT message.

getReader(String, RSAPublicKey) - Method in interface com.atlassian.jwt.reader.JwtReaderFactory

Returns a jwt reader that should be used for verifying tokens signed using an asymmetric algorithm.

getReader(String, RSAPublicKey, Date) - Method in interface com.atlassian.jwt.reader.JwtReaderFactory

This method is similar to JwtReaderFactory.getReader(String, RSAPublicKey) but allows to specify the Date to be used when operating with the time-based claims of the JWT message.

getRelativePath() - Method in interface com.atlassian.jwt.CanonicalHttpRequest

The part of an absolute URL that is after the protocol, server, port and context (i.e.

getSharedSecret() - Method in interface com.atlassian.jwt.SymmetricSigningInfo

getSigningAlgorithm() - Method in interface com.atlassian.jwt.SigningInfo

getSubject() - Method in interface com.atlassian.jwt.Jwt

H

HttpRequests() - Constructor for class com.atlassian.jwt.JwtConstants.HttpRequests

I

isClaimSet(String) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

issuedAt(long) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

Sets the 'iat' parameter.

issueJwt(String, String) - Method in interface com.atlassian.jwt.JwtService

Generate a JWT for the supplied payload, suitable for authenticating with the specified secret.

issueJwt(String, String, SigningAlgorithm) - Method in interface com.atlassian.jwt.JwtService

Generate a JWT for the supplied payload, suitable for authenticating with the specified secret.

issuer(String) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

Sets the 'iss' parameter.

J

jsonBuilder() - Method in interface com.atlassian.jwt.writer.JwtJsonBuilderFactory

jsonToJwt(String) - Method in interface com.atlassian.jwt.writer.JwtWriter

JwsUnsupportedAlgorithmException - Exception in com.atlassian.jwt.exception

Thrown if an incoming JWT is signed using an unsupported algorithm.

JwsUnsupportedAlgorithmException(String) - Constructor for exception com.atlassian.jwt.exception.JwsUnsupportedAlgorithmException

JwsUnsupportedAlgorithmException(String, Throwable) - Constructor for exception com.atlassian.jwt.exception.JwsUnsupportedAlgorithmException

JwsUnsupportedAlgorithmException(Throwable) - Constructor for exception com.atlassian.jwt.exception.JwsUnsupportedAlgorithmException

Jwt - Interface in com.atlassian.jwt

A JSON Web Token.

JWT_AUTH_HEADER_PREFIX - Static variable in class com.atlassian.jwt.JwtConstants.HttpRequests

The start of a valid Authorization header specifying a JWT message.

JWT_AUTH_METHOD_NAME - Static variable in class com.atlassian.jwt.JwtConstants.AppLinks

The value that the JwtConstants.AppLinks.AUTH_METHOD_PROPERTY_NAME property has if the add-on uses JWT authentication.

JWT_JSON_PAYLOAD_ATTRIBUTE_NAME - Static variable in class com.atlassian.jwt.JwtConstants.HttpRequests

Attribute name of where the JSON payload from the verified token is stored on incoming requests by the authentication filters

JWT_PARAM_NAME - Static variable in class com.atlassian.jwt.JwtConstants

When the JWT message is specified in the query string of a URL then this is the parameter name.

JWT_SUBJECT_ATTRIBUTE_NAME - Static variable in class com.atlassian.jwt.JwtConstants.HttpRequests

JwtCannotRetrieveKeyException - Exception in com.atlassian.jwt.exception

JwtCannotRetrieveKeyException(String) - Constructor for exception com.atlassian.jwt.exception.JwtCannotRetrieveKeyException

JwtCannotRetrieveKeyException(String, Throwable) - Constructor for exception com.atlassian.jwt.exception.JwtCannotRetrieveKeyException

JwtClaimVerifier - Interface in com.atlassian.jwt.reader

Interface for asserting that a JWT claim is valid.

JwtClaimVerifiersBuilder - Interface in com.atlassian.jwt.reader

JwtClaimWriter - Interface in com.atlassian.jwt.writer

Interface for writing a (custom) claim to a JWT.

JwtConstants - Class in com.atlassian.jwt

JwtConstants() - Constructor for class com.atlassian.jwt.JwtConstants

JwtConstants.AppLinks - Class in com.atlassian.jwt

JwtConstants.Claims - Class in com.atlassian.jwt

JwtConstants.ClaimVerifiers - Class in com.atlassian.jwt

JwtConstants.HttpRequests - Class in com.atlassian.jwt

JwtExpiredException - Exception in com.atlassian.jwt.exception

Thrown if the JWT's timestamps show that it has expired.

JwtExpiredException(Date, Date, int) - Constructor for exception com.atlassian.jwt.exception.JwtExpiredException

jwtId(String) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

Sets the 'jti' parameter.

JwtInvalidClaimException - Exception in com.atlassian.jwt.exception

Thrown if an expected claim is missing or the value of a reserved claim did not match its expected format.

JwtInvalidClaimException(String) - Constructor for exception com.atlassian.jwt.exception.JwtInvalidClaimException

JwtInvalidClaimException(String, Throwable) - Constructor for exception com.atlassian.jwt.exception.JwtInvalidClaimException

JwtIssuerLacksSharedSecretException - Exception in com.atlassian.jwt.exception

Thrown if a JWT requires a shared secret to sign or verify (e.g.

JwtIssuerLacksSharedSecretException(String) - Constructor for exception com.atlassian.jwt.exception.JwtIssuerLacksSharedSecretException

JwtJsonBuilder - Interface in com.atlassian.jwt.writer

Utility for generating JSON payloads for JWTs.

JwtJsonBuilderFactory - Interface in com.atlassian.jwt.writer

Factory for JwtJsonBuilder.

JwtMalformedSharedSecretException - Exception in com.atlassian.jwt.exception

Thrown if a malformed secret key is passed to verify a JWT (e.g.

JwtMalformedSharedSecretException(String, Throwable) - Constructor for exception com.atlassian.jwt.exception.JwtMalformedSharedSecretException

JwtMissingClaimException - Exception in com.atlassian.jwt.exception

JwtMissingClaimException(String) - Constructor for exception com.atlassian.jwt.exception.JwtMissingClaimException

JwtParseException - Exception in com.atlassian.jwt.exception

Indicates that the JWT was not well-formed, e.g.

JwtParseException(String, Throwable) - Constructor for exception com.atlassian.jwt.exception.JwtParseException

JwtParseException(Exception) - Constructor for exception com.atlassian.jwt.exception.JwtParseException

JwtParseException(String) - Constructor for exception com.atlassian.jwt.exception.JwtParseException

JwtParser - Interface in com.atlassian.jwt

Parses a jwt token without attempting to verify it.

JwtReader - Interface in com.atlassian.jwt.reader

Parses and verifies Jwts attached to incoming requests.

JwtReaderFactory - Interface in com.atlassian.jwt.reader

Factory for JwtReader.

JwtService - Interface in com.atlassian.jwt

Verifies incoming JWTs issued by linked applications and generates JWTs for use in outbound requests targeting linked applications.

JwtSignatureMismatchException - Exception in com.atlassian.jwt.exception

Indicates that the JWT's signature does not match its contents or the shared secret for the specified issuer.

JwtSignatureMismatchException(Exception) - Constructor for exception com.atlassian.jwt.exception.JwtSignatureMismatchException

JwtSignatureMismatchException(String) - Constructor for exception com.atlassian.jwt.exception.JwtSignatureMismatchException

Deprecated.

Since 2.0.2, use the other constructors

JwtSignatureMismatchException(String, String) - Constructor for exception com.atlassian.jwt.exception.JwtSignatureMismatchException

JwtSigningException - Exception in com.atlassian.jwt.exception

Thrown if a problem was encountered while signing a JWT.

JwtSigningException(Exception) - Constructor for exception com.atlassian.jwt.exception.JwtSigningException

JwtTooEarlyException - Exception in com.atlassian.jwt.exception

JwtTooEarlyException(Date, Date, int) - Constructor for exception com.atlassian.jwt.exception.JwtTooEarlyException

JwtUnknownIssuerException - Exception in com.atlassian.jwt.exception

Thrown if the issuer is not known (e.g.

JwtUnknownIssuerException(String) - Constructor for exception com.atlassian.jwt.exception.JwtUnknownIssuerException

JwtUserRejectedException - Exception in com.atlassian.jwt.exception

JwtUserRejectedException(String) - Constructor for exception com.atlassian.jwt.exception.JwtUserRejectedException

JwtVerificationException - Exception in com.atlassian.jwt.exception

Indicates a JWT was well-formed, but failed to validate.

JwtVerificationException() - Constructor for exception com.atlassian.jwt.exception.JwtVerificationException

JwtVerificationException(String) - Constructor for exception com.atlassian.jwt.exception.JwtVerificationException

JwtVerificationException(String, Throwable) - Constructor for exception com.atlassian.jwt.exception.JwtVerificationException

JwtVerificationException(Throwable) - Constructor for exception com.atlassian.jwt.exception.JwtVerificationException

JwtWriter - Interface in com.atlassian.jwt.writer

Creates JWTs for arbitrary JSON payloads.

JwtWriterFactory - Interface in com.atlassian.jwt.writer

Factory for JwtJsonBuilderFactory.

M

macSigningWriter(SigningAlgorithm, String) - Method in interface com.atlassian.jwt.writer.JwtWriterFactory

N

NO_REQUIRED_CLAIMS - Static variable in class com.atlassian.jwt.JwtConstants.ClaimVerifiers

Tell JwtReader.readAndVerify(java.lang.String, java.util.Map<java.lang.String, ? extends com.atlassian.jwt.reader.JwtClaimVerifier>) that no custom claims are mandatory.

notBefore(long) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

Sets the 'nbf' parameter.

P

parse(String) - Method in interface com.atlassian.jwt.JwtParser

Parses the given jwt token and returns the decoded claims body

Q

QUERY_HASH - Static variable in class com.atlassian.jwt.JwtConstants.Claims

Instructions for computing the query hash parameter ("qsh") from a HTTP request.

queryHash(String) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

Sets the 'qsh' parameter

R

read(String, Map<String, ? extends JwtClaimVerifier>) - Method in interface com.atlassian.jwt.reader.JwtReader

Deprecated.

readAndVerify(String, Map<String, ? extends JwtClaimVerifier>) - Method in interface com.atlassian.jwt.reader.JwtReader

Parses the encoded JWT message from String, verifies its signature (if there is one) and on success returns the decoded Jwt.

readUnverified(String) - Method in interface com.atlassian.jwt.reader.JwtReader

Parses the encoded JWT message from String and on success returns the decoded Jwt.

requiresKeyPair() - Method in enum com.atlassian.jwt.SigningAlgorithm

requiresSharedSecret() - Method in enum com.atlassian.jwt.SigningAlgorithm

S

SHARED_SECRET_PROPERTY_NAME - Static variable in class com.atlassian.jwt.JwtConstants.AppLinks

The name of the property containing the shared secret used in JWT authentication (if any).

SigningAlgorithm - Enum in com.atlassian.jwt

An enumeration of supported JWS algorithms.

SigningInfo - Interface in com.atlassian.jwt

Encapsulates the algorithm and key/secret to be used for signing and verifying jwt tokens

signingWriter(SymmetricSigningInfo) - Method in interface com.atlassian.jwt.writer.JwtWriterFactory

signingWriter(AsymmetricSigningInfo) - Method in interface com.atlassian.jwt.writer.JwtWriterFactory

SUBJECT - Static variable in class com.atlassian.jwt.JwtConstants.Claims

subject(String) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

Sets the 'sub' parameter.

SymmetricSigningInfo - Interface in com.atlassian.jwt

SYS_PROP_ALLOW_IMPERSONATION - Static variable in class com.atlassian.jwt.JwtConstants.AppLinks

System property which determines if impersonation is allowed, by using the JWT token's sub claim

T

TIME_CLAIM_LEEWAY_SECONDS - Static variable in class com.atlassian.jwt.JwtConstants

The JWT spec says that implementers "MAY provide for some small leeway, usually no more than a few minutes, to account for clock skew".

type(String) - Method in interface com.atlassian.jwt.writer.JwtJsonBuilder

Sets the 'typ' parameter.

V

valueOf(String) - Static method in enum com.atlassian.jwt.SigningAlgorithm

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.atlassian.jwt.SigningAlgorithm

Returns an array containing the constants of this enum type, in the order they are declared.

verify(Object) - Method in interface com.atlassian.jwt.reader.JwtClaimVerifier

Assert that the claimed value is valid.

verifyJwt(String, Map<String, ? extends JwtClaimVerifier>) - Method in interface com.atlassian.jwt.JwtService

Verify an incoming JWT.

W

write(JwtJsonBuilder) - Method in interface com.atlassian.jwt.writer.JwtClaimWriter

A B C E F G H I J M N P Q R S T V W