@Immutable public class

DeniedReason

extends Object
java.lang.Object
   ↳ com.atlassian.jira.bc.security.login.DeniedReason
Known Direct Subclasses

Class Overview

This class is used to indicate the reason why authentication has been denied.

See Also

Summary

Constants
String X_DENIED_HEADER The HTTP header that is used to
Public Constructors
DeniedReason(String reasonCode)
Creates a new DenialReason with no additional properties.
DeniedReason(String reasonCode, Map<String, String> reasonSpecificProperties)
Creates a new DenialReason with properties.
Public Methods
String asString()
Returns a string representation of this DenialReason, which is suitable for inclusion in a HTTP response header.
String toString()
Returns a string representation of the object.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String X_DENIED_HEADER

The HTTP header that is used to

Constant Value: "X-Authentication-Denied-Reason"

Public Constructors

public DeniedReason (String reasonCode)

Creates a new DenialReason with no additional properties.

Parameters
reasonCode the reason code for the denial

public DeniedReason (String reasonCode, Map<String, String> reasonSpecificProperties)

Creates a new DenialReason with properties.

Parameters
reasonCode the reason code for the denial
reasonSpecificProperties the reason-specific properties

Public Methods

public String asString ()

Returns a string representation of this DenialReason, which is suitable for inclusion in a HTTP response header.

Returns
  • a string representation of this DenialReason.

public String toString ()

Returns a string representation of the object.