com.ocpsoft.pretty.faces.config

Class PrettyConfig

java.lang.Object

com.ocpsoft.pretty.faces.config.PrettyConfig

public class PrettyConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_REQUEST_KEY

Constructor Summary

Constructors

Constructor and Description
PrettyConfig() Creates an empty PrettyConfig object

Method Summary

Methods

Modifier and Type	Method and Description
String	getDynaviewId() Get the current DynaView ID.
List<RewriteRule>	getGlobalRewriteRules() Return the currently configured List of RewriteRule as an unmodifiable collection.
UrlMapping	getMappingById(String id) Get the UrlMapping corresponding with the given mapping id.
UrlMapping	getMappingForUrl(URL url) Search through all currently configured UrlMapping objects for the first one that matches the given URL.
List<UrlMapping>	getMappings() Get the currently configured list of UrlMapping as an unmodifiable List
boolean	isMappingId(String id) Discover if the given id is a UrlMapping id specified in the current configuration.
boolean	isURLMapped(URL url) Discover if the given URL is mapped by any UrlMapping specified in the current configuration.
boolean	isUseEncodeUrlForRedirects()
boolean	isViewMapped(String viewId) Discover if the given ViewId is mapped by any UrlMapping specified in the current configuration.
void	setDynaviewId(String facesDynaViewId) Set the current DynaView ID.
void	setGlobalRewriteRules(List<RewriteRule> rules) Set the current list of RewriteRule objects.
void	setMappings(List<UrlMapping> mappings) Set the currently configured list of UrlMapping
void	setUseEncodeUrlForRedirects(boolean useEncodeUrlForRedirects)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_REQUEST_KEY

public static final String CONFIG_REQUEST_KEY

See Also:

Constant Field Values

Constructor Detail

PrettyConfig

public PrettyConfig()

Creates an empty PrettyConfig object

Method Detail

setDynaviewId

public void setDynaviewId(String facesDynaViewId)

Set the current DynaView ID. This is used when calculating dynamic viewIds specified in pretty-config.xml (Do not change unless you know what you are doing - this maps directly to your Faces Servlet mapping and is discovered automatically when the rewrite system starts up.

getDynaviewId

public String getDynaviewId()

Get the current DynaView ID. This is the viewId to which PrettyFilter will issue a servlet forward when the developer has requested a dynamic view-id in a url-mapping.

getGlobalRewriteRules

public List<RewriteRule> getGlobalRewriteRules()

Return the currently configured List of RewriteRule as an unmodifiable collection.

setGlobalRewriteRules

public void setGlobalRewriteRules(List<RewriteRule> rules)

Set the current list of RewriteRule objects.

getMappings

public List<UrlMapping> getMappings()

Get the currently configured list of UrlMapping as an unmodifiable List

setMappings

public void setMappings(List<UrlMapping> mappings)

Set the currently configured list of UrlMapping

getMappingForUrl

public UrlMapping getMappingForUrl(URL url)

Search through all currently configured UrlMapping objects for the first one that matches the given URL.

Returns:

the first appropriate UrlMapping for a given URL.

isMappingId

public boolean isMappingId(String id)

Discover if the given id is a UrlMapping id specified in the current configuration.

Returns:

True if the id is found, false if not.

isURLMapped

public boolean isURLMapped(URL url)

Discover if the given URL is mapped by any UrlMapping specified in the current configuration.

Returns:

True if the URL is mapped, false if not.

isViewMapped

public boolean isViewMapped(String viewId)

Discover if the given ViewId is mapped by any UrlMapping specified in the current configuration.

Note:This will not match if a #{dynamicView.id} method is configured.

Returns:

True if the ViewId is mapped, false if not.

getMappingById

public UrlMapping getMappingById(String id)

Get the UrlMapping corresponding with the given mapping id.

Parameters:

id - Mapping id

Returns:

PrettyUrlMapping Corresponding mapping

isUseEncodeUrlForRedirects

public boolean isUseEncodeUrlForRedirects()

setUseEncodeUrlForRedirects

public void setUseEncodeUrlForRedirects(boolean useEncodeUrlForRedirects)

toString

public String toString()

Overrides:

toString in class Object