Package org.opends.messages
Enum Category
- java.lang.Object
-
- java.lang.Enum<Category>
-
- org.opends.messages.Category
-
- All Implemented Interfaces:
Serializable,Comparable<Category>
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public enum Category extends 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
Enum Constants Enum Constant Description ACCESS_CONTROLThe category used for messages associated with Access Control.ADMINThe category used for messages associated with the administration framework.ADMIN_TOOLThe category used for messages associated with the tool like the offline installer and unintaller.BACKENDThe category used for messages associated with generic backends.CONFIGThe category that will be used for messages associated with configuration handling.COREThe category that will be used for messages associated with the core server.DSCONFIGThe category used for messages associated with the dsconfig administration tool.EXTENSIONSThe category that will be used for messages associated with server extensions (e.g., extended operations, SASL mechanisms, password storage schemes, password validators, etc.).JEBThe category used for messages associated with the JE backend.LOGThe category that will be used for messages associated with the server loggers.PLUGINThe category that will be used for messages associated with plugin processing.PROTOCOLThe category that will be used for messages associated with connection and protocol handling (e.g., ASN.1 and LDAP).QUICKSETUPThe category used for messages associated with quicksetup tools.RUNTIME_INFORMATIONThe category used for messages associated with the runtime information.SCHEMAThe category that will be used for messages associated with the server schema elements.SYNCThe category used for messages associated with the Synchronization.TASKThe category used for messages associated with tasks.THIRD_PARTYThe category that will be used for messages associated with third-party (including user-defined) modules.TOOLSThe category used for messages associated with tools.USER_DEFINEDThe category that will be used for messages associated with user-defined modules.UTILThe category that will be used for messages associated with the general server utilities.VERSIONThe category used for messages associated with version information.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetMask()Gets the mask value associated with this category.static CategoryparseMask(int mask)Obtains theSeverityassociated with a given mask value.static CategoryparseMessageId(int msgId)Obtains theSeverityassociated with the the input message IDmsgId.static CategoryvalueOf(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.
-
-
-
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(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 nameNullPointerException- if the argument is null
-
parseMessageId
public static Category parseMessageId(int msgId)
Obtains theSeverityassociated with the the input message IDmsgId.- Parameters:
msgId- int message ID- Returns:
- Severity associated with the ID
-
parseMask
public static Category parseMask(int mask)
Obtains theSeverityassociated with a given mask value.- Parameters:
mask- for which aSeverityis obtained.- Returns:
- Severity associated with
mask
-
getMask
public int getMask()
Gets the mask value associated with this category.- Returns:
- int mask value
-
-