org.omnifaces.config

Enum WebXml

java.lang.Object

java.lang.Enum<WebXml>

org.omnifaces.config.WebXml

All Implemented Interfaces:

Serializable, Comparable<WebXml>

public enum WebXml
extends Enum<WebXml>

This configuration enum parses the /WEB-INF/web.xml and all /META-INF/web-fragment files found in the classpath and offers methods to obtain information from them which is not available by the standard servlet API means.

So far there are only methods for obtaining a mapping of all error page locations by exception type and the location of the FORM authentication login page.

Since:

1.2

Author:

Bauke Scholtz

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Returns the lazily loaded enum singleton instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	findErrorPageLocation(Throwable exception) Find for the given exception the right error page location as per Servlet specification 10.9.2: Make a first pass through all specific exception types.
Map<Class<Throwable>,String>	getErrorPageLocations() Returns a mapping of all error page locations by exception type.
String	getFormLoginPage() Returns the location of the FORM authentication login page, or null if it is not defined.
static WebXml	valueOf(String name) Returns the enum constant of this type with the specified name.
static WebXml[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final WebXml INSTANCE

Returns the lazily loaded enum singleton instance.

Method Detail

values

public static WebXml[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WebXml c : WebXml.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WebXml valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

findErrorPageLocation

public String findErrorPageLocation(Throwable exception)

Find for the given exception the right error page location as per Servlet specification 10.9.2:

• Make a first pass through all specific exception types. If an exact match is found, use its location.
• Else make a second pass through all specific exception types in the order as they are declared in web.xml. If the current exception is an instance of it, then use its location.
• Else use the default error page location, which can be either the java.lang.Throwable or HTTP 500 or default one.

Parameters:

exception - The exception to find the error page location for.

Returns:

The right error page location for the given exception.

getErrorPageLocations

public Map<Class<Throwable>,String> getErrorPageLocations()

Returns a mapping of all error page locations by exception type. The default location is identified by null key.

Returns:

A mapping of all error page locations by exception type.

getFormLoginPage

public String getFormLoginPage()

Returns the location of the FORM authentication login page, or null if it is not defined.

Returns:

The location of the FORM authentication login page, or null if it is not defined.