/*
 * Copyright 2017 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed 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.jbpm.designer.web.filter;

import javax.servlet.Filter;
import javax.servlet.ServletException;

/**
 * @author Antoine Toulme
 *         <p>
 *         the interface for creating servlet filters.
 */
public interface IFilterFactory {

    /**
     * Creates the filter to add to the web application
     * @return a servlet filter
     */
    public Filter createFilter();

    /**
     * Initiates the filter config.
     * @param config a configurable FilterConfig object to let the user
     * change settings, since he didn't have access to web.xml.
     * @throws javax.servlet.ServletException
     */
    public void configureFilterConfig(ConfigurableFilterConfig config) throws ServletException;
}
