javax.portlet.filter.FilterConfig Maven / Gradle / Ivy

/*  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.
 */
/*
 * NOTE: this source code is based on an early draft version of JSR 286 and not intended for product
 * implementations. This file may change or vanish in the final version of the JSR 286 specification.
 */
/*
 * This source code implements specifications defined by the Java
 * Community Process. In order to remain compliant with the specification
 * DO NOT add / change / or delete method signatures!
 */
/*
 * Copyright 2006 IBM Corporation.
 *
 */
package javax.portlet.filter;



import java.util.Enumeration;

import javax.portlet.PortletContext;

/**
 * A filter configuration object used by a portlet container 
 * to pass information to a filter during initialization.
 *
 * @since 2.0
 */
public interface FilterConfig {

    /**
     * Returns the filter-name of this filter as defined in the 
     * portlet deployment descriptor.
     * 
     * @return  the filter name
     */
    public String getFilterName();
    
    /**
     * Returns a reference to the PortletContext in which the caller is executing.
     * 
     * @return  the portlet context
     */
    public PortletContext getPortletContext();
    
    /**
     * Returns a String containing the value of the named 
     * initialization parameter, or null if the parameter does not exist.
     * 
     * Initialization parameters are defined in the portlet deployment descriptor.
     * 
     * @param name  the name of the initialization parameter to return
     * @return  initialization parameter, or null if the parameter does not exist.  
     */
    public String getInitParameter(String name);
    
    /**
     * Returns the names of the filter's initialization parameters 
     * as an Enumeration of String objects, or an empty Enumeration 
     * if the filter has no initialization parameters.
     * 
     * Initialization parameters are defined in the portlet deployment descriptor.
     * 
     * @return the names of the filter's initialization parameters, 
     *         or an empty Enumeration if the filter has no initialization parameters.
     */
    public Enumeration getInitParameterNames();
}