javax.faces.context
Class ExternalContext

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

public abstract class ExternalContext
extends java.lang.Object

see Javadoc of JSF Specification

Version:
$Revision: 513685 $ $Date: 2007-03-02 11:12:05 +0100 (Fr, 02 Mär 2007) $
Author:
Manfred Geiler (latest modification by $Author: mbr $)

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
abstract  void dispatch(java.lang.String path)
           
abstract  java.lang.String encodeActionURL(java.lang.String url)
           
abstract  java.lang.String encodeNamespace(java.lang.String name)
           
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()
           
abstract  java.lang.String getInitParameter(java.lang.String name)
           
abstract  java.util.Map getInitParameterMap()
           
abstract  java.lang.String getRemoteUser()
           
abstract  java.lang.Object getRequest()
           
 java.lang.String getRequestCharacterEncoding()
           
 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()
           
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()
           
 java.lang.String getResponseCharacterEncoding()
           
 java.lang.String getResponseContentType()
          throws UnsupportedOperationException by default.
abstract  java.lang.Object getSession(boolean create)
           
abstract  java.util.Map<java.lang.String,java.lang.Object> getSessionMap()
           
abstract  java.security.Principal getUserPrincipal()
           
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 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 setResponseCharacterEncoding(java.lang.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 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

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)

encodeNamespace

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

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()

getInitParameter

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

getInitParameterMap

public abstract java.util.Map getInitParameterMap()

getRemoteUser

public abstract java.lang.String getRemoteUser()

getRequest

public abstract java.lang.Object getRequest()

getRequestCharacterEncoding

public java.lang.String getRequestCharacterEncoding()

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()

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()

getResponseContentType

public java.lang.String getResponseContentType()
throws UnsupportedOperationException by default.

Since:
JSF 1.2

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()

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

setResponseCharacterEncoding

public void setResponseCharacterEncoding(java.lang.String encoding)
throws UnsupportedOperationException by default.

Parameters:
encoding -
Since:
JSF 1.2

getResponseCharacterEncoding

public java.lang.String getResponseCharacterEncoding()

isUserInRole

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

log

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

log

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

redirect

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


Copyright © 2010 Apache Software Foundation. All Rights Reserved.