com.ibm.xsp.context
Class ExternalContextEx

java.lang.Object
  javax.faces.context.ExternalContext
      com.ibm.xsp.context.ExternalContextEx

public class ExternalContextEx
extends javax.faces.context.ExternalContext

Field Summary

Fields inherited from class javax.faces.context.ExternalContext

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

ExternalContextEx(javax.faces.context.ExternalContext delegate)

Method Summary

void	changeParameters(java.util.Map<java.lang.String,java.lang.String> parameters) This is an extension that allows the custom code to change the requestParameterMap with a new set of parameters (=query string).
void	changeParameters(java.lang.String queryString) This is an extension that allows the NavigationHandlerImpl to change the requestParameterMap with a new query string.
void	dispatch(java.lang.String path)
java.lang.String	encodeActionURL(java.lang.String url)
java.lang.String	encodeNamespace(java.lang.String name)
java.lang.String	encodeResourceURL(java.lang.String url)
java.util.Map	getApplicationMap()
java.lang.String	getAuthType()
java.lang.Object	getContext()
com.ibm.xsp.context.Conversation	getConversation() Deprecated. Should not be part of the public API.
javax.faces.context.ExternalContext	getDelegate()
java.lang.String	getHomePage() Get the home page, if any.
java.lang.String	getInitParameter(java.lang.String name)
java.util.Map	getInitParameterMap()
java.lang.String	getRemoteUser()
java.lang.Object	getRequest()
java.lang.String	getRequestContextPath()
java.util.Map	getRequestCookieMap()
java.util.Map	getRequestHeaderMap()
java.util.Map	getRequestHeaderValuesMap()
java.util.Locale	getRequestLocale()
java.util.Iterator	getRequestLocales()
java.util.Map	getRequestMap()
java.util.Map	getRequestParameterMap()
java.util.Iterator	getRequestParameterNames()
java.util.Map	getRequestParameterValuesMap()
java.lang.String	getRequestPathInfo()
java.lang.String	getRequestServletPath()
java.net.URL	getResource(java.lang.String path)
java.io.InputStream	getResourceAsStream(java.lang.String path)
java.util.Set	getResourcePaths(java.lang.String path)
java.lang.Object	getResponse()
java.lang.Object	getSession(boolean create)
java.util.Map	getSessionMap()
java.security.Principal	getUserPrincipal()
boolean	isDonotEncodeUrl()
boolean	isUserInRole(java.lang.String role)
void	log(java.lang.String message)
void	log(java.lang.String message, java.lang.Throwable exception)
void	redirect(java.lang.String url)
void	setDonotEncodeUrl(boolean donotEncodeUrl)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalContextEx

public ExternalContextEx(javax.faces.context.ExternalContext delegate)

Parameters:

delegate - the non-null ExternalContext to delegate to.

Throws:

java.lang.NullPointerException - when the delegate is null.

Method Detail

isDonotEncodeUrl

public boolean isDonotEncodeUrl()

setDonotEncodeUrl

public void setDonotEncodeUrl(boolean donotEncodeUrl)

getDelegate

public javax.faces.context.ExternalContext getDelegate()

getConversation

public com.ibm.xsp.context.Conversation getConversation()

Deprecated. Should not be part of the public API.

Return the current conversation object.

Returns:

getHomePage

public java.lang.String getHomePage()

Get the home page, if any.

Returns:

the home page

changeParameters

public void changeParameters(java.lang.String queryString)

This is an extension that allows the NavigationHandlerImpl to change the requestParameterMap with a new query string.

changeParameters

public void changeParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

This is an extension that allows the custom code to change the requestParameterMap with a new set of parameters (=query string).

dispatch

public void dispatch(java.lang.String path)
              throws java.io.IOException

Specified by:

dispatch in class javax.faces.context.ExternalContext

Throws:

java.io.IOException

encodeActionURL

public java.lang.String encodeActionURL(java.lang.String url)

Specified by:

encodeActionURL in class javax.faces.context.ExternalContext

encodeNamespace

public java.lang.String encodeNamespace(java.lang.String name)

Specified by:

encodeNamespace in class javax.faces.context.ExternalContext

encodeResourceURL

public java.lang.String encodeResourceURL(java.lang.String url)

Specified by:

