com.atlassian.jira.bc.security.login

Class DeniedReason

java.lang.Object

com.atlassian.jira.bc.security.login.DeniedReason

Direct Known Subclasses:

CaptchaChallengeRequired

@Immutable
public class DeniedReason
extends Object

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

Since:

v4.3

See Also:

LoginReason.AUTHENTICATION_DENIED

Field Summary

Fields

Modifier and Type	Field and Description
static String	X_DENIED_HEADER The HTTP header that is used to

Constructor Summary

Constructors

Constructor and Description
DeniedReason(String reasonCode) Creates a new DenialReason with no additional properties.
DeniedReason(String reasonCode, Map<String,String> reasonSpecificProperties) Creates a new DenialReason with properties.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

X_DENIED_HEADER

public static final String X_DENIED_HEADER

The HTTP header that is used to

See Also:

Constant Field Values

Constructor Detail

DeniedReason

public DeniedReason(String reasonCode)

Creates a new DenialReason with no additional properties.

Parameters:

reasonCode - the reason code for the denial

DeniedReason

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

Method Detail

asString

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.

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object