Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> faces >> [ webapp overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.faces.webapp
Class FacesServlet  

java.lang.Object
  javax.faces.webapp.FacesServlet

All Implemented Interfaces:

javax.servlet.Servlet

---

public final class FacesServlet

extends java.lang.Object

implements javax.servlet.Servlet

Version:

$Revision: 294841 $ $Date: 2005-10-04 13:13:34 -0400 (Tue, 04 Oct 2005) $

---

Field Summary
private  javax.faces.context.FacesContextFactory	_facesContextFactory
private  javax.faces.lifecycle.Lifecycle	_lifecycle
private  javax.servlet.ServletConfig	_servletConfig
static java.lang.String	CONFIG_FILES_ATTR
static java.lang.String	LIFECYCLE_ID_ATTR
private static org.apache.commons.logging.Log	log
private static java.lang.String	SERVLET_INFO

 

Constructor Summary

FacesServlet()

 

Method Summary
void	destroy()           Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
private  java.lang.String	getLifecycleId()
javax.servlet.ServletConfig	getServletConfig()           Returns a javax.servlet.ServletConfig object, which contains initialization and startup parameters for this servlet.
java.lang.String	getServletInfo()           Returns information about the servlet, such as author, version, and copyright.
void	init(javax.servlet.ServletConfig servletConfig)           Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
void	service(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)           Called by the servlet container to allow the servlet to respond to a request.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

log

private static final org.apache.commons.logging.Log log

---

CONFIG_FILES_ATTR

public static final java.lang.String CONFIG_FILES_ATTR

See Also:

Constant Field Values

---

LIFECYCLE_ID_ATTR

public static final java.lang.String LIFECYCLE_ID_ATTR

See Also:

Constant Field Values

---

SERVLET_INFO

private static final java.lang.String SERVLET_INFO

See Also:

Constant Field Values

---

_servletConfig

private javax.servlet.ServletConfig _servletConfig

---

_facesContextFactory

private javax.faces.context.FacesContextFactory _facesContextFactory

---

_lifecycle

private javax.faces.lifecycle.Lifecycle _lifecycle

Constructor Detail

FacesServlet

public FacesServlet()

Method Detail

destroy

public void destroy()

Description copied from interface: javax.servlet.Servlet

Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. This method is only called once all threads within the servlet's service method have exited or after a timeout period has passed. After the servlet container calls this method, it will not call the service method again on this servlet.

This method gives the servlet an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the servlet's current state in memory.

Specified by:

destroy in interface javax.servlet.Servlet

---

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

Description copied from interface: javax.servlet.Servlet

Returns a javax.servlet.ServletConfig object, which contains initialization and startup parameters for this servlet. The ServletConfig object returned is the one passed to the init method.

Implementations of this interface are responsible for storing the ServletConfig object so that this method can return it. The javax.servlet.GenericServlet class, which implements this interface, already does this.

Specified by:

getServletConfig in interface javax.servlet.Servlet

---

getServletInfo

public java.lang.String getServletInfo()

Description copied from interface: javax.servlet.Servlet

Returns information about the servlet, such as author, version, and copyright.

The string that this method returns should be plain text and not markup of any kind (such as HTML, XML, etc.).

Specified by:

getServletInfo in interface javax.servlet.Servlet

---

getLifecycleId

private java.lang.String getLifecycleId()

---

init

public void init(javax.servlet.ServletConfig servletConfig)
          throws javax.servlet.ServletException

Description copied from interface: javax.servlet.Servlet

Called by the servlet container to indicate to a servlet that the servlet is being placed into service.

The servlet container calls the init method exactly once after instantiating the servlet. The init method must complete successfully before the servlet can receive any requests.

The servlet container cannot place the servlet into service if the init method

1. Throws a ServletException
2. Does not return within a time period defined by the Web server

Specified by:

init in interface javax.servlet.Servlet

---

service

public void service(javax.servlet.ServletRequest request,
                    javax.servlet.ServletResponse response)
             throws java.io.IOException,
                    javax.servlet.ServletException

Description copied from interface: javax.servlet.Servlet

Called by the servlet container to allow the servlet to respond to a request.

This method is only called after the servlet's init() method has completed successfully.

The status code of the response always should be set for a servlet that throws or sends an error.

Servlets typically run inside multithreaded servlet containers that can handle multiple requests concurrently. Developers must be aware to synchronize access to any shared resources such as files, network connections, and as well as the servlet's class and instance variables. More information on multithreaded programming in Java is available in the Java tutorial on multi-threaded programming.

Specified by:

service in interface javax.servlet.Servlet

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> faces >> [ webapp overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---