org.opends.server.config

Class BooleanConfigAttribute

java.lang.Object

org.opends.server.config.ConfigAttribute

org.opends.server.config.BooleanConfigAttribute

@PublicAPI(stability=VOLATILE,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public final class BooleanConfigAttribute
extends ConfigAttribute

This class defines a Boolean configuration attribute, which can hold a single Boolean value of true or false. Boolean configuration attributes will always be required and will never be multivalued.

Constructor Summary

Constructors

Constructor and Description
BooleanConfigAttribute(String name, LocalizableMessage description, boolean requiresAdminAction) Creates a new Boolean configuration attribute stub with the provided information but no values.
BooleanConfigAttribute(String name, LocalizableMessage description, boolean requiresAdminAction, boolean value) Creates a new Boolean configuration attribute with the provided information.
BooleanConfigAttribute(String name, LocalizableMessage description, boolean requiresAdminAction, boolean activeValue, boolean pendingValue) Creates a new Boolean configuration attribute with the provided information.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	activeValue() Retrieves the active boolean value for this configuration attribute.
List<String>	activeValuesToStrings() Converts the set of active values for this configuration attribute into a set of strings that may be stored in the configuration or represented over protocol.
void	applyPendingValues() Applies the set of pending values, making them the active values for this configuration attribute.
ConfigAttribute	duplicate() Creates a duplicate of this configuration attribute.
ConfigAttribute	getConfigAttribute(List<Attribute> attributeList) Retrieves a new configuration attribute of this type that will contain the values from the provided attribute.
String	getDataType() Retrieves the name of the data type for this configuration attribute.
org.forgerock.opendj.ldap.schema.Syntax	getSyntax() Retrieves the attribute syntax for this configuration attribute.
boolean	pendingValue() Retrieves the pending boolean value for this configuration attribute.
List<String>	pendingValuesToStrings() Converts the set of pending values for this configuration attribute into a set of strings that may be stored in the configuration or represented over protocol.
void	setValue(Attribute jmxAttribute) Attempts to set the value of this configuration attribute based on the information in the provided JMX attribute.
void	setValue(boolean booleanValue) Specifies the boolean value for this configuration attribute.
LinkedHashSet<org.forgerock.opendj.ldap.ByteString>	stringsToValues(List<String> valueStrings, boolean allowFailures) Converts the provided set of strings to a corresponding set of attribute values.
Attribute	toJMXAttribute() Retrieves a JMX attribute containing the active value set for this configuration attribute.
void	toJMXAttribute(AttributeList attributeList) Adds information about this configuration attribute to the provided JMX attribute list.
void	toJMXAttributeInfo(List<MBeanAttributeInfo> attributeInfoList) Adds information about this configuration attribute to the provided list in the form of a JMX MBeanAttributeInfo object.
Attribute	toJMXAttributePending() Retrieves a JMX attribute containing the pending value set for this configuration attribute.
MBeanParameterInfo	toJMXParameterInfo() Retrieves a JMX MBeanParameterInfo object that describes this configuration attribute.
boolean	valueIsAcceptable(org.forgerock.opendj.ldap.ByteString value, StringBuilder rejectReason) Indicates whether the provided value is acceptable for use in this attribute.

Methods inherited from class org.opends.server.config.ConfigAttribute

addValues, getActiveValues, getDescription, getName, getPendingValues, hasPendingValues, isMultiValued, isRequired, removeAllValues, removeValues, requiresAdminAction, setActiveValues, setInitialValues, setPendingValues, setValues

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanConfigAttribute

public BooleanConfigAttribute(String name,
                      LocalizableMessage description,
                      boolean requiresAdminAction)

Creates a new Boolean configuration attribute stub with the provided information but no values. The values will be set using the setInitialValue method.

Parameters:

name - The name for this configuration attribute.

description - The description for this configuration attribute.

requiresAdminAction - Indicates whether changes to this configuration attribute require administrative action before they will take effect.

BooleanConfigAttribute

public BooleanConfigAttribute(String name,
                      LocalizableMessage description,
                      boolean requiresAdminAction,
                      boolean value)

Creates a new Boolean configuration attribute with the provided information.

Parameters:

name - The name for this configuration attribute.

description - The description for this configuration attribute.

requiresAdminAction - Indicates whether changes to this configuration attribute require administrative action before they will take effect.

value - The value for this Boolean configuration attribute.

BooleanConfigAttribute

public BooleanConfigAttribute(String name,
                      LocalizableMessage description,
                      boolean requiresAdminAction,
                      boolean activeValue,
                      boolean pendingValue)

Creates a new Boolean configuration attribute with the provided information.

Parameters:

name - The name for this configuration attribute.

description - The description for this configuration attribute.

requiresAdminAction - Indicates whether changes to this configuration attribute require administrative action before they will take effect.

activeValue - The active value for this Boolean configuration attribute.

pendingValue - The pending value for this Boolean configuration attribute.

Method Detail

getDataType

public String getDataType()

Retrieves the name of the data type for this configuration attribute. This is for informational purposes (e.g., inclusion in method signatures and other kinds of descriptions) and does not necessarily need to map to an actual Java type.

Specified by:

getDataType in class ConfigAttribute

Returns:

The name of the data type for this configuration attribute.

getSyntax

public org.forgerock.opendj.ldap.schema.Syntax getSyntax()

Retrieves the attribute syntax for this configuration attribute.

Specified by:

getSyntax in class ConfigAttribute

Returns:

The attribute syntax for this configuration attribute.

activeValue

public boolean activeValue()

Retrieves the active boolean value for this configuration attribute.

Returns:

The active boolean value for this configuration attribute.

pendingValue

public boolean pendingValue()

Retrieves the pending boolean value for this configuration attribute. If there is no pending value, then the active value will be returned.

Returns:

The pending boolean value for this configuration attribute.

setValue

public void setValue(boolean booleanValue)

Specifies the boolean value for this configuration attribute.

Parameters:

booleanValue - The boolean value for this configuration attribute.

applyPendingValues

public void applyPendingValues()

Applies the set of pending values, making them the active values for this configuration attribute. This will not take any action if there are no pending values.

Overrides:

applyPendingValues in class ConfigAttribute

valueIsAcceptable

public boolean valueIsAcceptable(org.forgerock.opendj.ldap.ByteString value,
                        StringBuilder rejectReason)

Indicates whether the provided value is acceptable for use in this attribute. If it is not acceptable, then the reason should be written into the provided buffer.

Specified by:

valueIsAcceptable in class ConfigAttribute

Parameters:

value - The value for which to make the determination.

rejectReason - A buffer into which a human-readable reason for the reject may be written.

Returns:

true if the provided value is acceptable for use in this attribute, or false if not.

stringsToValues

public LinkedHashSet<org.forgerock.opendj.ldap.ByteString> stringsToValues(List<String> valueStrings,
                                                                  boolean allowFailures)
                                                                    throws ConfigException

Converts the provided set of strings to a corresponding set of attribute values.

Specified by:

stringsToValues in class ConfigAttribute

Parameters:

valueStrings - The set of strings to be converted into attribute values.

allowFailures - Indicates whether the decoding process should allow any failures in which one or more values could be decoded but at least one could not. If this is true and such a condition is acceptable for the underlying attribute type, then the returned set of values should simply not include those undecodable values.

Returns:

The set of attribute values converted from the provided strings.

Throws:

ConfigException - If an unrecoverable problem occurs while performing the conversion.

activeValuesToStrings

public List<String> activeValuesToStrings()

Converts the set of active values for this configuration attribute into a set of strings that may be stored in the configuration or represented over protocol. The string representation used by this method should be compatible with the decoding used by the stringsToValues method.

Specified by:

activeValuesToStrings in class ConfigAttribute

Returns:

The string representations of the set of active values for this configuration attribute.

pendingValuesToStrings

public List<String> pendingValuesToStrings()

Converts the set of pending values for this configuration attribute into a set of strings that may be stored in the configuration or represented over protocol. The string representation used by this method should be compatible with the decoding used by the stringsToValues(List, boolean) method.

Specified by:

pendingValuesToStrings in class ConfigAttribute

Returns:

The string representations of the set of pending values for this configuration attribute, or null if there are no pending values.

getConfigAttribute

public ConfigAttribute getConfigAttribute(List<Attribute> attributeList)
                                   throws ConfigException

Retrieves a new configuration attribute of this type that will contain the values from the provided attribute.

Specified by:

getConfigAttribute in class ConfigAttribute

Parameters:

attributeList - The list of attributes to use to create the config attribute. The list must contain either one or two elements, with both attributes having the same base name and the only option allowed is ";pending" and only if this attribute is one that requires admin action before a change may take effect.

Returns:

The generated configuration attribute.

Throws:

ConfigException - If the provided attribute cannot be treated as a configuration attribute of this type (e.g., if one or more of the values of the provided attribute are not suitable for an attribute of this type, or if this configuration attribute is single-valued and the provided attribute has multiple values).

toJMXAttribute

public Attribute toJMXAttribute()

Retrieves a JMX attribute containing the active value set for this configuration attribute.

Specified by:

toJMXAttribute in class ConfigAttribute

Returns:

A JMX attribute containing the active value set for this configuration attribute, or null if it does not have any active values.

toJMXAttributePending

public Attribute toJMXAttributePending()

Retrieves a JMX attribute containing the pending value set for this configuration attribute.

Specified by:

toJMXAttributePending in class ConfigAttribute

Returns:

A JMX attribute containing the pending value set for this configuration attribute.

toJMXAttribute

public void toJMXAttribute(AttributeList attributeList)

Adds information about this configuration attribute to the provided JMX attribute list. If this configuration attribute requires administrative action before changes take effect and it has a set of pending values, then two attributes should be added to the list -- one for the active value and one for the pending value. The pending value should be named with the pending option.

Specified by:

toJMXAttribute in class ConfigAttribute

Parameters:

attributeList - The attribute list to which the JMX attribute(s) should be added.

toJMXAttributeInfo

public void toJMXAttributeInfo(List<MBeanAttributeInfo> attributeInfoList)

Adds information about this configuration attribute to the provided list in the form of a JMX MBeanAttributeInfo object. If this configuration attribute requires administrative action before changes take effect and it has a set of pending values, then two attribute info objects should be added to the list -- one for the active value (which should be read-write) and one for the pending value (which should be read-only). The pending value should be named with the pending option.

Specified by:

toJMXAttributeInfo in class ConfigAttribute

Parameters:

attributeInfoList - The list to which the attribute information should be added.

toJMXParameterInfo

public MBeanParameterInfo toJMXParameterInfo()

Retrieves a JMX MBeanParameterInfo object that describes this configuration attribute.

Specified by:

toJMXParameterInfo in class ConfigAttribute

Returns:

A JMX MBeanParameterInfo object that describes this configuration attribute.

setValue

public void setValue(Attribute jmxAttribute)
              throws ConfigException

Attempts to set the value of this configuration attribute based on the information in the provided JMX attribute.

Specified by:

setValue in class ConfigAttribute

Parameters:

jmxAttribute - The JMX attribute to use to attempt to set the value of this configuration attribute.

Throws:

ConfigException - If the provided JMX attribute does not have an acceptable value for this configuration attribute.

duplicate

public ConfigAttribute duplicate()

Creates a duplicate of this configuration attribute.

Specified by:

duplicate in class ConfigAttribute

Returns:

A duplicate of this configuration attribute.