org.apache.cocoon.matching.WildcardParameterMatcher Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.cocoon.matching;

import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.parameters.Parameters;

import java.util.Map;

/**
 * Matches a sitemap parameter against a wildcard expression.
 *
 * Global and local configuration
 * 
 * 
 * parameter-name Name of the sitemap parameter to
 * match against
 *
 * @cocoon.sitemap.component.documentation
 * Matches a sitemap parameter against a wildcard expression.
 *
 * @version $Id: WildcardParameterMatcher.java 607378 2007-12-29 05:36:16Z vgritsenko $
 */
public class WildcardParameterMatcher extends AbstractWildcardMatcher
    implements Configurable
{
    private String defaultParam;

    public void configure(Configuration config) throws ConfigurationException {
        this.defaultParam = config.getChild("parameter-name").getValue(null);
    }

    protected String getMatchString(Map objectModel, Parameters parameters) {

        String paramName = parameters.getParameter("parameter-name", this.defaultParam);
        if (paramName == null) {
            getLogger().warn("No parameter name given. FAILING");
            return null;
        }

        String value = parameters.getParameter(paramName, null);
        if (value == null) {
            getLogger().debug("Parameter '" + paramName + "' not set.");
        }

        return value;
    }
}