org.opends.admin.ads
Enum ADSContext.ServerProperty

java.lang.Object
  extended by java.lang.Enum<ADSContext.ServerProperty>
      extended by org.opends.admin.ads.ADSContext.ServerProperty
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ADSContext.ServerProperty>
Enclosing class:
ADSContext

public static enum ADSContext.ServerProperty
extends java.lang.Enum<ADSContext.ServerProperty>

Enumeration containing the different server properties that are stored in the ADS.


Enum Constant Summary
CERTIFICATE
          The certificate used by the server.
DESCRIPTION
          The description of the server.
GROUPS
          The groups to which this server belongs.
HOST_NAME
          The host name of the server.
HOST_OS
          The OS of the machine where the server is installed.
ID
          The ID used to identify the server.
INSTANCE_KEY_ID
          The unique name of the instance key public-key certificate.
INSTANCE_PATH
          The path where the server is installed.
INSTANCE_PUBLIC_KEY_CERTIFICATE
          The instance key-pair public-key certificate.
JMX_ENABLED
          Whether JMX is enabled or not.
JMX_PORT
          The JMX port of the server.
JMXS_ENABLED
          Whether JMX is enabled or not.
JMXS_PORT
          The JMX secure port of the server.
LDAP_ENABLED
          Whether LDAP is enabled or not.
LDAP_PORT
          The LDAP port of the server.
LDAPS_ENABLED
          Whether LDAPS is enabled or not.
LDAPS_PORT
          The LDAPS port of the server.
LOCATION
          The location of the server.
STARTTLS_ENABLED
          Whether StartTLS is enabled or not.
 
Method Summary
 java.lang.String getAttributeName()
          Returns the attribute name.
 ADSContext.ADSPropertySyntax getAttributeSyntax()
          Returns the attribute syntax.
static ADSContext.ServerProperty valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ADSContext.ServerProperty[] 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

ID

public static final ADSContext.ServerProperty ID
The ID used to identify the server.


HOST_NAME

public static final ADSContext.ServerProperty HOST_NAME
The host name of the server.


LDAP_PORT

public static final ADSContext.ServerProperty LDAP_PORT
The LDAP port of the server.


JMX_PORT

public static final ADSContext.ServerProperty JMX_PORT
The JMX port of the server.


JMXS_PORT

public static final ADSContext.ServerProperty JMXS_PORT
The JMX secure port of the server.


LDAPS_PORT

public static final ADSContext.ServerProperty LDAPS_PORT
The LDAPS port of the server.


CERTIFICATE

public static final ADSContext.ServerProperty CERTIFICATE
The certificate used by the server.


INSTANCE_PATH

public static final ADSContext.ServerProperty INSTANCE_PATH
The path where the server is installed.


DESCRIPTION

public static final ADSContext.ServerProperty DESCRIPTION
The description of the server.


HOST_OS

public static final ADSContext.ServerProperty HOST_OS
The OS of the machine where the server is installed.


LDAP_ENABLED

public static final ADSContext.ServerProperty LDAP_ENABLED
Whether LDAP is enabled or not.


LDAPS_ENABLED

public static final ADSContext.ServerProperty LDAPS_ENABLED
Whether LDAPS is enabled or not.


STARTTLS_ENABLED

public static final ADSContext.ServerProperty STARTTLS_ENABLED
Whether StartTLS is enabled or not.


JMX_ENABLED

public static final ADSContext.ServerProperty JMX_ENABLED
Whether JMX is enabled or not.


JMXS_ENABLED

public static final ADSContext.ServerProperty JMXS_ENABLED
Whether JMX is enabled or not.


LOCATION

public static final ADSContext.ServerProperty LOCATION
The location of the server.


GROUPS

public static final ADSContext.ServerProperty GROUPS
The groups to which this server belongs.


INSTANCE_KEY_ID

public static final ADSContext.ServerProperty INSTANCE_KEY_ID
The unique name of the instance key public-key certificate.


INSTANCE_PUBLIC_KEY_CERTIFICATE

public static final ADSContext.ServerProperty INSTANCE_PUBLIC_KEY_CERTIFICATE
The instance key-pair public-key certificate. Note: This attribute belongs to an instance key entry, separate from the server entry and named by the ds-cfg-key-id attribute from the server entry.

Method Detail

values

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

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

valueOf

public static ADSContext.ServerProperty 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

getAttributeName

public java.lang.String getAttributeName()
Returns the attribute name.

Returns:
the attribute name.

getAttributeSyntax

public ADSContext.ADSPropertySyntax getAttributeSyntax()
Returns the attribute syntax.

Returns:
the attribute syntax.