| Home >> All >> org >> enhydra >> [ servlet Javadoc ] |
• org.enhydra.servlet: Javadoc index of package org.enhydra.servlet.
Package Samples:
• org.enhydra.servlet.debug
• org.enhydra.servlet.connectionMethods.EnhydraDirector
• org.enhydra.servlet.connectionMethods
• org.enhydra.servlet.connectionMethods.http
• org.enhydra.servlet.connectionMethods.https
• org.enhydra.servlet.filter
• org.enhydra.servlet.servletManager
• org.enhydra.servlet.servlets
• org.enhydra.servlet.tomcat
Classes:
• MultiServerFilter: This is the base class for filters specified by the administrator in the MultiServer config file. Any filter specified in the MultiServer config file must have two propeties: it must implement the TransactionFilter interface, and it must have a constructor that takes a string and a KeywordValueTable. This abstract class provides these for you, which is why it is recommended that you extend this class if you need to write your own filter for the MultiServer. However, it is possible that a filter absolutly must extend some other class (for example, the RMI connection method can not extend StandardConnectionMethod ...
• ConnectionMethod: A ConnectionMethod is how requests get into the server from the outside world. This interface defines the API an object must implement in order to be administered by the server. Each ConnectionMethod must maintain an ordered list of "channels". Each channel has an ID (a String), used to identify and refer to the channel. See addChannel() , below. Each channel can be enabled or disabled. When disabled, connections must be refused, and not passed on to any servlets. When enabled, connections are allowed through to the destination servlet. Each channel also contains an ordered list of TransactionFilters, ...
• ServletContainer: Handles requests for Servlets. Multiple connection methods may be routed to one Servlet, or one connection method may direct requests to multiple Servlets (based on URL). Servlets or Enhydra applications (which are a special kind of servlet) or Servlet 2.2 Web applications may be served. This class uses a ServletManager to hold a set of Servlets, a ConnectionMethodManager to hold a set of ConnectionMethods, and a FilterManager to hold a set of Filters. These are available to other classes (for example the admin application). At startup time a configuration file is read, and it describes what ConnectionMethods ...
• DebugManager: Servlet debug manager for monitoring servlet I/O. An instance of this object monitors a single servlet instance. A fixed-sized queue of servlet transaction records is maintained. As a transaction is completed by the servlet, a record is added to the end of the queue. If the queue has reached its maximum size, an element is removed from the head of the queue. Applications wishing to monitor servlet transactions registers with this object and is called when objects are added or removed from the queue. Calling on removal is necessary as one of the main goals of this class is to support presentations ...
• EnhydraDirectorBufferedOutputStream: Extension of BufferedOutputStream to allow "reset" of the buffer. A servlet container's ServletResponse object should not go into the "committed" (data sent) state until the headers have actually been sent over the wire. This allows a servlet to specify a large buffer size and be able to reset or change headers well after the first byte of data has been written to the ServletOutputStream . This class has a reset() that, after checking for committed state of the connection, discards any buffered data and self destructs, dropping any reference to its internally held output stream. Once reset() has ...
• Filter: This replaces the BasicTransactionFilter. Also note that the BasicTransactionServlet is no longer used and that it is functionally replaced by implementing the org.apache.tomcat.core.LifecycleInterceptor and org.apache.tomcat.core.ServiceInterceptor. There is no interface defined for this, since this is a temporary halfway point between the old Enhydra TransactionFilter and the future Tomcat Interceptors. Extend this class to create a filter with additional attributes. The object model is not currently very clean because we need to bridge between the Interceptor model of Tomcat for service(), init(), ...
• ServletManager: This class loads Servlet classes, creates instances of Servlets, caches the Servlets, and returns pointers to them. The Servlets are refered to by an identifer string (a symbolic name). First Servlets are registered via add() . Then they are started via start() . Then they are available for use via get() . The ServletManager will call init() on the Servlet. It will also call destoroy() . Other classes which use Servlets returned by get() must not call these two methods. When get() returns a Servlet, it is ready to accept service() calls.
• StandardConnectionMethod: This is a sample implementation of a ConnectionMethod. It is an abstract class because this class does not actually recieve or generate requests. It does do all the channel managment. Implementations of ConnectionMethod should extend this object, unless there is a specific reason not to. Classes that extend this class will need to implement the getChannelURL() and channelURLIsValid() functions. They will also need to ensure that they contain a thread that is started in the constructor or (prefered) initialize() , and stopped in destroy() .
• ConnectionMethodManager: This class maintains a set of ConnectionMethods. Each ConnectionMethod is associated with an identification string (symbolic name). This ID string is used to retrieve a ConnectionMethod. This class does not monitor the creation of ConnectionMethods. If you create one, you are responsible for adding it. These public methods are the only things that modify the set of ConnectionMethods managed by this class. (Note that this is different than the ServletManager, which is responsible for creating the Servlets it manages.)
• EnhydraDirectorConnectionMethod: The Enhydra connection method. Receives and handles requests using the Enhydra Protocol. The protocol is loosely based on the proposed Apache JServ 2.1 protocol, which uses a packet transmission scheme to allow a more rich set of communcation features between web servers and Enhydra. These features include: Round robin load balancing. Persistent connections. Connection Pools. Callbacks to the front-end web server.
• RequestFilter: This replaces the BasicTransactionRequest. This is part of the basic transaction filter. This is what wraps around the servlet request object. This class does nothing, every single call is a pass-through to the real request. This class exists so that it can be extended. You would then only need to override the methods you are interested in. All the other calls will be passed through by this class.
• FilterManager: This class maintains a set of Filters. Each filter is associated with an identification string (symbolic name). This ID string is used to retrieve a filter. This class does not monitor the creation of filters. If you create one, you are responsible for adding it to this class. These public methods are the only things that modify the set of filters managed by this class.
• Path: Utility class to help manipulate paths. Method cleans up multiple '/' or '\' when constructing the object and prevents adding additional '/' or '\' when appending paths. For the purposes of this class a 'UrlPath' is a path with the path separators character of '/', regardless of platform; A 'FilePath' is a path with system dependent path separators characters (UNIX - '/' DOS - '\').
• EnhydraDirectorInputStream: InputStream interface for the Enhydra connection method. Implemention of ServletInputStrem to be passed to servlets to allow them to receive the incoming HTTP request entity. This input stream and its underlying protocol receiver does not buffer input. Incoming entity bytes are read directly from the connected socket into the receiving buffer.
• EnhydraDirectorOutputStream: OutputStream interface for the Enhydra connection method. Implemention of ServletOutputStream to be passed to servlets to allow them to send response data to the client. This class automatically wrappers a lower level output stream in a BufferedOutputStream if buffering is requested by the servlet.
• CGIServlet: This Servlet is for the purpose of executing a CGI program that resides on the system. In order to use this servlet in the Multiserver please remember to specify the fully qualified classname org.enhydra.servlet.servlets.CGIServlet in the Classname field and specify the directory of the CGI to run in the DocRoot field.
• CgiProcessor: This Servlet is for the purpose of executing a CGI program that resides on the system. In order to use this servlet in the Multiserver please remember to specify the fully qualified classname org.enhydra.servlet.servlets.CGIServlet in the Classname field and specify the directory of the CGI to run in the DocRoot field.
• EnhydraDirectorProtoOutputStream: The basic implementation of an output stream for EnhydraDirector. This implementation is intended to be used by the Enhydra connection method's EnhydraDirectorOutputStream class. If buffering is needed, this class can be wrappered in a BufferedOutputStream .
• FileServerServlet: This class serves files from HTTP request. Currently only a limited Http GET request will be processed. CGI arguments will not be processed. The initial parameter 'index=something.html' can for the default html page. If this parameter is not set then it will default to "index.html".
• HttpsRequestProcessor: Class that implements the request setup and parsing for HttpsRequest . This functionality is seperated into this class for organization purposes, with the internal functions being implemented here and the servlet interface being implemented in HttpsRequest .
• HttpRequestProcessor: Class that implements the request setup and parsing for HttpRequest . This functionality is seperated into this class for organization purposes, with the internal functions being implemented here and the servlet interface being implemented in HttpRequest .
• EnhydraDirectorFunction: Interface for pluggable EnhydraDirector protocol functions. EnhydraDirector function classes are only instantiated when their function number is requested for a particular connection. Each function is permanently hard-coded into a dispatch method in EnhydraDirectorProtocol.
• ServletIOException: IOException derived class that is thrown when the servlet encounters an I/O error when talking to a client. This allows connection methods to determine how the error should be handled, even though it was generated by a call that occured in servlet code.
• OutputStreamRecord: This class is used to trace the calls to print() and println() and, optionally, to save a copy of the data written to the output stream. The tracing and data-copying are accomplished via an associated ResponseRecord object.
• PrintWriterRecord: This class is used to trace the calls to the output methods of a servlet's PrintWriter and, optionally, to save a copy of the data written to the output stream. The tracing and data-copying are accomplished via an associated ResponseRecord object.
| Home | Contact Us | Privacy Policy | Terms of Service |