/*
* The contents of this file are subject to the terms of the Common Development and
* Distribution License (the License). You may not use this file except in compliance with the
* License.
*
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
* specific language governing permission and limitations under the License.
*
* When distributing Covered Software, include this CDDL Header Notice in each file and include
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
* Header, with the fields enclosed by brackets [] replaced by your own identifying
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2014-2016 ForgeRock AS.
*/
package com.sun.identity.common.configuration;
import com.sun.identity.sm.ServiceAttributeValidator;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.forgerock.openam.utils.CollectionUtils;
/**
* Validates map value properties in Agent Properties. e.g.
* com.sun.identity.agents.config.response.attribute.mapping[]=
* Map values should be Strings of the form:
* [somekey] = somevalue
* etc
* l.h.s is key value surrounded by brackets
* separator is mandatory "=" equals sign
* r.h.s is some string value, anything since this is not so fined-
* grained to test values of any one specific property's value set.
* r.h.s can be empty or just whitespace
* l.h.s key value can NOT be empty
* l.h.s key values can not be duplicates
* white space is allowed everywhere
* blank or empty values are allowed as some props dont have any value
* to be specified
*
* Some strange examples that would be acceptable values:
* blank or empty set
* [a_key_but_no_value]= (note no value on r.h.s)
* []= (a common default value)
* [ ] = (variation on default value)
* [key_and_or_value_contains_=_sign] == (equal sign is valid data)
*
* Note:
* brackets are not allowed as part of key or value data
* exact duplicate keys are allowed
*
*/
public class DuplicateKeyMapValueValidator implements ServiceAttributeValidator {
private static final String regularExpression = MapValueValidator.KEY_WITH_NO_BRACKETS
+ "|" + MapValueValidator.DEFAULT_NO_KEY_JUST_BRACKETS;
private static final Pattern pattern = Pattern.compile(regularExpression);
/**
* Returns true
if values are of map type format.
*
* @param values contains the set of values to be validated
* @return true
if values are of map type format
*/
@Override
public boolean validate(Set values) {
boolean valid = true; //blank or empty values set are valid
if (!CollectionUtils.isEmpty(values)) {
for (String val : values) {
final String trimmed = val.trim();
if (trimmed.length() > 0) {
Matcher matcher = pattern.matcher(trimmed);
valid = matcher.matches();
}
}
}
return valid;
}
}