ListValueValidator.java revision b58ece2465bd13f7521866ed59e960dc20ea2482
b58ece2465bd13f7521866ed59e960dc20ea2482David Luna * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The contents of this file are subject to the terms
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * of the Common Development and Distribution License
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (the License). You may not use this file except in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compliance with the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * If applicable, add the following below the CDDL Header,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * with the fields enclosed by brackets [] replaced by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * $Id: ListValueValidator.java,v 1.5 2008/06/25 05:42:28 qcheng Exp $
b58ece2465bd13f7521866ed59e960dc20ea2482David Luna * Portions Copyrighted 2016 ForgeRock AS.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport com.sun.identity.sm.ServiceAttributeValidator;
b58ece2465bd13f7521866ed59e960dc20ea2482David Lunaimport org.forgerock.openam.utils.CollectionUtils;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Validates list value in Agent Properties. e.g.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * <code>com.sun.identity.agents.config.login.form[0]=</code>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * List values should be Strings of the form:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * [0] = some value
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * [1] = some value
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * [some sequential index] = some value
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * l.h.s is index value surrounded by brackets
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * separator is mandatory "=" equals sign
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * r.h.s is some string value, anything since this is not so fined
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * grained to test values of any one specific property's value set.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * index value should be an integer >= 0
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * index values can not be duplicates
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * index values collectively can contain missing mubers
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * white space is allowed everywhere (except between digits of index value)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * blank or empty values are allowed as some props dont have any value
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * to be specified
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Some examples that would be acceptable values:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * blank or empty set
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * [0] = (note no value on r.h.s)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpublic class ListValueValidator implements ServiceAttributeValidator {
b58ece2465bd13f7521866ed59e960dc20ea2482David Luna private static final Pattern pattern = Pattern.compile("(\\s*\\[\\s*\\d++\\s*\\]\\s*=.*)");
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns <code>true</code> if values are of list typed.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param values the set of values to be validated
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return <code>true</code> if values are of list format type.
b58ece2465bd13f7521866ed59e960dc20ea2482David Luna boolean valid = true; //blank or empty values set are valid
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster valid = checkForValidIntegerKeyInValue(values);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Values in set are of the form [integerindex]=somevalue and this integer
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * index is later used in code which will create a list array with the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * integer index as the lookup key. So we need to check for the case of
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * duplicate integers, integers must be >= 0
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Note, the integers do not have to be sequential and can skip numbers etc.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * So need to parse values and get the integer index keys and see if valid.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param values must be a valid set of inputs. Must be valid in the sense
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * that each of its values are like [0]=somevalue
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return true if set is good and contains no duplicate keys
b58ece2465bd13f7521866ed59e960dc20ea2482David Luna private boolean checkForValidIntegerKeyInValue(Set<String> values) {
b58ece2465bd13f7521866ed59e960dc20ea2482David Luna boolean valid = true;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster //extract key from whole value