SizePropertyDefinition.java revision 998747bfaaa3c6b28bbfaf0e282e6c0ccbf46bc0
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * CDDL HEADER START
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The contents of this file are subject to the terms of the
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Common Development and Distribution License, Version 1.0 only
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * (the "License"). You may not use this file except in compliance
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * with the License.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * or http://forgerock.org/license/CDDLv1.0.html.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * See the License for the specific language governing permissions
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * and limitations under the License.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * When distributing Covered Code, include this CDDL HEADER in each
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * file and include the License file at legal-notices/CDDLv1_0.txt.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * If applicable, add the following below this CDDL HEADER, with the
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * fields enclosed by brackets "[]" replaced with your own identifying
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * information:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Portions Copyright [yyyy] [name of copyright owner]
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * CDDL HEADER END
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Copyright 2008 Sun Microsystems, Inc.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Portions Copyright 2014-2015 ForgeRock AS
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Memory size property definition.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * All memory size property values are represented in bytes using longs.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * All values must be zero or positive and within the lower/upper limit
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * constraints. Support is provided for "unlimited" memory sizes. These are
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * represented using a negative memory size value or using the string
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * "unlimited".
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkpublic final class SizePropertyDefinition extends PropertyDefinition<Long> {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // String used to represent unlimited memory sizes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private static final String UNLIMITED = "unlimited";
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // The lower limit of the property value in bytes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private final long lowerLimit;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // The optional upper limit of the property value in bytes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Indicates whether this property allows the use of the "unlimited" memory
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // size value (represented using a -1L or the string "unlimited").
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private final boolean allowUnlimited;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * An interface for incrementally constructing memory size property
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * definitions.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public static class Builder extends
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // The lower limit of the property value in bytes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // The optional upper limit of the property value in bytes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Indicates whether this property allows the use of the "unlimited" memory
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // size value (represented using a -1L or the string "unlimited").
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private boolean allowUnlimited;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Private constructor
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Set the lower limit in bytes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param lowerLimit
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The new lower limit (must be >= 0) in bytes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @throws IllegalArgumentException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * If a negative lower limit was specified, or if the lower limit
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * is greater than the upper limit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public final void setLowerLimit(long lowerLimit)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw new IllegalArgumentException("Negative lower limit");
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (upperLimit != null && lowerLimit > upperLimit) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk "Lower limit greater than upper limit");
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Set the lower limit using a string representation of the limit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param lowerLimit
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The string representation of the new lower limit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @throws IllegalArgumentException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * If the lower limit could not be parsed, or if a negative lower
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * limit was specified, or the lower limit is greater than the
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * upper limit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public final void setLowerLimit(String lowerLimit)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk setLowerLimit(SizeUnit.parseValue(lowerLimit, SizeUnit.BYTES));
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Set the upper limit in bytes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param upperLimit
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The new upper limit in bytes or <code>null</code> if there is
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * no upper limit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @throws IllegalArgumentException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * If the lower limit is greater than the upper limit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public final void setUpperLimit(Long upperLimit)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw new IllegalArgumentException("Negative upper limit");
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk "Lower limit greater than upper limit");
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Set the upper limit using a string representation of the limit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param upperLimit
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The string representation of the new upper limit, or
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <code>null</code> if there is no upper limit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @throws IllegalArgumentException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * If the upper limit could not be parsed, or if the lower limit
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * is greater than the upper limit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public final void setUpperLimit(String upperLimit)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk setUpperLimit(SizeUnit.parseValue(upperLimit, SizeUnit.BYTES));
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Specify whether or not this property definition will allow unlimited
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * values (default is false).
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param allowUnlimited
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <code>true</code> if the property will allow unlimited values,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * or <code>false</code> otherwise.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public final void setAllowUnlimited(boolean allowUnlimited) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * {@inheritDoc}
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk AbstractManagedObjectDefinition<?, ?> d, String propertyName,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk DefaultBehaviorProvider<Long> defaultBehavior) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk return new SizePropertyDefinition(d, propertyName, options, adminAction,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk defaultBehavior, lowerLimit, upperLimit, allowUnlimited);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Create an memory size property definition builder.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The managed object definition associated with this
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * property definition.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param propertyName
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The property name.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @return Returns the new integer property definition builder.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Private constructor.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk AbstractManagedObjectDefinition<?, ?> d, String propertyName,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk DefaultBehaviorProvider<Long> defaultBehavior, Long lowerLimit,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk super(d, Long.class, propertyName, options, adminAction,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Get the lower limit in bytes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @return Returns the lower limit in bytes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public long getLowerLimit() {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Get the upper limit in bytes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @return Returns the upper limit in bytes or <code>null</code> if there is
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * no upper limit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Determine whether this property allows unlimited memory sizes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @return Returns <code>true</code> if this this property allows unlimited
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * memory sizes.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public boolean isAllowUnlimited() {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * {@inheritDoc}
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public void validateValue(Long value) throws PropertyException {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw PropertyException.illegalPropertyValueException(this, value);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // unlimited allowed
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw PropertyException.illegalPropertyValueException(this, value);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if ((upperLimit != null) && (value > upperLimit)) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw PropertyException.illegalPropertyValueException(this, value);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * {@inheritDoc}
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public String encodeValue(Long value) throws PropertyException {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Make sure that we correctly encode negative values as "unlimited".
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Encode the size value using the best-fit unit.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk SizeUnit unit = SizeUnit.getBestFitUnitExact(value);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Cast to a long to remove fractional part (which should not be there
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // anyway as the best-fit unit should result in an exact conversion).
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * {@inheritDoc}
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // First check for the special "unlimited" value when necessary.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Decode the value.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw PropertyException.illegalPropertyValueException(this, value);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw PropertyException.illegalPropertyValueException(this, value);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * {@inheritDoc}
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk return v.visitSize(this, p);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * {@inheritDoc}
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public <R, P> R accept(PropertyValueVisitor<R, P> v, Long value, P p) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * {@inheritDoc}