StringConfigAttribute.java revision 63f448170875fbc69cfd9496507eab923535e07d
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
* Portions Copyright 2014-2015 ForgeRock AS
*/
/**
* This class defines a string configuration attribute, which can hold zero or
* more string values.
*/
mayInstantiate=true,
mayExtend=false,
mayInvoke=true)
public final class StringConfigAttribute
extends ConfigAttribute
{
/** The set of active values for this attribute. */
/** The set of pending values for this attribute. */
/**
* Creates a new string configuration attribute stub with the provided
* information but no values. The values will be set using the
* <CODE>setInitialValue</CODE> method.
*
* @param name The name for this configuration attribute.
* @param description The description for this configuration
* attribute.
* @param isRequired Indicates whether this configuration attribute
* is required to have at least one value.
* @param isMultiValued Indicates whether this configuration attribute
* may have multiple values.
* @param requiresAdminAction Indicates whether changes to this
* configuration attribute require administrative
* action before they will take effect.
*/
boolean isRequired, boolean isMultiValued,
boolean requiresAdminAction)
{
activeValues = new ArrayList<>();
}
/**
* Creates a new string configuration attribute with the provided information.
* No validation will be performed on the provided value.
*
* @param name The name for this configuration attribute.
* @param description The description for this configuration
* attribute.
* @param isRequired Indicates whether this configuration attribute
* is required to have at least one value.
* @param isMultiValued Indicates whether this configuration attribute
* may have multiple values.
* @param requiresAdminAction Indicates whether changes to this
* configuration attribute require administrative
* action before they will take effect.
* @param value The value for this string configuration
* attribute.
*/
boolean isRequired, boolean isMultiValued,
{
getValueSet(value));
{
activeValues = new ArrayList<>();
}
else
{
}
}
/**
* Creates a new string configuration attribute with the provided information.
* No validation will be performed on the provided values.
*
* @param name The name for this configuration attribute.
* @param description The description for this configuration
* attribute.
* @param isRequired Indicates whether this configuration attribute
* is required to have at least one value.
* @param isMultiValued Indicates whether this configuration attribute
* may have multiple values.
* @param requiresAdminAction Indicates whether changes to this
* configuration attribute require administrative
* action before they will take effect.
* @param values The set of values for this configuration
* attribute.
*/
boolean isRequired, boolean isMultiValued,
{
}
/**
* Creates a new string configuration attribute with the provided information.
* No validation will be performed on the provided values.
*
* @param name The name for this configuration attribute.
* @param description The description for this configuration
* attribute.
* @param isRequired Indicates whether this configuration attribute
* is required to have at least one value.
* @param isMultiValued Indicates whether this configuration attribute
* may have multiple values.
* @param requiresAdminAction Indicates whether changes to this
* configuration attribute require administrative
* action before they will take effect.
* @param activeValues The set of active values for this
* configuration attribute.
* @param pendingValues The set of pending values for this
* configuration attribute.
*/
boolean isRequired, boolean isMultiValued,
boolean requiresAdminAction,
{
if (activeValues == null)
{
this.activeValues = new ArrayList<>();
}
else
{
this.activeValues = activeValues;
}
if (pendingValues == null)
{
this.pendingValues = this.activeValues;
}
else
{
this.pendingValues = pendingValues;
}
}
/**
* 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.
*
* @return The name of the data type for this configuration attribute.
*/
public String getDataType()
{
return "String";
}
/**
* Retrieves the attribute syntax for this configuration attribute.
*
* @return The attribute syntax for this configuration attribute.
*/
{
return DirectoryServer.getDefaultStringSyntax();
}
/**
* Retrieves the active value for this configuration attribute as a string.
* This is only valid for single-valued attributes that have a value.
*
* @return The active value for this configuration attribute as a string.
* @throws org.forgerock.opendj.config.server.ConfigException
* If this attribute does not have exactly one active value.
*/
public String activeValue()
{
{
}
{
}
}
/**
* Retrieves the set of active values for this configuration attribute.
*
* @return The set of active values for this configuration attribute.
*/
{
return activeValues;
}
/**
* Retrieves the pending value for this configuration attribute as a string.
* This is only valid for single-valued attributes that have a value. If this
* attribute does not have any pending values, then the active value will be
* returned.
*
* @return The pending value for this configuration attribute as a string.
* @throws org.forgerock.opendj.config.server.ConfigException
* If this attribute does not have exactly one pending value.
*/
public String pendingValue()
{
if (! hasPendingValues())
{
return activeValue();
}
{
}
{
}
}
/**
* Retrieves the set of pending values for this configuration attribute. If
* there are no pending values, then the set of active values will be
* returned.
*
* @return The set of pending values for this configuration attribute.
*/
{
if (!hasPendingValues())
{
return activeValues;
}
return pendingValues;
}
/**
* Sets the value for this string configuration attribute.
*
* @param value The value for this string configuration attribute.
*
* @throws ConfigException If the provided value is not acceptable.
*/
throws ConfigException
{
{
}
if (requiresAdminAction())
{
}
else
{
}
}
/**
* Sets the values for this string configuration attribute.
*
* @param values The set of values for this string configuration attribute.
*
* @throws ConfigException If the provided value set or any of the
* individual values are not acceptable.
*/
throws ConfigException
{
// First check if the set is empty and if that is allowed.
{
if (isRequired())
{
}
if (requiresAdminAction())
{
pendingValues = new ArrayList<>();
}
else
{
}
}
// Next check if the set contains multiple values and if that is allowed.
{
}
// Iterate through all the provided values, make sure that they are
// acceptable, and build the value set.
{
{
}
{
}
}
// Apply this value set to the new active or pending value set.
if (requiresAdminAction())
{
}
else
{
}
}
/**
* 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.
*/
public void applyPendingValues()
{
if (! hasPendingValues())
{
return;
}
super.applyPendingValues();
}
/**
* 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.
*
* @param value The value for which to make the determination.
* @param rejectReason A buffer into which a human-readable reason for the
* reject may be written.
*
* @return <CODE>true</CODE> if the provided value is acceptable for use in
* this attribute, or <CODE>false</CODE> if not.
*/
{
// The only requirement is that the value is not null or empty.
{
return false;
}
return true;
}
/**
* Converts the provided set of strings to a corresponding set of attribute
* values.
*
* @param valueStrings The set of strings to be converted into attribute
* values.
* @param 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
* <CODE>true</CODE> and such a condition is acceptable
* for the underlying attribute type, then the returned
* set of values should simply not include those
* undecodable values.
*
* @return The set of attribute values converted from the provided strings.
*
* @throws ConfigException If an unrecoverable problem occurs while
* performing the conversion.
*/
throws ConfigException
{
{
if (isRequired())
{
}
return new LinkedHashSet<>();
}
{
}
{
{
continue;
}
}
// If this method was configured to continue on error, then it is possible
// that we ended up with an empty list. Check to see if this is a required
// attribute and if so deal with it accordingly.
{
}
return valueSet;
}
{
if (!allowFailures)
{
throw new ConfigException(message);
}
}
/**
* 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 <CODE>stringsToValues</CODE>
* method.
*
* @return The string representations of the set of active values for this
* configuration attribute.
*/
{
return activeValues;
}
/**
* 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 <CODE>stringsToValues</CODE>
* method.
*
* @return The string representations of the set of pending values for this
* configuration attribute, or <CODE>null</CODE> if there are no
* pending values.
*/
{
if (hasPendingValues())
{
return pendingValues;
}
return null;
}
/**
* Retrieves a new configuration attribute of this type that will contain the
* values from the provided attribute.
*
* @param 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.
*
* @return 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).
*/
throws ConfigException
{
for (Attribute a : attributeList)
{
if (a.hasOptions())
{
// This must be the pending value.
if (a.hasOption(OPTION_PENDING_VALUES))
{
if (pendingValues != null)
{
// We cannot have multiple pending value sets.
}
if (a.isEmpty())
{
if (isRequired())
{
// This is illegal -- it must have a value.
}
// This is fine. The pending value set can be empty.
}
else
{
{
// This is illegal -- the attribute is single-valued.
throw new ConfigException(message);
}
for (ByteString v : a)
{
}
}
}
else
{
// This is illegal -- only the pending option is allowed for
// configuration attributes.
}
}
else
{
// This must be the active value.
if (activeValues!= null)
{
// We cannot have multiple active value sets.
}
if (a.isEmpty())
{
if (isRequired())
{
// This is illegal -- it must have a value.
}
// This is fine. The active value set can be empty.
}
else
{
{
// This is illegal -- the attribute is single-valued.
throw new ConfigException(message);
}
for (ByteString v : a)
{
}
}
}
}
if (activeValues == null)
{
// This is not OK. The value set must contain an active value.
throw new ConfigException(message);
}
if (pendingValues == null)
{
// This is OK. We'll just use the active value set.
}
}
/**
* Retrieves a JMX attribute containing the active value set for this
* configuration attribute.
*
* @param pending indicates if pending or active values are required.
*
* @return A JMX attribute containing the active value set for this
* configuration attribute, or <CODE>null</CODE> if it does not have
* any active values.
*/
{
if (pending)
{
}
else
{
}
if (isMultiValued())
{
}
else if (!requestedValues.isEmpty())
{
}
else
{
return null;
}
}
/**
* Retrieves a JMX attribute containing the active value set for this
* configuration attribute.
*
* @return A JMX attribute containing the active value set for this
* configuration attribute, or <CODE>null</CODE> if it does not have
* any active values.
*/
{
return _toJMXAttribute(false) ;
}
/**
* Retrieves a JMX attribute containing the pending value set for this
* configuration attribute.
*
* @return A JMX attribute containing the pending value set for this
* configuration attribute, or <CODE>null</CODE> if it does not have
* any active values.
*/
{
return _toJMXAttribute(true) ;
}
/**
* 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.
*
* @param attributeList The attribute list to which the JMX attribute(s)
* should be added.
*/
{
if (!activeValues.isEmpty())
{
if (isMultiValued())
{
}
else
{
}
}
else
{
if (isMultiValued())
{
new String[0]));
}
else
{
}
}
(pendingValues != activeValues))
{
if (isMultiValued())
{
}
else if (! pendingValues.isEmpty())
{
}
}
}
/**
* Adds information about this configuration attribute to the provided list in
* the form of a JMX <CODE>MBeanAttributeInfo</CODE> 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.
*
* @param attributeInfoList The list to which the attribute information
* should be added.
*/
{
if (requiresAdminAction())
{
}
}
/**
* Retrieves a JMX <CODE>MBeanParameterInfo</CODE> object that describes this
* configuration attribute.
*
* @return A JMX <CODE>MBeanParameterInfo</CODE> object that describes this
* configuration attribute.
*/
public MBeanParameterInfo toJMXParameterInfo()
{
}
{
}
/**
* Attempts to set the value of this configuration attribute based on the
* information in the provided JMX attribute.
*
* @param 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.
*/
throws ConfigException
{
{
}
{
{
try
{
for (int i=0; i < length; i++)
{
}
}
catch (ConfigException ce)
{
throw ce;
}
catch (Exception e)
{
logger.traceException(e);
}
}
else
{
throw new ConfigException(message);
}
}
else
{
}
}
/**
* Creates a duplicate of this configuration attribute.
*
* @return A duplicate of this configuration attribute.
*/
public ConfigAttribute duplicate()
{
}
}