Class ExternalContext

java.lang.Object
jakarta.faces.context.ExternalContext
Direct Known Subclasses:
ExternalContextWrapper

public abstract class ExternalContext extends Object
see Javadoc of Faces Specification
  • Field Details

  • Constructor Details

    • ExternalContext

      public ExternalContext()
  • Method Details

    • addResponseCookie

      public void addResponseCookie(String name, String value, Map<String,Object> properties)
      Parameters:
      name -
      value -
      properties -
      Since:
      2.0
    • addResponseHeader

      public void addResponseHeader(String name, String value)
      Parameters:
      name -
      value -
      Since:
      2.0
    • dispatch

      public abstract void dispatch(String path) throws IOException
      Throws:
      IOException
    • encodeActionURL

      public abstract String encodeActionURL(String url)
    • encodeBookmarkableURL

      public String encodeBookmarkableURL(String baseUrl, Map<String,List<String>> parameters)
      Parameters:
      baseUrl -
      parameters -
      Since:
      2.0
    • encodeNamespace

      public abstract String encodeNamespace(String name)
    • encodePartialActionURL

      public String encodePartialActionURL(String url)
      Since:
      2.0
    • encodeRedirectURL

      public String encodeRedirectURL(String baseUrl, Map<String,List<String>> parameters)
      Parameters:
      baseUrl -
      parameters -
      Since:
      2.0
    • encodeResourceURL

      public abstract String encodeResourceURL(String url)
    • getApplicationMap

      public abstract Map<String,Object> getApplicationMap()
    • getAuthType

      public abstract String getAuthType()
    • getContext

      public abstract Object getContext()
    • getContextName

      public 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 String getInitParameter(String name)
    • getInitParameterMap

      public abstract Map<String,String> getInitParameterMap()
    • getMimeType

      public String getMimeType(String file)
      Since:
      Faces 2.0
    • getRealPath

      public String getRealPath(String path)
      Since:
      Faces 2.0
    • getRemoteUser

      public abstract String getRemoteUser()
    • getRequest

      public abstract Object getRequest()
    • getRequestCharacterEncoding

      public String getRequestCharacterEncoding()
    • getRequestContentLength

      public int getRequestContentLength()
      Returns:
      Since:
      2.0
    • 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()
    • getRequestScheme

      public String getRequestScheme()
      Since:
      Faces 2.0
    • getRequestServerName

      public String getRequestServerName()
      Since:
      Faces 2.0
    • getRequestServerPort

      public int getRequestServerPort()
      Since:
      Faces 2.0
    • 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()
    • getResponseBufferSize

      public int getResponseBufferSize()
      Returns:
      Since:
      2.0
    • getResponseCharacterEncoding

      public String getResponseCharacterEncoding()
    • getResponseContentType

      public String getResponseContentType()
      throws UnsupportedOperationException by default.
      Since:
      Faces 1.2
    • getResponseOutputStream

      public OutputStream getResponseOutputStream() throws IOException
      Throws:
      IOException
      Since:
      Faces 2.0
    • getResponseOutputWriter

      public Writer getResponseOutputWriter() throws IOException
      Throws:
      IOException
      Since:
      Faces 2.0
    • getSession

      public abstract Object getSession(boolean create)
    • getSessionMap

      public abstract Map<String,Object> getSessionMap()
    • getUserPrincipal

      public abstract Principal getUserPrincipal()
    • invalidateSession

      public void invalidateSession()
      Since:
      2.0
    • isResponseCommitted

      public boolean isResponseCommitted()
      Since:
      2.0
    • isUserInRole

      public abstract boolean isUserInRole(String role)
    • log

      public abstract void log(String message)
      Since:
      2.0
    • log

      public abstract void log(String message, Throwable exception)
      Since:
      2.0
    • redirect

      public abstract void redirect(String url) throws IOException
      Throws:
      IOException
    • responseFlushBuffer

      public void responseFlushBuffer() throws IOException
      Throws:
      IOException
      Since:
      2.0
    • responseReset

      public void responseReset()
      Since:
      2.0
    • responseSendError

      public void responseSendError(int statusCode, String message) throws IOException
      Parameters:
      statusCode -
      message -
      Throws:
      IOException
      Since:
      2.0
    • setRequest

      public void setRequest(Object request)
      throws UnsupportedOperationException by default.
      Parameters:
      request -
      Since:
      Faces 1.2
    • setRequestCharacterEncoding

      public void setRequestCharacterEncoding(String encoding) throws UnsupportedEncodingException
      throws UnsupportedOperationException by default.
      Parameters:
      encoding -
      Throws:
      UnsupportedEncodingException
      Since:
      Faces 1.2
    • setResponse

      public void setResponse(Object response)
      throws UnsupportedOperationException by default.
      Parameters:
      response -
      Since:
      Faces 1.2
    • setResponseBufferSize

      public void setResponseBufferSize(int size)
      Parameters:
      size -
      Since:
      2.0
    • setResponseCharacterEncoding

      public void setResponseCharacterEncoding(String encoding)
      throws UnsupportedOperationException by default.
      Parameters:
      encoding -
      Since:
      Faces 1.2
    • setResponseContentLength

      public void setResponseContentLength(int length)
      Parameters:
      length -
      Since:
      2.0
    • setResponseContentLengthLong

      public void setResponseContentLengthLong(long length)
      Parameters:
      length -
      Since:
      4.1
    • setResponseContentType

      public void setResponseContentType(String contentType)
      Parameters:
      contentType -
      Since:
      2.0
    • setResponseHeader

      public void setResponseHeader(String name, String value)
      Parameters:
      name -
      value -
      Since:
      2.0
    • setResponseStatus

      public void setResponseStatus(int statusCode)
      Parameters:
      statusCode -
      Since:
      2.0
    • isSecure

      public boolean isSecure()
      Returns:
      Since:
      2.1
    • getSessionMaxInactiveInterval

      public int getSessionMaxInactiveInterval()
      Returns:
      Since:
      2.1
    • setSessionMaxInactiveInterval

      public void setSessionMaxInactiveInterval(int interval)
      Parameters:
      interval -
      Since:
      2.1
    • getClientWindow

      public ClientWindow getClientWindow()
      Returns:
      Since:
      2.2
    • setClientWindow

      public void setClientWindow(ClientWindow window)
      Parameters:
      window -
      Since:
      2.2
    • getSessionId

      public String getSessionId(boolean create)
      Parameters:
      create -
      Returns:
      Since:
      2.2
    • getApplicationContextPath

      public String getApplicationContextPath()
      Returns:
      Since:
      2.2
    • encodeWebsocketURL

      public abstract String encodeWebsocketURL(String url)
      Parameters:
      url -
      Returns:
      Since:
      2.3
    • release

      public abstract void release()
      Since:
      4.0