You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by kk...@apache.org on 2011/11/10 06:31:28 UTC
svn commit: r1200157 - in /tomcat/tc7.0.x/trunk/java/org/apache/catalina:
comet/CometEvent.java comet/CometFilter.java comet/CometFilterChain.java
comet/CometProcessor.java connector/mbeans-descriptors.xml
Author: kkolinko
Date: Thu Nov 10 05:31:27 2011
New Revision: 1200157
URL: http://svn.apache.org/viewvc?rev=1200157&view=rev
Log:
Merging revision 1187801 from tomcat/trunk:
Whitespace removal from remaining /java/org/apache/catalina
Part 2
Modified:
tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometEvent.java
tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometFilter.java
tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometFilterChain.java
tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometProcessor.java
tomcat/tc7.0.x/trunk/java/org/apache/catalina/connector/mbeans-descriptors.xml
Modified: tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometEvent.java
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometEvent.java?rev=1200157&r1=1200156&r2=1200157&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometEvent.java (original)
+++ tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometEvent.java Thu Nov 10 05:31:27 2011
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -26,39 +26,39 @@ import javax.servlet.http.HttpServletRes
/**
* The CometEvent interface.
- *
+ *
* @author Filip Hanik
* @author Remy Maucherat
*/
public interface CometEvent {
/**
- * Enumeration describing the major events that the container can invoke
+ * Enumeration describing the major events that the container can invoke
* the CometProcessors event() method with.<br>
- * BEGIN - will be called at the beginning
- * of the processing of the connection. It can be used to initialize any relevant
- * fields using the request and response objects. Between the end of the processing
+ * BEGIN - will be called at the beginning
+ * of the processing of the connection. It can be used to initialize any relevant
+ * fields using the request and response objects. Between the end of the processing
* of this event, and the beginning of the processing of the end or error events,
* it is possible to use the response object to write data on the open connection.
- * Note that the response object and dependent OutputStream and Writer are still
- * not synchronized, so when they are accessed by multiple threads,
- * synchronization is mandatory. After processing the initial event, the request
+ * Note that the response object and dependent OutputStream and Writer are still
+ * not synchronized, so when they are accessed by multiple threads,
+ * synchronization is mandatory. After processing the initial event, the request
* is considered to be committed.<br>
* READ - This indicates that input data is available, and that one read can be made
* without blocking. The available and ready methods of the InputStream or
* Reader may be used to determine if there is a risk of blocking: the servlet
- * should read while data is reported available. When encountering a read error,
- * the servlet should report it by propagating the exception properly. Throwing
- * an exception will cause the error event to be invoked, and the connection
- * will be closed.
+ * should read while data is reported available. When encountering a read error,
+ * the servlet should report it by propagating the exception properly. Throwing
+ * an exception will cause the error event to be invoked, and the connection
+ * will be closed.
* Alternately, it is also possible to catch any exception, perform clean up
* on any data structure the servlet may be using, and using the close method
- * of the event. It is not allowed to attempt reading data from the request
+ * of the event. It is not allowed to attempt reading data from the request
* object outside of the execution of this method.<br>
* END - End may be called to end the processing of the request. Fields that have
* been initialized in the begin method should be reset. After this event has
* been processed, the request and response objects, as well as all their dependent
- * objects will be recycled and used to process other requests. End will also be
+ * objects will be recycled and used to process other requests. End will also be
* called when data is available and the end of file is reached on the request input
* (this usually indicates the client has pipelined a request).<br>
* ERROR - Error will be called by the container in the case where an IO exception
@@ -68,8 +68,8 @@ public interface CometEvent {
* objects will be recycled and used to process other requests.
*/
public enum EventType {BEGIN, READ, END, ERROR}
-
-
+
+
/**
* Event details.<br>
* TIMEOUT - the connection timed out (sub type of ERROR); note that this ERROR type is not fatal, and
@@ -81,60 +81,60 @@ public interface CometEvent {
* SESSION_END - the servlet ended the session (sub type of END)
*/
public enum EventSubType { TIMEOUT, CLIENT_DISCONNECT, IOEXCEPTION, WEBAPP_RELOAD, SERVER_SHUTDOWN, SESSION_END }
-
-
+
+
/**
* Returns the HttpServletRequest.
- *
+ *
* @return HttpServletRequest
*/
public HttpServletRequest getHttpServletRequest();
-
+
/**
* Returns the HttpServletResponse.
- *
+ *
* @return HttpServletResponse
*/
public HttpServletResponse getHttpServletResponse();
-
+
/**
* Returns the event type.
- *
+ *
* @return EventType
*/
public EventType getEventType();
-
+
/**
* Returns the sub type of this event.
- *
+ *
* @return EventSubType
*/
public EventSubType getEventSubType();
-
+
/**
- * Ends the Comet session. This signals to the container that
+ * Ends the Comet session. This signals to the container that
* the container wants to end the comet session. This will send back to the
* client a notice that the server has no more data to send as part of this
* request. The servlet should perform any needed cleanup as if it had received
- * an END or ERROR event.
- *
+ * an END or ERROR event.
+ *
* @throws IOException if an IO exception occurs
*/
public void close() throws IOException;
-
+
/**
- * Sets the timeout for this Comet connection. Please NOTE, that the implementation
+ * Sets the timeout for this Comet connection. Please NOTE, that the implementation
* of a per connection timeout is OPTIONAL and MAY NOT be implemented.<br/>
* This method sets the timeout in milliseconds of idle time on the connection.
* The timeout is reset every time data is received from the connection or data is flushed
- * using <code>response.flushBuffer()</code>. If a timeout occurs, the
- * <code>error(HttpServletRequest, HttpServletResponse)</code> method is invoked. The
+ * using <code>response.flushBuffer()</code>. If a timeout occurs, the
+ * <code>error(HttpServletRequest, HttpServletResponse)</code> method is invoked. The
* web application SHOULD NOT attempt to reuse the request and response objects after a timeout
* as the <code>error(HttpServletRequest, HttpServletResponse)</code> method indicates.<br/>
* This method should not be called asynchronously, as that will have no effect.
- *
+ *
* @param timeout The timeout in milliseconds for this connection, must be a positive value, larger than 0
- * @throws IOException An IOException may be thrown to indicate an IO error,
+ * @throws IOException An IOException may be thrown to indicate an IO error,
* or that the EOF has been reached on the connection
* @throws ServletException An exception has occurred, as specified by the root
* cause
Modified: tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometFilter.java
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometFilter.java?rev=1200157&r1=1200156&r2=1200157&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometFilter.java (original)
+++ tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometFilter.java Thu Nov 10 05:31:27 2011
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -24,10 +24,10 @@ import javax.servlet.Filter;
import javax.servlet.ServletException;
/**
- * A Comet filter, similar to regular filters, performs filtering tasks on either
+ * A Comet filter, similar to regular filters, performs filtering tasks on either
* the request to a resource (a Comet servlet), or on the response from a resource, or both.
* <br><br>
- * Filters perform filtering in the <code>doFilterEvent</code> method. Every Filter has access to
+ * Filters perform filtering in the <code>doFilterEvent</code> method. Every Filter has access to
* a FilterConfig object from which it can obtain its initialization parameters, a
* reference to the ServletContext which it can use, for example, to load resources
* needed for filtering tasks.
@@ -45,13 +45,13 @@ import javax.servlet.ServletException;
* 8) XSL/T filters <br>
* 9) Mime-type chain Filter <br>
* <br>
- *
+ *
* @author Remy Maucherat
* @author Filip Hanik
*/
public interface CometFilter extends Filter {
-
+
/**
* The <code>doFilterEvent</code> method of the CometFilter is called by the container
* each time a request/response pair is passed through the chain due
@@ -66,17 +66,17 @@ public interface CometFilter extends Fil
* 3. Optionally wrap the response object contained in the event with a custom implementation to
* filter content or headers for output filtering and pass a CometEvent instance containing
* the wrapped request to the next filter<br>
- * 4. a) <strong>Either</strong> invoke the next entity in the chain using the CometFilterChain object (<code>chain.doFilterEvent()</code>), <br>
+ * 4. a) <strong>Either</strong> invoke the next entity in the chain using the CometFilterChain object (<code>chain.doFilterEvent()</code>), <br>
* 4. b) <strong>or</strong> not pass on the request/response pair to the next entity in the filter chain to block the event processing<br>
* 5. Directly set fields on the response after invocation of the next entity in the filter chain.
- *
+ *
* @param event the event that is being processed. Another event may be passed along the chain.
- * @param chain
+ * @param chain
* @throws IOException
* @throws ServletException
*/
public void doFilterEvent(CometEvent event, CometFilterChain chain)
throws IOException, ServletException;
-
+
}
Modified: tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometFilterChain.java
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometFilterChain.java?rev=1200157&r1=1200156&r2=1200157&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometFilterChain.java (original)
+++ tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometFilterChain.java Thu Nov 10 05:31:27 2011
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -27,13 +27,13 @@ import javax.servlet.ServletException;
* giving a view into the invocation chain of a filtered event for a resource. Filters
* use the CometFilterChain to invoke the next filter in the chain, or if the calling filter
* is the last filter in the chain, to invoke the resource at the end of the chain.
- *
+ *
* @author Remy Maucherat
* @author Filip Hanik
*/
public interface CometFilterChain {
-
+
/**
* Causes the next filter in the chain to be invoked, or if the calling filter is the last filter
* in the chain, causes the resource at the end of the chain to be invoked.
@@ -41,6 +41,6 @@ public interface CometFilterChain {
* @param event the event to pass along the chain.
*/
public void doFilterEvent(CometEvent event) throws IOException, ServletException;
-
+
}
Modified: tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometProcessor.java
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometProcessor.java?rev=1200157&r1=1200156&r2=1200157&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometProcessor.java (original)
+++ tomcat/tc7.0.x/trunk/java/org/apache/catalina/comet/CometProcessor.java Thu Nov 10 05:31:27 2011
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -34,7 +34,7 @@ public interface CometProcessor extends
/**
* Process the given Comet event.
- *
+ *
* @param event The Comet event that will be processed
* @throws IOException
* @throws ServletException
Modified: tomcat/tc7.0.x/trunk/java/org/apache/catalina/connector/mbeans-descriptors.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/org/apache/catalina/connector/mbeans-descriptors.xml?rev=1200157&r1=1200156&r2=1200157&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/org/apache/catalina/connector/mbeans-descriptors.xml (original)
+++ tomcat/tc7.0.x/trunk/java/org/apache/catalina/connector/mbeans-descriptors.xml Thu Nov 10 05:31:27 2011
@@ -34,12 +34,12 @@
<attribute name="acceptCount"
description="The accept count for this Connector"
type="int"/>
-
+
<!-- Common -->
<attribute name="address"
description="The IP address on which to bind"
type="java.lang.String"/>
-
+
<attribute name="allowTrace"
description="Allow disabling TRACE method"
type="boolean"/>
@@ -48,7 +48,7 @@
description="Fully qualified class name of the managed object"
type="java.lang.String"
writeable="false"/>
-
+
<!-- Common -->
<attribute name="connectionLinger"
description="Linger value on the incoming connection"
@@ -58,7 +58,7 @@
<attribute name="connectionTimeout"
description="Timeout value on the incoming connection"
type="int"/>
-
+
<attribute name="emptySessionPath"
description="The 'empty session path' flag for this Connector"
type="boolean"/>
@@ -88,10 +88,10 @@
<attribute name="maxPostSize"
description="Maximum size in bytes of a POST which will be handled by the servlet API provided features"
type="int"/>
-
+
<attribute name="maxSavePostSize"
description="Maximum size of a POST which will be saved by the container during authentication"
- type="int"/>
+ type="int"/>
<!-- Common -->
<attribute name="maxThreads"
@@ -106,15 +106,15 @@
<attribute name="packetSize"
description="The ajp packet size."
type="int"/>
-
+
<attribute name="port"
description="The port number on which we listen for requests"
type="int"/>
-
- <!-- Common -->
+
+ <!-- Common -->
<attribute name="processorCache"
description="The processor cache size."
- type="int"/>
+ type="int"/>
<attribute name="protocol"
description="Coyote protocol handler in use"
@@ -143,17 +143,17 @@
<attribute name="secret"
description="Authentication secret (I guess ... not in Javadocs)"
- readable = "false"
+ readable = "false"
type="java.lang.String"/>
<attribute name="secure"
description="Is this a secure (SSL) Connector?"
type="boolean"/>
-
+
<attribute name="sslProtocols"
description="Comma-separated list of SSL protocol variants to be enabled"
type="java.lang.String"/>
-
+
<attribute name="stateName"
description="The name of the LifecycleState that this component is currently in"
type="java.lang.String"
@@ -163,12 +163,12 @@
<attribute name="tcpNoDelay"
description="Should we use TCP no delay?"
type="boolean"/>
-
+
<!-- Common -->
<attribute name="threadPriority"
description="The thread priority for processors"
type="int"/>
-
+
<attribute name="URIEncoding"
description="Character encoding used to decode the URI"
type="java.lang.String"/>
@@ -176,7 +176,7 @@
<attribute name="useBodyEncodingForURI"
description="Should the body encoding be used for URI query parameters"
type="boolean"/>
-
+
<attribute name="useIPVHosts"
description="Should IP-based virtual hosting be used? "
type="boolean"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org