com.yahoo.bard.webservice.web.security

Enum SecurityErrorMessageFormat

java.lang.Object

java.lang.Enum<SecurityErrorMessageFormat>

com.yahoo.bard.webservice.web.security.SecurityErrorMessageFormat

All Implemented Interfaces:

MessageFormatter, Serializable, Comparable<SecurityErrorMessageFormat>

public enum SecurityErrorMessageFormat
extends Enum<SecurityErrorMessageFormat>
implements MessageFormatter

Message formats for security module errors.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIMENSION_MISSING_MANDATORY_ROLE

Method Summary

Modifier and Type	Method and Description
String	getLoggingFormat() The message format used for logging.
String	getMessageFormat() The message format used for publishing out of the system, typically in error messages.
static SecurityErrorMessageFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static SecurityErrorMessageFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yahoo.bard.webservice.MessageFormatter

format, logFormat

Enum Constant Detail

DIMENSION_MISSING_MANDATORY_ROLE

public static final SecurityErrorMessageFormat DIMENSION_MISSING_MANDATORY_ROLE

Method Detail

values

public static SecurityErrorMessageFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SecurityErrorMessageFormat c : SecurityErrorMessageFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static SecurityErrorMessageFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMessageFormat

public String getMessageFormat()

Description copied from interface: MessageFormatter

The message format used for publishing out of the system, typically in error messages.

Specified by:

getMessageFormat in interface MessageFormatter

Returns:

The format for messages

getLoggingFormat

public String getLoggingFormat()

Description copied from interface: MessageFormatter

The message format used for logging.

Specified by:

getLoggingFormat in interface MessageFormatter

Returns:

The format for log messages