Author: markt
Date: Thu Apr 30 09:42:19 2015
New Revision: 1676940
URL: http://svn.apache.org/r1676940
Log:
Javadoc updates
Modified:
tomcat/trunk/java/org/apache/tomcat/util/net/AbstractEndpoint.java
tomcat/trunk/java/org/apache/tomcat/util/net/LocalStrings.properties
Modified: tomcat/trunk/java/org/apache/tomcat/util/net/AbstractEndpoint.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/AbstractEndpoint.java?rev=1676940&r1=1676939&r2=1676940&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/net/AbstractEndpoint.java
(original)
+++ tomcat/trunk/java/org/apache/tomcat/util/net/AbstractEndpoint.java Thu Apr
30 09:42:19 2015
@@ -44,6 +44,8 @@ import org.apache.tomcat.util.threads.Ta
import org.apache.tomcat.util.threads.ThreadPoolExecutor;
/**
+ * @param <S> The type for the sockets managed by this endpoint.
+ *
* @author Mladen Turk
* @author Remy Maucherat
*/
@@ -82,6 +84,8 @@ public abstract class AbstractEndpoint<S
/**
* Obtain the GlobalRequestProcessor associated with the handler.
+ *
+ * @return the GlobalRequestProcessor
*/
public Object getGlobal();
@@ -218,13 +222,11 @@ public abstract class AbstractEndpoint<S
public void addSslHostConfig(SSLHostConfig sslHostConfig) {
String key = sslHostConfig.getHostName();
if (key == null || key.length() == 0) {
- // TODO i18n
- throw new IllegalArgumentException();
+ throw new
IllegalArgumentException(sm.getString("endpoint.noSslHostName"));
}
SSLHostConfig duplicate = sslHostConfigs.put(key, sslHostConfig);
if (duplicate != null) {
- // TODO i18n
- throw new IllegalArgumentException();
+ throw new
IllegalArgumentException(sm.getString("endpoint.duplicateSslHostName", key));
}
sslHostConfig.setConfigType(getSslConfigType());
}
@@ -412,6 +414,9 @@ public abstract class AbstractEndpoint<S
/**
* Socket TCP no delay.
+ *
+ * @return The current TCP no delay setting for sockets created by this
+ * endpoint
*/
public boolean getTcpNoDelay() { return socketProperties.getTcpNoDelay();}
public void setTcpNoDelay(boolean tcpNoDelay) {
socketProperties.setTcpNoDelay(tcpNoDelay); }
@@ -419,6 +424,9 @@ public abstract class AbstractEndpoint<S
/**
* Socket linger.
+ *
+ * @return The current socket linger time for sockets created by this
+ * endpoint
*/
public int getSoLinger() { return socketProperties.getSoLingerTime(); }
public void setSoLinger(int soLinger) {
@@ -429,6 +437,8 @@ public abstract class AbstractEndpoint<S
/**
* Socket timeout.
+ *
+ * @return The current socket timeout for sockets created by this endpoint
*/
public int getSoTimeout() { return socketProperties.getSoTimeout(); }
public void setSoTimeout(int soTimeout) {
socketProperties.setSoTimeout(soTimeout); }
@@ -555,6 +565,9 @@ public abstract class AbstractEndpoint<S
* {@link org.apache.coyote.ProtocolHandler} needs to be made available to
* sub-components. The specific setter will call this method to populate
the
* attributes.
+ *
+ * @param name Name of property to set
+ * @param value The value to set the property to
*/
public void setAttribute(String name, Object value) {
if (getLog().isTraceEnabled()) {
@@ -564,6 +577,11 @@ public abstract class AbstractEndpoint<S
}
/**
* Used by sub-components to retrieve configuration information.
+ *
+ * @param key The name of the property for which the value should be
+ * retrieved
+ *
+ * @return The value of the specified property
*/
public Object getAttribute(String key) {
Object value = attributes.get(key);
Modified: tomcat/trunk/java/org/apache/tomcat/util/net/LocalStrings.properties
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/LocalStrings.properties?rev=1676940&r1=1676939&r2=1676940&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/net/LocalStrings.properties
(original)
+++ tomcat/trunk/java/org/apache/tomcat/util/net/LocalStrings.properties Thu
Apr 30 09:42:19 2015
@@ -44,12 +44,14 @@ endpoint.debug.unlock=Caught exception t
endpoint.accept.fail=Socket accept failed
endpoint.alpn.fail=Failed to configure endpoint for ALPN using {0}
endpoint.alpn.negotiated=Negotiated [{0}] protocol using ALPN
+endpoint.duplicateSslHostName=Multiple SSLHostConfig elements were provided
for the host name [{0}]. Host names must be unique.
endpoint.executor.fail=Executor rejected socket [{0}] for processing
endpoint.getAttribute=[{0}] is [{1}]
endpoint.init.bind=Socket bind failed: [{0}] {1}
endpoint.init.listen=Socket listen failed: [{0}] {1}
endpoint.init.notavail=APR not available
endpoint.noNegotiation=TLS was not configured for the [{0}] connector so
negotiation via ALPN for {1} is not available
+endpoint.noSslHostName=No host name was provided for the SSL host configuration
endpoint.poll.limitedpollsize=Failed to create poller with specified size of
{0}
endpoint.poll.initfail=Poller creation failed
endpoint.poll.fail=Critical poller failure (restarting poller): [{0}] {1}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
