/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.controller.operations.validation;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.jboss.as.controller.logging.ControllerLogger;
import org.jboss.as.controller.OperationFailedException;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.ModelType;
/**
* {@link org.jboss.as.controller.operations.validation.ParameterValidator} that validates the value is a string matching
* one of the {@link java.lang.Enum} types.
*
* @author Jason T. Greene
* @author Brian Stansberry
* @author <a href="mailto:jperkins@redhat.com">James R. Perkins</a>
*/
public class EnumValidator<E extends Enum<E>> extends ModelTypeValidator implements AllowedValuesValidator {
private final EnumSet<E> allowedValues;
private final Class<E> enumType;
private final Map<String, E> toStringMap = new HashMap<String, E>();
@SafeVarargs
public EnumValidator(final Class<E> enumType, final boolean nullable, final E... allowed) {
this(enumType, nullable, false, allowed);
}
public EnumValidator(final Class<E> enumType, final boolean nullable, final boolean allowExpressions) {
super(ModelType.STRING, nullable, allowExpressions);
this.enumType = enumType;
allowedValues = EnumSet.allOf(enumType);
for (E value : allowedValues) {
toStringMap.put(value.toString(), value);
}
}
@SafeVarargs
public EnumValidator(final Class<E> enumType, final boolean nullable, final boolean allowExpressions, final E... allowed) {
super(ModelType.STRING, nullable, allowExpressions);
this.enumType = enumType;
allowedValues = EnumSet.noneOf(enumType);
for (E value : allowed) {
allowedValues.add(value);
toStringMap.put(value.toString(), value);
}
}
/**
* Creates a new validator for the enum type with the allowed values defined in the {@code allowed} parameter.
*
* @param enumType the type of the enum.
* @param nullable {@code true} if the value is allowed to be {@code null}, otherwise {@code false}.
* @param allowed the enum values that are allowed.
* @param <E> the type of the enum.
*
* @return a new validator.
*/
@SafeVarargs
public static <E extends Enum<E>> EnumValidator<E> create(final Class<E> enumType, final boolean nullable, final E... allowed) {
return new EnumValidator<E>(enumType, nullable, allowed);
}
/**
* Creates a new validator for the enum type with all values of the enum allowed.
*
* @param enumType the type of the enum.
* @param nullable {@code true} if the value is allowed to be {@code null}, otherwise {@code false}.
* @param allowExpressions {@code true} if an expression is allowed to define the value, otherwise {@code false}.
* @param <E> the type of the enum.
*
* @return a new validator.
*/
public static <E extends Enum<E>> EnumValidator<E> create(final Class<E> enumType, final boolean nullable, final boolean allowExpressions) {
return new EnumValidator<E>(enumType, nullable, allowExpressions);
}
/**
* Creates a new validator for the enum type with the allowed values defined in the {@code allowed} parameter.
*
* @param enumType the type of the enum.
* @param nullable {@code true} if the value is allowed to be {@code null}, otherwise {@code false}.
* @param allowExpressions {@code true} if an expression is allowed to define the value, otherwise {@code false}.
* @param allowed the enum values that are allowed.
* @param <E> the type of the enum.
*
* @return a new validator.
*/
@SafeVarargs
public static <E extends Enum<E>> EnumValidator<E> create(final Class<E> enumType, final boolean nullable, final boolean allowExpressions, final E... allowed) {
return new EnumValidator<E>(enumType, nullable, allowExpressions, allowed);
}
@Override
public void validateParameter(String parameterName, ModelNode value) throws OperationFailedException {
super.validateParameter(parameterName, value);
ModelType type = value.getType();
if (type == ModelType.STRING || type == ModelType.EXPRESSION) {
String tuString = value.resolve().asString(); // Sorry, no support for resolving against vault!
E enumValue;
try {
enumValue = Enum.valueOf(enumType, tuString.toUpperCase(Locale.ENGLISH));
} catch (IllegalArgumentException e) {
// valueof failed - are we using the toString representation of the Enum type?
enumValue = toStringMap.get(tuString);
}
if (enumValue == null || !allowedValues.contains(enumValue)) {
throw ControllerLogger.ROOT_LOGGER.invalidEnumValue(tuString, parameterName, toStringMap.keySet());
}
// Hack to store the allowed value in the model, not the user input
if (type != ModelType.EXPRESSION) {
try {
value.set(enumValue.toString());
} catch (Exception e) {
// node must be protected.
}
}
}
}
@Override
public List<ModelNode> getAllowedValues() {
List<ModelNode> result = new ArrayList<ModelNode>();
for (E value : allowedValues) {
if (value.toString() != null) {
result.add(new ModelNode().set(value.toString()));
} else {
result.add(new ModelNode().set(value.name()));
}
}
return result;
}
}