javax.faces.context
Class ExternalContext

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

public abstract class ExternalContext
extends Object

see Javadoc of JSF Specification

Version:

$Revision: 827879 $ $Date: 2009-10-20 22:10:03 -0500 (Tue, 20 Oct 2009) $

Author:

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

Field Summary

static String	BASIC_AUTH
static String	CLIENT_CERT_AUTH
static String	DIGEST_AUTH
static String	FORM_AUTH

Constructor Summary

ExternalContext()

Method Summary

abstract void	dispatch(String path)
abstract String	encodeActionURL(String url)
abstract String	encodeNamespace(String name)
abstract String	encodeResourceURL(String url)
abstract Map<String,Object>	getApplicationMap()
abstract String	getAuthType()
abstract Object	getContext()
abstract String	getInitParameter(String name)
abstract Map	getInitParameterMap()
abstract String	getRemoteUser()
abstract Object	getRequest()
String	getRequestCharacterEncoding()
String	getRequestContentType()
abstract String	getRequestContextPath()
abstract Map<String,Object>	getRequestCookieMap()
abstract Map<String,String>	getRequestHeaderMap()
abstract Map<String,String[]>	getRequestHeaderValuesMap()
abstract Locale	getRequestLocale()
abstract Iterator<Locale>	getRequestLocales()
abstract Map<String,Object>	getRequestMap()
abstract Map<String,String>	getRequestParameterMap()
abstract Iterator<String>	getRequestParameterNames()
abstract Map<String,String[]>	getRequestParameterValuesMap()
abstract String	getRequestPathInfo()
abstract String	getRequestServletPath()
abstract URL	getResource(String path)
abstract InputStream	getResourceAsStream(String path)
abstract Set<String>	getResourcePaths(String path)
abstract Object	getResponse()
String	getResponseCharacterEncoding()
String	getResponseContentType() throws UnsupportedOperationException by default.
abstract Object	getSession(boolean create)
abstract Map<String,Object>	getSessionMap()
abstract Principal	getUserPrincipal()
abstract boolean	isUserInRole(String role)
abstract void	log(String message)
abstract void	log(String message, Throwable exception)
abstract void	redirect(String url)
void	setRequest(Object request) throws UnsupportedOperationException by default.
void	setRequestCharacterEncoding(String encoding) throws UnsupportedOperationException by default.
void	setResponse(Object response) throws UnsupportedOperationException by default.
void	setResponseCharacterEncoding(String encoding) throws UnsupportedOperationException by default.

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 String BASIC_AUTH

See Also:

Constant Field Values

CLIENT_CERT_AUTH

public static final String CLIENT_CERT_AUTH

See Also:

Constant Field Values

DIGEST_AUTH

public static final String DIGEST_AUTH

See Also:

Constant Field Values

FORM_AUTH

public static final String FORM_AUTH

See Also:

Constant Field Values

Constructor Detail

ExternalContext

public ExternalContext()

Method Detail

dispatch

public abstract void dispatch(String path)
                       throws IOException

Throws:

IOException

encodeActionURL

public abstract String encodeActionURL(String url)

encodeNamespace

public abstract String encodeNamespace(String name)

encodeResourceURL

public abstract String encodeResourceURL(String url)

getApplicationMap

public abstract Map<String,Object> getApplicationMap()

getAuthType

public abstract String getAuthType()

getContext

public abstract Object getContext()

getInitParameter

public abstract String getInitParameter(String name)

getInitParameterMap

public abstract Map getInitParameterMap()

getRemoteUser

public abstract String getRemoteUser()

getRequest

public abstract Object getRequest()

getRequestCharacterEncoding

public String getRequestCharacterEncoding()

getRequestContentType

public String getRequestContentType()

getRequestContextPath

public abstract String getRequestContextPath()

getRequestCookieMap

public abstract Map<String,Object> getRequestCookieMap()

getRequestHeaderMap

public abstract Map<String,String> getRequestHeaderMap()

getRequestHeaderValuesMap

public abstract Map<String,String[]> getRequestHeaderValuesMap()

getRequestLocale

public abstract Locale getRequestLocale()

getRequestLocales

public abstract Iterator<Locale> getRequestLocales()

getRequestMap

public abstract Map<String,Object> getRequestMap()

getRequestParameterMap

public abstract Map<String,String> getRequestParameterMap()

getRequestParameterNames

public abstract Iterator<String> getRequestParameterNames()

getRequestParameterValuesMap

public abstract Map<String,String[]> getRequestParameterValuesMap()

getRequestPathInfo

public abstract String getRequestPathInfo()

getRequestServletPath

public abstract String getRequestServletPath()

getResource

public abstract URL getResource(String path)
                         throws MalformedURLException

Throws:

MalformedURLException

getResourceAsStream

public abstract InputStream getResourceAsStream(String path)

getResourcePaths

public abstract Set<String> getResourcePaths(String path)

getResponse

public abstract Object getResponse()

getResponseContentType

public String getResponseContentType()

throws UnsupportedOperationException by default.

Since:

JSF 1.2

getSession

public abstract Object getSession(boolean create)

getSessionMap

public abstract Map<String,Object> getSessionMap()

getUserPrincipal

public abstract Principal getUserPrincipal()

setRequest

public void setRequest(Object request)

throws UnsupportedOperationException by default.

Parameters:

request -

Since:

JSF 1.2

setRequestCharacterEncoding

public void setRequestCharacterEncoding(String encoding)
                                 throws UnsupportedEncodingException

throws UnsupportedOperationException by default.

Parameters:

encoding -

Throws:

UnsupportedEncodingException

Since:

JSF 1.2

setResponse

public void setResponse(Object response)

throws UnsupportedOperationException by default.

Parameters:

response -

Since:

JSF 1.2

setResponseCharacterEncoding

public void setResponseCharacterEncoding(String encoding)

throws UnsupportedOperationException by default.

Parameters:

encoding -

Since:

JSF 1.2

getResponseCharacterEncoding

public String getResponseCharacterEncoding()

isUserInRole

public abstract boolean isUserInRole(String role)

log

public abstract void log(String message)

log

public abstract void log(String message,
                         Throwable exception)

redirect

public abstract void redirect(String url)
                       throws IOException

Throws:

IOException