You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2015/01/30 10:09:10 UTC

svn commit: r1655968 - in /tomcat/trunk/java/org/apache/tomcat/util/net: SSLSupport.java jsse/JSSESupport.java

Author: markt
Date: Fri Jan 30 09:09:10 2015
New Revision: 1655968

URL: http://svn.apache.org/r1655968
Log:
Javadoc fixes.

Modified:
    tomcat/trunk/java/org/apache/tomcat/util/net/SSLSupport.java
    tomcat/trunk/java/org/apache/tomcat/util/net/jsse/JSSESupport.java

Modified: tomcat/trunk/java/org/apache/tomcat/util/net/SSLSupport.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/SSLSupport.java?rev=1655968&r1=1655967&r2=1655968&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/net/SSLSupport.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/util/net/SSLSupport.java Fri Jan 30 09:09:10 2015
@@ -76,11 +76,23 @@ public interface SSLSupport {
 
     /**
      * The cipher suite being used on this connection.
+     *
+     * @return The name of the cipher suite as returned by the SSL/TLS
+     *        implementation
+     *
+     * @throws IOException If an error occurs trying to obtain the cipher suite
      */
     public String getCipherSuite() throws IOException;
 
     /**
      * The client certificate chain (if any).
+     *
+     * @return The certificate chain presented by the client with the peer's
+     *         certificate first, followed by those of any certificate
+     *         authorities
+     *
+     * @throws IOException If an error occurs trying to obtain the certificate
+     *                     chain
      */
     public X509Certificate[] getPeerCertificateChain() throws IOException;
 
@@ -97,15 +109,22 @@ public interface SSLSupport {
      * (d) The size of the signature key used by the server
      *
      * Unfortunately, all of these values are nonsensical.
-     **/
-    public Integer getKeySize()
-        throws IOException;
+     *
+     * @return The effective key size for the current cipher suite
+     *
+     * @throws IOException If an error occurs trying to obtain the key size
+     */
+    public Integer getKeySize() throws IOException;
 
     /**
      * The current session Id.
+     *
+     * @return The current SSL/TLS session ID
+     *
+     * @throws IOException If an error occurs trying to obtain the session ID
      */
-    public String getSessionId()
-        throws IOException;
+    public String getSessionId() throws IOException;
+
     /**
      * Simple data class that represents the cipher being used, along with the
      * corresponding effective key size.  The specified phrase must appear in the

Modified: tomcat/trunk/java/org/apache/tomcat/util/net/jsse/JSSESupport.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/jsse/JSSESupport.java?rev=1655968&r1=1655967&r2=1655968&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/net/jsse/JSSESupport.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/util/net/jsse/JSSESupport.java Fri Jan 30 09:09:10 2015
@@ -55,7 +55,7 @@ class JSSESupport implements SSLSupport,
 
     private static final Map<SSLSession,Integer> keySizeCache = new WeakHashMap<>();
 
-    protected SSLSession session;
+    private SSLSession session;
 
 
     JSSESupport(SSLSession session) {
@@ -116,7 +116,9 @@ class JSSESupport implements SSLSupport,
 
 
     /**
-     * Copied from <code>org.apache.catalina.valves.CertificateValve</code>
+     * {@inheritDoc}
+     * <p>
+     * This returns the effective bits for the current cipher suite.
      */
     @Override
     public Integer getKeySize()



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org