Module org.apache.wicket.util

Package org.apache.wicket.util.file

Class WebXmlFile

java.lang.Object

org.apache.wicket.util.file.WebXmlFile

public class WebXmlFile
extends Object

A utility class providing helper methods in dealing with web.xml

Author:

jcompagner, Juergen Donnerstag

Constructor Summary

Constructors

Constructor	Description
WebXmlFile()	Construct.

Method Summary

Modifier and Type	Method	Description
final Set<String>	getFilterPath(boolean isServlet, jakarta.servlet.ServletContext servletContext, String filterName)	Gets Wicket filter path via ServletContext and the filter name
final Set<String>	getFilterPath(boolean isServlet, String filterName, InputStream is)	Gets Wicket filter path via filter name and InputStream.
final String	getUniqueFilterPath(boolean isServlet, jakarta.servlet.FilterConfig filterConfig)	Gets unique Wicket filter path via FilterConfig
final String	getUniqueFilterPath(boolean isServlet, String filterName, InputStream is)	Gets unique filter path via filter name and InputStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebXmlFile

public WebXmlFile()

Construct.

Method Details

getUniqueFilterPath

public final String getUniqueFilterPath(boolean isServlet,
 jakarta.servlet.FilterConfig filterConfig)

Gets unique Wicket filter path via FilterConfig

Parameters:

isServlet - true if Servlet, false if Filter

filterConfig -

Returns:

Filter path retrieved from "url-pattern". Null if not found or error occurred

getFilterPath

public final Set<String> getFilterPath(boolean isServlet,
 jakarta.servlet.ServletContext servletContext,
 String filterName)

Gets Wicket filter path via ServletContext and the filter name

Parameters:

isServlet - true if Servlet, false if Filter

servletContext -

filterName -

Returns:

Filter paths retrieved from "url-pattern"

getUniqueFilterPath

public final String getUniqueFilterPath(boolean isServlet,
 String filterName,
 InputStream is)
                                 throws ParserConfigurationException,
SAXException,
IOException

Gets unique filter path via filter name and InputStream.

Parameters:

isServlet - true if Servlet, false if Filter

filterName -

is - The web.xml file

Returns:

Filter path retrieved from "url-pattern". Null if not found.

Throws:

ParserConfigurationException

IOException

SAXException

See Also:

• getFilterPath(boolean, String, java.io.InputStream)

getFilterPath

public final Set<String> getFilterPath(boolean isServlet,
 String filterName,
 InputStream is)
                                throws ParserConfigurationException,
SAXException,
IOException

Gets Wicket filter path via filter name and InputStream. The InputStream is assumed to be an web.xml file.

A typical Wicket web.xml entry looks like:

 
 <filter>
   <filter-name>HelloWorldApplication</filter-name>
   <filter-class>org.apache.wicket.protocol.http.WicketFilter</filter-class>
   <init-param>
     <param-name>applicationClassName</param-name>
     <param-value>org.apache.wicket.examples.helloworld.HelloWorldApplication</param-value>
   </init-param>
 </filter>
 
 <filter-mapping>
   <filter-name>HelloWorldApplication</filter-name>
   <url-pattern>/helloworld/*</url-pattern>
   <dispatcher>REQUEST</dispatcher>
   <dispatcher>INCLUDE</dispatcher>
 </filter-mapping>
 
 

Parameters:

isServlet - true if Servlet, false if Filter

filterName -

is - The web.xml file

Returns:

Filter paths retrieved from "url-pattern".

Throws:

ParserConfigurationException

IOException

SAXException