encodeResourceURL in class javax.faces.context.ExternalContext

getApplicationMap

public java.util.Map getApplicationMap()

Specified by:

getApplicationMap in class javax.faces.context.ExternalContext

getAuthType

public java.lang.String getAuthType()

Specified by:

getAuthType in class javax.faces.context.ExternalContext

getContext

public java.lang.Object getContext()

Specified by:

getContext in class javax.faces.context.ExternalContext

getInitParameter

public java.lang.String getInitParameter(java.lang.String name)

Specified by:

getInitParameter in class javax.faces.context.ExternalContext

getInitParameterMap

public java.util.Map getInitParameterMap()

Specified by:

getInitParameterMap in class javax.faces.context.ExternalContext

getRemoteUser

public java.lang.String getRemoteUser()

Specified by:

getRemoteUser in class javax.faces.context.ExternalContext

getRequest

public java.lang.Object getRequest()

Specified by:

getRequest in class javax.faces.context.ExternalContext

getRequestContextPath

public java.lang.String getRequestContextPath()

Specified by:

getRequestContextPath in class javax.faces.context.ExternalContext

getRequestCookieMap

public java.util.Map getRequestCookieMap()

Specified by:

getRequestCookieMap in class javax.faces.context.ExternalContext

getRequestHeaderMap

public java.util.Map getRequestHeaderMap()

Specified by:

getRequestHeaderMap in class javax.faces.context.ExternalContext

getRequestHeaderValuesMap

public java.util.Map getRequestHeaderValuesMap()

Specified by:

getRequestHeaderValuesMap in class javax.faces.context.ExternalContext

getRequestLocale

public java.util.Locale getRequestLocale()

Specified by:

getRequestLocale in class javax.faces.context.ExternalContext

getRequestLocales

public java.util.Iterator getRequestLocales()

Specified by:

getRequestLocales in class javax.faces.context.ExternalContext

getRequestMap

public java.util.Map getRequestMap()

Specified by:

getRequestMap in class javax.faces.context.ExternalContext

getRequestParameterMap

public java.util.Map getRequestParameterMap()

Specified by:

getRequestParameterMap in class javax.faces.context.ExternalContext

getRequestParameterNames

public java.util.Iterator getRequestParameterNames()

Specified by:

getRequestParameterNames in class javax.faces.context.ExternalContext

getRequestParameterValuesMap

public java.util.Map getRequestParameterValuesMap()

Specified by:

getRequestParameterValuesMap in class javax.faces.context.ExternalContext

getRequestPathInfo

public java.lang.String getRequestPathInfo()

Specified by:

getRequestPathInfo in class javax.faces.context.ExternalContext

getRequestServletPath

public java.lang.String getRequestServletPath()

Specified by:

getRequestServletPath in class javax.faces.context.ExternalContext

getResource

public java.net.URL getResource(java.lang.String path)
                         throws java.net.MalformedURLException

Specified by:

getResource in class javax.faces.context.ExternalContext

Throws:

java.net.MalformedURLException

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String path)

Specified by:

getResourceAsStream in class javax.faces.context.ExternalContext

getResourcePaths

public java.util.Set getResourcePaths(java.lang.String path)

Specified by:

getResourcePaths in class javax.faces.context.ExternalContext

getResponse

public java.lang.Object getResponse()

Specified by:

getResponse in class javax.faces.context.ExternalContext

getSession

public java.lang.Object getSession(boolean create)

Specified by:

getSession in class javax.faces.context.ExternalContext

getSessionMap

public java.util.Map getSessionMap()

Specified by:

getSessionMap in class javax.faces.context.ExternalContext

getUserPrincipal

public java.security.Principal getUserPrincipal()

Specified by:

getUserPrincipal in class javax.faces.context.ExternalContext

isUserInRole

public boolean isUserInRole(java.lang.String role)

Specified by:

isUserInRole in class javax.faces.context.ExternalContext

log

public void log(java.lang.String message)

Specified by:

log in class javax.faces.context.ExternalContext

log

public void log(java.lang.String message,
                java.lang.Throwable exception)

Specified by:

log in class javax.faces.context.ExternalContext

redirect

public void redirect(java.lang.String url)
              throws java.io.IOException

Specified by:

redirect in class javax.faces.context.ExternalContext

Throws:

java.io.IOException