com.ocpsoft.pretty

Class PrettyContext

java.lang.Object

com.ocpsoft.pretty.PrettyContext

All Implemented Interfaces:

Serializable

public class PrettyContext
extends Object
implements Serializable

Author:

Lincoln Baxter, III

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_KEY
static String	PRETTY_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrettyContext(HttpServletRequest request) Must create instance through the initialize() method

Method Summary

Methods

Modifier and Type	Method and Description
PrettyConfig	getConfig() Get the pretty-config.xml configurations as loaded by PrettyConfigurator (This can be dynamically manipulated at runtime in order to change or add any mappings.
String	getContextPath()
static PrettyContext	getCurrentInstance() Get the current PrettyFaces context object, or construct a new one if it does not yet exist for this request.
static PrettyContext	getCurrentInstance(FacesContext context) Get the current PrettyFaces context object, or construct a new one if it does not yet exist for this request.
static PrettyContext	getCurrentInstance(HttpServletRequest request) Get the current PrettyContext, or construct a new one if it does not yet exist for this request.
UrlMapping	getCurrentMapping() Get the UrlMapping representing the current request.
String	getCurrentViewId() Return the current viewId to which the current request will be forwarded to JSF.
String	getDynaViewId()
QueryString	getRequestQueryString() Return the QueryString representing the query-string with which this request was populated.
URL	getRequestURL() Return the URL representing the path with which this request was populated.
boolean	isDynaviewProcessed() Return true if the current request has already processed the DynaView life-cycle.
boolean	isInNavigation() Return whether or not this faces application is in the Navigation State
static boolean	isInstantiated(ServletRequest request) Return true if there is an instantiated PrettyContext contained in the current given request object.
boolean	isPrettyRequest() Determine if this request URL is mapped by PrettyFaces
static PrettyContext	newDetachedInstance(HttpServletRequest request) Package private -- only PrettyFilter should be calling this method -- it does not overwrite existing contexts in Request object
void	sendError(int code) Sends an error response to the client using the specified HTTP status code.
void	sendError(int code, String message) Sends an error response to the client using the specified HTTP status code.
void	sendError(int code, String message, HttpServletResponse response) Sends an error response to the client using the specified HTTP status code.
static void	setCurrentContext(HttpServletRequest request, PrettyContext prettyContext) Package private -- only PrettyFilter or this class should be calling this method -- it overwrites existing contexts in Request object
void	setDynaviewProcessed(boolean value)
void	setInNavigation(boolean value) Set whether or not to treat this request as if it is in the Navigation State
boolean	shouldProcessDynaview()
String	stripContextPath(String uri) If the given URL is prefixed with this request's context-path, return the URI without the context path.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_KEY

public static final String CONFIG_KEY

See Also:

Constant Field Values

PRETTY_PREFIX

public static final String PRETTY_PREFIX

See Also:

Constant Field Values

Constructor Detail

PrettyContext

protected PrettyContext(HttpServletRequest request)

Must create instance through the initialize() method

Method Detail

getCurrentInstance

public static PrettyContext getCurrentInstance()

Get the current PrettyFaces context object, or construct a new one if it does not yet exist for this request. (Delegates to FacesContext.getCurrentInstance() to retrieve the current HttpServletRequest object)

Returns:

current context instance

getCurrentInstance

public static PrettyContext getCurrentInstance(FacesContext context)

Get the current PrettyFaces context object, or construct a new one if it does not yet exist for this request. (Delegates to FacesContext to retrieve the current HttpServletRequest object)

Returns:

current context instance

getCurrentInstance

public static PrettyContext getCurrentInstance(HttpServletRequest request)

Get the current PrettyContext, or construct a new one if it does not yet exist for this request.

Returns:

current context instance

isInstantiated

public static boolean isInstantiated(ServletRequest request)

Return true if there is an instantiated PrettyContext contained in the current given request object.

newDetachedInstance

public static PrettyContext newDetachedInstance(HttpServletRequest request)

Package private -- only PrettyFilter should be calling this method -- it does not overwrite existing contexts in Request object

setCurrentContext

public static void setCurrentContext(HttpServletRequest request,
                     PrettyContext prettyContext)

Package private -- only PrettyFilter or this class should be calling this method -- it overwrites existing contexts in Request object

getRequestURL

public URL getRequestURL()

Return the URL representing the path with which this request was populated. (Does not include context-path.)

getRequestQueryString

public QueryString getRequestQueryString()

Return the QueryString representing the query-string with which this request was populated.

Returns:

isPrettyRequest

public boolean isPrettyRequest()

Determine if this request URL is mapped by PrettyFaces

getContextPath

public String getContextPath()

stripContextPath

public String stripContextPath(String uri)

If the given URL is prefixed with this request's context-path, return the URI without the context path. Otherwise return the URI unchanged.

getConfig

public PrettyConfig getConfig()

Get the pretty-config.xml configurations as loaded by PrettyConfigurator (This can be dynamically manipulated at runtime in order to change or add any mappings.

getCurrentMapping

public UrlMapping getCurrentMapping()

Get the UrlMapping representing the current request.

getCurrentViewId

public String getCurrentViewId()

Return the current viewId to which the current request will be forwarded to JSF.

isInNavigation

public boolean isInNavigation()

Return whether or not this faces application is in the Navigation State

setInNavigation

public void setInNavigation(boolean value)

Set whether or not to treat this request as if it is in the Navigation State

shouldProcessDynaview

public boolean shouldProcessDynaview()

Returns:

True if the current mapping and request should trigger DynaView capabilities.

isDynaviewProcessed

public boolean isDynaviewProcessed()

Return true if the current request has already processed the DynaView life-cycle.

setDynaviewProcessed

public void setDynaviewProcessed(boolean value)

getDynaViewId

public String getDynaViewId()

sendError

public void sendError(int code)

Sends an error response to the client using the specified HTTP status code.

Please note that this method can only be called from within the JSF lifecycle as it needs the FacesContext to obtain the HttpServletResponse. Please use sendError(int, String, HttpServletResponse) in all other cases.

Parameters:

code - the error status code

See Also:

HttpServletResponse.sendError(int, String)

sendError

public void sendError(int code,
             String message)

Sends an error response to the client using the specified HTTP status code.

Please note that this method can only be called from within the JSF lifecycle as it needs the FacesContext to obtain the HttpServletResponse. Please use sendError(int, String, HttpServletResponse) in all other cases.

Parameters:

code - the error status code

message - the descriptive message

See Also:

HttpServletResponse.sendError(int, String)

sendError

public void sendError(int code,
             String message,
             HttpServletResponse response)

Sends an error response to the client using the specified HTTP status code.

Parameters:

code - the error status code

message - the descriptive message

response -

See Also:

HttpServletResponse.sendError(int, String)