javax.faces.context
Class ExternalContext

java.lang.Object
  javax.faces.context.ExternalContext

Direct Known Subclasses:

ExternalContextWrapper

public abstract class ExternalContext
extends java.lang.Object

see Javadoc of JSF Specification

Version:

$Revision: 834291 $ $Date: 2009-11-09 20:14:16 -0500 (Mon, 09 Nov 2009) $

Author:

Manfred Geiler (latest modification by $Author: lu4242 $)

Field Summary

static java.lang.String	BASIC_AUTH
static java.lang.String	CLIENT_CERT_AUTH
static java.lang.String	DIGEST_AUTH
static java.lang.String	FORM_AUTH

Constructor Summary

ExternalContext()

Method Summary

void	addResponseCookie(java.lang.String name, java.lang.String value, java.util.Map<java.lang.String,java.lang.Object> properties)
void	addResponseHeader(java.lang.String name, java.lang.String value)
abstract void	dispatch(java.lang.String path)
abstract java.lang.String	encodeActionURL(java.lang.String url)
java.lang.String	encodeBookmarkableURL(java.lang.String baseUrl, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
abstract java.lang.String	encodeNamespace(java.lang.String name)
java.lang.String	encodePartialActionURL(java.lang.String url)
java.lang.String	encodeRedirectURL(java.lang.String baseUrl, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
abstract java.lang.String	encodeResourceURL(java.lang.String url)
abstract java.util.Map<java.lang.String,java.lang.Object>	getApplicationMap()
abstract java.lang.String	getAuthType()
abstract java.lang.Object	getContext()
java.lang.String	getContextName() Returns the name of the underlying context
Flash	getFlash()
abstract java.lang.String	getInitParameter(java.lang.String name)
abstract java.util.Map	getInitParameterMap()
java.lang.String	getMimeType(java.lang.String file)
java.lang.String	getRealPath(java.lang.String path)
abstract java.lang.String	getRemoteUser()
abstract java.lang.Object	getRequest()
java.lang.String	getRequestCharacterEncoding()
int	getRequestContentLength()
java.lang.String	getRequestContentType()
abstract java.lang.String	getRequestContextPath()
abstract java.util.Map<java.lang.String,java.lang.Object>	getRequestCookieMap()
abstract java.util.Map<java.lang.String,java.lang.String>	getRequestHeaderMap()
abstract java.util.Map<java.lang.String,java.lang.String[]>	getRequestHeaderValuesMap()
abstract java.util.Locale	getRequestLocale()
abstract java.util.Iterator<java.util.Locale>	getRequestLocales()
abstract java.util.Map<java.lang.String,java.lang.Object>	getRequestMap()
abstract java.util.Map<java.lang.String,java.lang.String>	getRequestParameterMap()
abstract java.util.Iterator<java.lang.String>	getRequestParameterNames()
abstract java.util.Map<java.lang.String,java.lang.String[]>	getRequestParameterValuesMap()
abstract java.lang.String	getRequestPathInfo()
java.lang.String	getRequestScheme()
java.lang.String	getRequestServerName()
int	getRequestServerPort()
abstract java.lang.String	getRequestServletPath()
abstract java.net.URL	getResource(java.lang.String path)
abstract java.io.InputStream	getResourceAsStream(java.lang.String path)
abstract java.util.Set<java.lang.String>	getResourcePaths(java.lang.String path)
abstract java.lang.Object	getResponse()
int	getResponseBufferSize()
java.lang.String	getResponseCharacterEncoding()
java.lang.String	getResponseContentType() throws UnsupportedOperationException by default.
java.io.OutputStream	getResponseOutputStream()
java.io.Writer	getResponseOutputWriter()
abstract java.lang.Object	getSession(boolean create)
abstract java.util.Map<java.lang.String,java.lang.Object>	getSessionMap()
abstract java.security.Principal	getUserPrincipal()
void	invalidateSession()
boolean	isResponseCommitted()
abstract boolean	isUserInRole(java.lang.String role)
abstract void	log(java.lang.String message)
abstract void	log(java.lang.String message, java.lang.Throwable exception)
abstract void	redirect(java.lang.String url)
void	responseFlushBuffer()
void	responseReset()
void	responseSendError(int statusCode, java.lang.String message)
void	setRequest(java.lang.Object request) throws UnsupportedOperationException by default.
void	setRequestCharacterEncoding(java.lang.String encoding) throws UnsupportedOperationException by default.
void	setResponse(java.lang.Object response) throws UnsupportedOperationException by default.
void	setResponseBufferSize(int size)
void	setResponseCharacterEncoding(java.lang.String encoding) throws UnsupportedOperationException by default.
void	setResponseContentLength(int length)
void	setResponseContentType(java.lang.String contentType)
void	setResponseHeader(java.lang.String name, java.lang.String value)
void	setResponseStatus(int statusCode)

Methods inherited from class java.lang.Object

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

Field Detail

BASIC_AUTH

public static final java.lang.String BASIC_AUTH

See Also:

Constant Field Values

CLIENT_CERT_AUTH

public static final java.lang.String CLIENT_CERT_AUTH

See Also:

Constant Field Values

DIGEST_AUTH

public static final java.lang.String DIGEST_AUTH

See Also:

Constant Field Values

FORM_AUTH

public static final java.lang.String FORM_AUTH

See Also:

Constant Field Values

Constructor Detail

ExternalContext

public ExternalContext()

Method Detail

addResponseCookie

public void addResponseCookie(java.lang.String name,
                              java.lang.String value,
                              java.util.Map<java.lang.String,java.lang.Object> properties)

Parameters:

name -

value -

properties -

Since:

2.0

addResponseHeader

public void addResponseHeader(java.lang.String name,
                              java.lang.String value)

Parameters:

name -

value -

Since:

2.0

dispatch

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

Throws:

java.io.IOException

encodeActionURL

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

encodeBookmarkableURL

public java.lang.String encodeBookmarkableURL(java.lang.String baseUrl,
                                              java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)

Parameters:

baseUrl -

parameters -

Since:

2.0

encodeNamespace

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

encodePartialActionURL

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

Since:

2.0

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String baseUrl,
                                          java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)

Parameters:

baseUrl -

parameters -

Since:

2.0

encodeResourceURL

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

getApplicationMap

public abstract java.util.Map<java.lang.String,java.lang.Object> getApplicationMap()

getAuthType

public abstract java.lang.String getAuthType()

getContext

public abstract java.lang.Object getContext()

getContextName

public java.lang.String getContextName()

Returns the name of the underlying context

Returns:

the name or null

Since:

2.0

getFlash

public Flash getFlash()

Since:

2.0

getInitParameter

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

getInitParameterMap

public abstract java.util.Map getInitParameterMap()

getMimeType

public java.lang.String getMimeType(java.lang.String file)

Since:

JSF 2.0

getRealPath

public java.lang.String getRealPath(java.lang.String path)

Since:

JSF 2.0

getRemoteUser

public abstract java.lang.String getRemoteUser()

getRequest

public abstract java.lang.Object getRequest()

getRequestCharacterEncoding

public java.lang.String getRequestCharacterEncoding()

getRequestContentLength

public int getRequestContentLength()

Returns:

Since:

2.0

getRequestContentType

public java.lang.String getRequestContentType()

getRequestContextPath

public abstract java.lang.String getRequestContextPath()

getRequestCookieMap

public abstract java.util.Map<java.lang.String,java.lang.Object> getRequestCookieMap()

getRequestHeaderMap

public abstract java.util.Map<java.lang.String,java.lang.String> getRequestHeaderMap()

getRequestHeaderValuesMap

public abstract java.util.Map<java.lang.String,java.lang.String[]> getRequestHeaderValuesMap()

getRequestLocale

public abstract java.util.Locale getRequestLocale()

getRequestLocales

public abstract java.util.Iterator<java.util.Locale> getRequestLocales()

getRequestMap

public abstract java.util.Map<java.lang.String,java.lang.Object> getRequestMap()

getRequestParameterMap

public abstract java.util.Map<java.lang.String,java.lang.String> getRequestParameterMap()

getRequestParameterNames

public abstract java.util.Iterator<java.lang.String> getRequestParameterNames()

getRequestParameterValuesMap

public abstract java.util.Map<java.lang.String,java.lang.String[]> getRequestParameterValuesMap()

getRequestPathInfo

public abstract java.lang.String getRequestPathInfo()

getRequestScheme

public java.lang.String getRequestScheme()

Since:

JSF 2.0

getRequestServerName

public java.lang.String getRequestServerName()

Since:

JSF 2.0

getRequestServerPort

public int getRequestServerPort()

Since:

JSF 2.0

getRequestServletPath

public abstract java.lang.String getRequestServletPath()

getResource

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

Throws:

java.net.MalformedURLException

getResourceAsStream

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

getResourcePaths

public abstract java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)

