org.opends.messages
Enum Category

java.lang.Object
  extended by java.lang.Enum<Category>
      extended by org.opends.messages.Category
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Category>

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public enum Category
extends java.lang.Enum<Category>

Defines values for message categories which are loosly based on server components. Categories contain an in value that can be used as a mask for bitwise operations.


Enum Constant Summary
ACCESS_CONTROL
          The category used for messages associated with Access Control.
ADMIN
          The category used for messages associated with the administration framework.
ADMIN_TOOL
          The category used for messages associated with the tool like the offline installer and unintaller.
BACKEND
          The category used for messages associated with generic backends.
CONFIG
          The category that will be used for messages associated with configuration handling.
CORE
          The category that will be used for messages associated with the core server.
DSCONFIG
          The category used for messages associated with the dsconfig administration tool.
EXTENSIONS
          The category that will be used for messages associated with server extensions (e.g., extended operations, SASL mechanisms, password storage schemes, password validators, etc.).
JEB
          The category used for messages associated with the JE backend.
LOG
          The category that will be used for messages associated with the server loggers.
PLUGIN
          The category that will be used for messages associated with plugin processing.
PROTOCOL
          The category that will be used for messages associated with connection and protocol handling (e.g., ASN.1 and LDAP).
QUICKSETUP
          The category used for messages associated with quicksetup tools.
RUNTIME_INFORMATION
          The category used for messages associated with the runtime information.
SCHEMA
          The category that will be used for messages associated with the server schema elements.
SYNC
          The category used for messages associated with the Synchronization.
TASK
          The category used for messages associated with tasks.
THIRD_PARTY
          The category that will be used for messages associated with third-party (including user-defined) modules.
TOOLS
          The category used for messages associated with tools.
USER_DEFINED
          The category that will be used for messages associated with user-defined modules.
UTIL
          The category that will be used for messages associated with the general server utilities.
VERSION
          The category used for messages associated with version information.
 
Method Summary
 int getMask()
          Gets the mask value associated with this category.
static Category parseMask(int mask)
          Obtains the Severity associated with a given mask value.
static Category parseMessageId(int msgId)
          Obtains the Severity associated with the the input message ID msgId.
static Category valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Category[] 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
 

Enum Constant Detail

CORE

public static final Category CORE
The category that will be used for messages associated with the core server.


EXTENSIONS

public static final Category EXTENSIONS
The category that will be used for messages associated with server extensions (e.g., extended operations, SASL mechanisms, password storage schemes, password validators, etc.).


PROTOCOL

public static final Category PROTOCOL
The category that will be used for messages associated with connection and protocol handling (e.g., ASN.1 and LDAP).


CONFIG

public static final Category CONFIG
The category that will be used for messages associated with configuration handling.


LOG

public static final Category LOG
The category that will be used for messages associated with the server loggers.


UTIL

public static final Category UTIL
The category that will be used for messages associated with the general server utilities.


SCHEMA

public static final Category SCHEMA
The category that will be used for messages associated with the server schema elements.


PLUGIN

public static final Category PLUGIN
The category that will be used for messages associated with plugin processing.


JEB

public static final Category JEB
The category used for messages associated with the JE backend.


BACKEND

public static final Category BACKEND
The category used for messages associated with generic backends.


TOOLS

public static final Category TOOLS
The category used for messages associated with tools.


TASK

public static final Category TASK
The category used for messages associated with tasks.


ACCESS_CONTROL

public static final Category ACCESS_CONTROL
The category used for messages associated with Access Control.


ADMIN

public static final Category ADMIN
The category used for messages associated with the administration framework.


SYNC

public static final Category SYNC
The category used for messages associated with the Synchronization.


VERSION

public static final Category VERSION
The category used for messages associated with version information.


QUICKSETUP

public static final Category QUICKSETUP
The category used for messages associated with quicksetup tools.


ADMIN_TOOL

public static final Category ADMIN_TOOL
The category used for messages associated with the tool like the offline installer and unintaller.


DSCONFIG

public static final Category DSCONFIG
The category used for messages associated with the dsconfig administration tool.


RUNTIME_INFORMATION

public static final Category RUNTIME_INFORMATION
The category used for messages associated with the runtime information.


THIRD_PARTY

public static final Category THIRD_PARTY
The category that will be used for messages associated with third-party (including user-defined) modules.


USER_DEFINED

public static final Category USER_DEFINED
The category that will be used for messages associated with user-defined modules.

Method Detail

values

public static Category[] 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 (Category c : Category.values())
    System.out.println(c);

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

valueOf

public static Category valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

parseMessageId

public static Category parseMessageId(int msgId)
Obtains the Severity associated with the the input message ID msgId.

Parameters:
msgId - int message ID
Returns:
Severity assocated with the ID

parseMask

public static Category parseMask(int mask)
Obtains the Severity associated with a given mask value.

Parameters:
mask - for which a Severity is obtained.
Returns:
Severity associated with mask

getMask

public int getMask()
Gets the mask value associated with this category.

Returns:
int mask value