Author: markt
Date: Tue Jan 5 23:09:04 2016
New Revision: 1723197
URL: http://svn.apache.org/viewvc?rev=1723197&view=rev
Log:
Fix Javadoc warnings
Modified:
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLContext.java
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLSessionContext.java
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLSessionStats.java
Modified:
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLContext.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLContext.java?rev=1723197&r1=1723196&r2=1723197&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLContext.java
(original)
+++ tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLContext.java
Tue Jan 5 23:09:04 2016
@@ -184,11 +184,12 @@ public class OpenSSLContext implements o
}
/**
- * Setup the SSL_CTX
+ * Setup the SSL_CTX.
*
* @param kms Must contain a KeyManager of the type
- * {@code OpenSSLKeyManager}
- * @param tms
+ * {@code OpenSSLKeyManager}
+ * @param tms Must contain a TrustManager of the type
+ * {@code X509TrustManager}
* @param sr Is not used for this implementation.
*/
@Override
Modified:
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLSessionContext.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLSessionContext.java?rev=1723197&r1=1723196&r2=1723197&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLSessionContext.java
(original)
+++
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLSessionContext.java
Tue Jan 5 23:09:04 2016
@@ -52,6 +52,8 @@ public abstract class OpenSSLSessionCont
/**
* Sets the SSL session ticket keys of this context.
+ *
+ * @param keys The session ticket keys
*/
public void setTicketKeys(byte[] keys) {
if (keys == null) {
@@ -62,16 +64,19 @@ public abstract class OpenSSLSessionCont
/**
* Enable or disable caching of SSL sessions.
+ *
+ * @param enabled {@code true} to enable caching, {@code false} to disable
*/
public abstract void setSessionCacheEnabled(boolean enabled);
/**
- * Return {@code true} if caching of SSL sessions is enabled, {@code
false} otherwise.
+ * @return {@code true} if caching of SSL sessions is enabled, {@code
false}
+ * otherwise.
*/
public abstract boolean isSessionCacheEnabled();
/**
- * Returns the stats of this context.
+ * @return The statistics for this context.
*/
public OpenSSLSessionStats stats() {
return stats;
Modified:
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLSessionStats.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLSessionStats.java?rev=1723197&r1=1723196&r2=1723197&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLSessionStats.java
(original)
+++
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/OpenSSLSessionStats.java
Tue Jan 5 23:09:04 2016
@@ -32,89 +32,93 @@ public final class OpenSSLSessionStats {
}
/**
- * Returns the current number of sessions in the internal session cache.
+ * @return The current number of sessions in the internal session cache.
*/
public long number() {
return SSLContext.sessionNumber(context);
}
/**
- * Returns the number of started SSL/TLS handshakes in client mode.
+ * @return The number of started SSL/TLS handshakes in client mode.
*/
public long connect() {
return SSLContext.sessionConnect(context);
}
/**
- * Returns the number of successfully established SSL/TLS sessions in
client mode.
+ * @return The number of successfully established SSL/TLS sessions in
client mode.
*/
public long connectGood() {
return SSLContext.sessionConnectGood(context);
}
/**
- * Returns the number of start renegotiations in client mode.
+ * @return The number of start renegotiations in client mode.
*/
public long connectRenegotiate() {
return SSLContext.sessionConnectRenegotiate(context);
}
/**
- * Returns the number of started SSL/TLS handshakes in server mode.
+ * @return The number of started SSL/TLS handshakes in server mode.
*/
public long accept() {
return SSLContext.sessionAccept(context);
}
/**
- * Returns the number of successfully established SSL/TLS sessions in
server mode.
+ * @return The number of successfully established SSL/TLS sessions in
server mode.
*/
public long acceptGood() {
return SSLContext.sessionAcceptGood(context);
}
/**
- * Returns the number of start renegotiations in server mode.
+ * @return The number of start renegotiations in server mode.
*/
public long acceptRenegotiate() {
return SSLContext.sessionAcceptRenegotiate(context);
}
/**
- * Returns the number of successfully reused sessions. In client mode, a
session set with {@code SSL_set_session}
- * successfully reused is counted as a hit. In server mode, a session
successfully retrieved from internal or
- * external cache is counted as a hit.
+ * @return The number of successfully reused sessions. In client mode, a
+ * session set with {@code SSL_set_session} successfully reused is
+ * counted as a hit. In server mode, a session successfully
+ * retrieved from internal or external cache is counted as a hit.
*/
public long hits() {
return SSLContext.sessionHits(context);
}
/**
- * Returns the number of successfully retrieved sessions from the external
session cache in server mode.
+ * @return The number of successfully retrieved sessions from the external
+ * session cache in server mode.
*/
public long cbHits() {
return SSLContext.sessionCbHits(context);
}
/**
- * Returns the number of sessions proposed by clients that were not found
in the internal session cache
- * in server mode.
+ * @return The number of sessions proposed by clients that were not found
in
+ * the internal session cache in server mode.
*/
public long misses() {
return SSLContext.sessionMisses(context);
}
/**
- * Returns the number of sessions proposed by clients and either found in
the internal or external session cache
- * in server mode, but that were invalid due to timeout. These sessions
are not included in the {@link #hits()}
- * count.
+ * @return The number of sessions proposed by clients and either found in
+ * the internal or external session cache in server mode, but that
+ * were invalid due to timeout. These sessions are not included in
+ * the {@link #hits()} count.
*/
public long timeouts() {
return SSLContext.sessionTimeouts(context);
}
/**
- * Returns the number of sessions that were removed because the maximum
session cache size was exceeded.
+ * @return The number of sessions that were removed because the maximum
+ * session cache size was exceeded.
*/
public long cacheFull() {
return SSLContext.sessionCacheFull(context);
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
