javax.servlet.descriptor.JspPropertyGroupDescriptor Maven / Gradle / Ivy
/*
* Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package javax.servlet.descriptor;
import java.util.Collection;
/**
* This interface provides access to the
* <jsp-property-group>
* related configuration of a web application.
*
* The configuration is aggregated from the web.xml and
* web-fragment.xml descriptor files of the web application.
*
* @since Servlet 3.0
*/
public interface JspPropertyGroupDescriptor {
/**
* Gets the URL patterns of the JSP property group represented by this
* JspPropertyGroupDescriptor.
*
*
Any changes to the returned Collection must not
* affect this JspPropertyGroupDescriptor.
*
* @return a (possibly empty) Collection of the URL
* patterns of the JSP property group represented by this
* JspPropertyGroupDescriptor
*/
public Collection getUrlPatterns();
/**
* Gets the value of the el-ignored configuration, which
* specifies whether Expression Language (EL) evaluation is enabled for
* any JSP pages mapped to the JSP property group represented by this
* JspPropertyGroupDescriptor.
*
* @return the value of the el-ignored configuration, or
* null if unspecified
*/
public String getElIgnored();
/**
* Gets the value of the page-encoding configuration,
* which specifies the default page encoding for any JSP pages mapped
* to the JSP property group represented by this
* JspPropertyGroupDescriptor.
*
* @return the value of the page-encoding configuration, or
* null if unspecified
*/
public String getPageEncoding();
/**
* Gets the value of the scripting-invalid configuration,
* which specifies whether scripting is enabled for any JSP pages mapped
* to the JSP property group represented by this
* JspPropertyGroupDescriptor.
*
* @return the value of the scripting-invalid configuration,
* or null if unspecified
*/
public String getScriptingInvalid();
/**
* Gets the value of the is-xml configuration, which
* specifies whether any JSP pages mapped to the JSP property group
* represented by this JspPropertyGroupDescriptor will
* be treated as JSP documents (XML syntax).
*
* @return the value of the is-xml configuration, or
* null if unspecified
*/
public String getIsXml();
/**
* Gets the include-prelude configuration
* of the JSP property group represented by this
* JspPropertyGroupDescriptor.
*
* Any changes to the returned Collection must not
* affect this JspPropertyGroupDescriptor.
*
* @return a (possibly empty) Collection of the
* include-prelude configuration of
* the JSP property group represented by this
* JspPropertyGroupDescriptor
*/
public Collection getIncludePreludes();
/**
* Gets the include-coda configuration
* of the JSP property group represented by this
* JspPropertyGroupDescriptor.
*
* Any changes to the returned Collection must not
* affect this JspPropertyGroupDescriptor.
*
* @return a (possibly empty) Collection of the
* include-coda configuration of
* the JSP property group represented by this
* JspPropertyGroupDescriptor
*/
public Collection getIncludeCodas();
/**
* Gets the value of the
* deferred-syntax-allowed-as-literal configuration, which
* specifies whether the character sequence "#{",
* which is normally reserved for Expression Language (EL) expressions,
* will cause a translation error if it appears as a String literal
* in any JSP pages mapped to the JSP property group represented by
* this JspPropertyGroupDescriptor.
*
* @return the value of the
* deferred-syntax-allowed-as-literal configuration, or
* null if unspecified
*/
public String getDeferredSyntaxAllowedAsLiteral();
/**
* Gets the value of the trim-directive-whitespaces
* configuration, which specifies whether template text containing only
* whitespaces must be removed from the response output of any JSP
* pages mapped to the JSP property group represented by this
* JspPropertyGroupDescriptor.
*
* @return the value of the trim-directive-whitespaces
* configuration, or null if unspecified
*/
public String getTrimDirectiveWhitespaces();
/**
* Gets the value of the default-content-type configuration,
* which specifies the default response content type for any JSP pages
* mapped to the JSP property group represented by this
* JspPropertyGroupDescriptor.
*
* @return the value of the default-content-type
* configuration, or null if unspecified
*/
public String getDefaultContentType();
/**
* Gets the value of the buffer configuration, which
* specifies the default size of the response buffer for any JSP pages
* mapped to the JSP property group represented by this
* JspPropertyGroupDescriptor.
*
* @return the value of the buffer configuration, or
* null if unspecified
*/
public String getBuffer();
/**
* Gets the value of the error-on-undeclared-namespace
* configuration, which specifies whether an error will be raised at
* translation time if tag with an undeclared namespace is used in
* any JSP pages mapped to the JSP property group represented by this
* JspPropertyGroupDescriptor.
*
* @return the value of the error-on-undeclared-namespace
* configuration, or null if unspecified
*/
public String getErrorOnUndeclaredNamespace();
}