com.atlassian.asap.core.server.jersey

Interface FailureHandler

All Known Implementing Classes:

EmptyBodyFailureHandler

public interface FailureHandler

An extension point for customizing how the authentication and authorization failures are returned to the client.

Method Summary

Modifier and Type	Method and Description
default void	onAuthenticationFailure(javax.ws.rs.container.ContainerRequestContext context, AuthenticationFailedException e) Handles when the Jwt token cannot be parsed or validated.
default void	onAuthenticationFailure(javax.ws.rs.container.ContainerRequestContext context, String message) Deprecated. Use onAuthenticationFailure(ContainerRequestContext, AuthenticationFailedException) instead.
default void	onAuthorizationFailure(javax.ws.rs.container.ContainerRequestContext context, AuthorizationFailedException e) Handles when the Jwt token claims cannot be authorized.
default void	onAuthorizationFailure(javax.ws.rs.container.ContainerRequestContext context, String message) Deprecated. Use onAuthorizationFailure(ContainerRequestContext, AuthorizationFailedException) instead.
default void	onPermanentAuthenticationFailure(javax.ws.rs.container.ContainerRequestContext context, PermanentAuthenticationFailedException e) Handles when the Jwt token cannot validated, because of a permanent error (such as wrong header value, incorrect signature, etc.).
default boolean	onTransientAuthenticationFailure(javax.ws.rs.container.ContainerRequestContext context, TransientAuthenticationFailedException e) Handles when the Jwt token cannot validated, because of a possibly transient error (like a communication failure or 500 error response).

Method Detail

onTransientAuthenticationFailure

default boolean onTransientAuthenticationFailure(javax.ws.rs.container.ContainerRequestContext context,
                                                 TransientAuthenticationFailedException e)

Handles when the Jwt token cannot validated, because of a possibly transient error (like a communication failure or 500 error response). In this case a retry maybe possible.

Iif no retry is to be attempted (returning false, then the request should be aborted using the ContainerRequestContext instance.

By default, this method simply delegate to onAuthenticationFailure(ContainerRequestContext, AuthenticationFailedException) and returns false in order to NOT retry.

Parameters:

context - The request context

e - The TransientAuthenticationFailedException

Returns:

true if the authentication should be retried, false otherwise.

Since:

2.9.0

See Also:

onPermanentAuthenticationFailure(ContainerRequestContext, PermanentAuthenticationFailedException), onAuthenticationFailure(ContainerRequestContext, AuthenticationFailedException)

onPermanentAuthenticationFailure

default void onPermanentAuthenticationFailure(javax.ws.rs.container.ContainerRequestContext context,
                                              PermanentAuthenticationFailedException e)

Handles when the Jwt token cannot validated, because of a permanent error (such as wrong header value, incorrect signature, etc.). Requests should be aborted using the ContainerRequestContext instance.

By default, this method simply delegate to onAuthenticationFailure(ContainerRequestContext, AuthenticationFailedException)

Parameters:

context - The request context

e - The PermanentAuthenticationFailedException

Since:

2.9.0

See Also:

onTransientAuthenticationFailure(ContainerRequestContext, TransientAuthenticationFailedException), onAuthenticationFailure(ContainerRequestContext, AuthenticationFailedException)

onAuthenticationFailure

default void onAuthenticationFailure(javax.ws.rs.container.ContainerRequestContext context,
                                     AuthenticationFailedException e)

Handles when the Jwt token cannot be parsed or validated. Requests should be aborted using the ContainerRequestContext instance

Default implementation returns a HTTP 401 with an empty body.

If you want to handle more sprecific TransientAuthenticationFailedException and PermanentAuthenticationFailedException, respectively implement onTransientAuthenticationFailure(ContainerRequestContext, TransientAuthenticationFailedException) and onPermanentAuthenticationFailure(ContainerRequestContext, PermanentAuthenticationFailedException). Note you'll still need to implement this method to handle generic AuthenticationFailedExceptions.

Parameters:

context - The request context

e - The AuthenticationFailedException

Since:

2.9.0

onAuthenticationFailure

@Deprecated
default void onAuthenticationFailure(javax.ws.rs.container.ContainerRequestContext context,
                                                 String message)

Deprecated. Use onAuthenticationFailure(ContainerRequestContext, AuthenticationFailedException) instead.

Handles when the Jwt token cannot be parsed or validated. Requests should be aborted using the ContainerRequestContext instance

Parameters:

context - The request context

message - The error message

Since:

2.9.0.

onAuthorizationFailure

default void onAuthorizationFailure(javax.ws.rs.container.ContainerRequestContext context,
                                    AuthorizationFailedException e)

Handles when the Jwt token claims cannot be authorized. Requests should be aborted using the ContainerRequestContext instance

Parameters:

context - The request context

e - The authorization exception

Since:

2.9.0

onAuthorizationFailure

@Deprecated
default void onAuthorizationFailure(javax.ws.rs.container.ContainerRequestContext context,
                                                String message)

Deprecated. Use onAuthorizationFailure(ContainerRequestContext, AuthorizationFailedException) instead.

Handles when the Jwt token claims cannot be authorized. Requests should be aborted using the ContainerRequestContext instance

Parameters:

context - The request context

message - The error message

Since:

v2.9.0.