getResponse

public abstract java.lang.Object getResponse()

getResponseBufferSize

public int getResponseBufferSize()

Returns:

Since:

2.0

getResponseCharacterEncoding

public java.lang.String getResponseCharacterEncoding()

getResponseContentType

public java.lang.String getResponseContentType()

throws UnsupportedOperationException by default.

Since:

JSF 1.2

getResponseOutputStream

public java.io.OutputStream getResponseOutputStream()
                                             throws java.io.IOException

Throws:

java.io.IOException

Since:

JSF 2.0

getResponseOutputWriter

public java.io.Writer getResponseOutputWriter()
                                       throws java.io.IOException

Throws:

java.io.IOException

Since:

JSF 2.0

getSession

public abstract java.lang.Object getSession(boolean create)

getSessionMap

public abstract java.util.Map<java.lang.String,java.lang.Object> getSessionMap()

getUserPrincipal

public abstract java.security.Principal getUserPrincipal()

invalidateSession

public void invalidateSession()

Since:

2.0

isResponseCommitted

public boolean isResponseCommitted()

Since:

2.0

isUserInRole

public abstract boolean isUserInRole(java.lang.String role)

log

public abstract void log(java.lang.String message)

Since:

2.0

log

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

Since:

2.0

redirect

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

Throws:

