net.shibboleth.ext.spring.factory.PatternFactoryBean Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the University Corporation for Advanced Internet Development,
 * Inc. (UCAID) under one or more contributor license agreements.  See the
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID 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 net.shibboleth.ext.spring.factory;

import java.util.regex.Pattern;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.primitive.StringSupport;

/**
 * Factory bean for {@link Pattern}. Allows us to inject property based case sensitivity.
 */
public class PatternFactoryBean extends AbstractComponentAwareFactoryBean {

    /** Whether the we are case sensitive or not. */
    @Nullable private String caseSensitive;

    /** The regular expressions. */
    @Nullable private String regexp;

    /** {@inheritDoc} */
    @Override public Class getObjectType() {
        return Pattern.class;
    }

    /**
     * set case sensitivity.
     * 
     * @return Returns the caseSensitive.
     */
    public String getCaseSensitive() {
        return caseSensitive;
    }

    /**
     * get case sensitivity.
     * 
     * @param what The value to set.
     */
    public void setCaseSensitive(@Nullable final String what) {
        Constraint.isNotNull(what, "caseSensitive cannot be null");
        caseSensitive = what;
    }

    /**
     * Get the regular expression.
     * 
     * @return Returns the regexp.
     */
    @Nullable public String getRegexp() {
        return regexp;
    }

    /**
     * Set the regular expression.
     * 
     * @param what what to set.
     */
    public void setRegexp(@Nonnull final String what) {
        regexp = what;
    }

    /** {@inheritDoc} */
    @Override protected Pattern doCreateInstance() throws Exception {
        Constraint.isNotNull(regexp, "Regular expression cannot be null");
        
        final Boolean isCaseSensitive;
        if (caseSensitive != null) {
            isCaseSensitive = StringSupport.booleanOf(caseSensitive);
            Constraint.isNotNull(isCaseSensitive, "caseSensitive cannot be null");
        } else {
            isCaseSensitive = true;
        }

        return Pattern.compile(regexp, isCaseSensitive ? 0 : Pattern.CASE_INSENSITIVE);
    }

}