jakarta.servlet.jsp.JspApplicationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apache-jsp Show documentation
There is a newer version: 11.0.0
/*
 * 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 jakarta.servlet.jsp;

import jakarta.el.ELContextListener;
import jakarta.el.ELResolver;
import jakarta.el.ExpressionFactory;

/**
 * 
 * Stores application-scoped information for the JSP container.
 * 
 *
 * @since JSP 2.1
 */
public interface JspApplicationContext {

    /**
     * Registers an ELContextListener that will be notified whenever a new ELContext is
     * created.
     * 
     * At the very least, any ELContext instantiated will have reference to the JspContext
     * under JspContext.class.
     *
     * @param listener The listener to add
     */
    void addELContextListener(ELContextListener listener);

    /**
     * 

     * Adds an ELResolver to the chain of EL variable and property management within JSP pages and Tag
     * files.
     * 
     * 
     * JSP has a default set of ELResolvers to chain for all EL evaluation:
     * 
     * 
     * ImplicitObjectELResolver
     * ELResolver instances registered with this method
     * MapELResolver
     * ListELResolver
     * ArrayELResolver
     * BeanELResolver
     * ScopedAttributeELResolver
     * 
     *
     * @param resolver an additional resolver
     *
     * @throws IllegalStateException if called after the application's ServletContextListeners have been
     *                                   initialized.
     */
    void addELResolver(ELResolver resolver);

    /**
     * 
     * Returns the JSP container's ExpressionFactory implementation for EL use.
     * 
     *
     * @return an ExpressionFactory implementation
     */
    ExpressionFactory getExpressionFactory();

}