java.io.IOException

responseFlushBuffer

public void responseFlushBuffer()
                         throws java.io.IOException

Throws:

java.io.IOException

Since:

2.0

responseReset

public void responseReset()

Since:

2.0

responseSendError

public void responseSendError(int statusCode,
                              java.lang.String message)
                       throws java.io.IOException

Parameters:

statusCode -

message -

Throws:

java.io.IOException

Since:

2.0

setRequest

public void setRequest(java.lang.Object request)

throws UnsupportedOperationException by default.

Parameters:

request -

Since:

JSF 1.2

setRequestCharacterEncoding

public void setRequestCharacterEncoding(java.lang.String encoding)
                                 throws java.io.UnsupportedEncodingException

throws UnsupportedOperationException by default.

Parameters:

encoding -

Throws:

java.io.UnsupportedEncodingException

Since:

JSF 1.2

setResponse

public void setResponse(java.lang.Object response)

throws UnsupportedOperationException by default.

Parameters:

response -

Since:

JSF 1.2

setResponseBufferSize

public void setResponseBufferSize(int size)

Parameters:

size -

Since:

2.0

setResponseCharacterEncoding

public void setResponseCharacterEncoding(java.lang.String encoding)

throws UnsupportedOperationException by default.

Parameters:

encoding -

Since:

JSF 1.2

setResponseContentLength

public void setResponseContentLength(int length)

Parameters:

length -

Since:

2.0

setResponseContentType

public void setResponseContentType(java.lang.String contentType)

Parameters:

contentType -

Since:

2.0

setResponseHeader

public void setResponseHeader(java.lang.String name,
                              java.lang.String value)

Parameters:

name -

value -

Since:

2.0

setResponseStatus

public void setResponseStatus(int statusCode)

Parameters:

statusCode -

Since:

2.0