Author: fschumacher
Date: Tue Oct 13 20:16:59 2015
New Revision: 1708504
URL: http://svn.apache.org/viewvc?rev=1708504&view=rev
Log:
javadoc: Use real @return tags instead of textual
description, only.
Modified:
tomcat/trunk/java/org/apache/catalina/Loader.java
tomcat/trunk/java/org/apache/catalina/Pipeline.java
tomcat/trunk/java/org/apache/catalina/Realm.java
Modified: tomcat/trunk/java/org/apache/catalina/Loader.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Loader.java?rev=1708504&r1=1708503&r2=1708504&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Loader.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Loader.java Tue Oct 13 20:16:59 2015
@@ -59,13 +59,13 @@ public interface Loader {
/**
- * Return the Java class loader to be used by this Container.
+ * @return the Java class loader to be used by this Container.
*/
public ClassLoader getClassLoader();
/**
- * Return the Context with which this Loader has been associated.
+ * @return the Context with which this Loader has been associated.
*/
public Context getContext();
@@ -79,7 +79,7 @@ public interface Loader {
/**
- * Return the "follow standard delegation model" flag used to configure
+ * @return the "follow standard delegation model" flag used to configure
* our ClassLoader.
*/
public boolean getDelegate();
@@ -95,7 +95,7 @@ public interface Loader {
/**
- * Return the reloadable flag for this Loader.
+ * @return the reloadable flag for this Loader.
*/
public boolean getReloadable();
@@ -119,6 +119,9 @@ public interface Loader {
/**
* Has the internal repository associated with this Loader been modified,
* such that the loaded classes should be reloaded?
+ *
+ * @return <code>true</code> when the repository has been modified,
+ * <code>false</code> otherwise
*/
public boolean modified();
Modified: tomcat/trunk/java/org/apache/catalina/Pipeline.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Pipeline.java?rev=1708504&r1=1708503&r2=1708504&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Pipeline.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Pipeline.java Tue Oct 13 20:16:59 2015
@@ -44,7 +44,7 @@ public interface Pipeline {
/**
- * <p>Return the Valve instance that has been distinguished as the basic
+ * @return the Valve instance that has been distinguished as the basic
* Valve for this Pipeline (if any).
*/
public Valve getBasic();
@@ -95,7 +95,7 @@ public interface Pipeline {
/**
- * Return the set of Valves in the pipeline associated with this
+ * @return the set of Valves in the pipeline associated with this
* Container, including the basic Valve (if any). If there are no
* such Valves, a zero-length array is returned.
*/
@@ -118,7 +118,7 @@ public interface Pipeline {
/**
- * <p>Return the Valve instance that has been distinguished as the basic
+ * @return the Valve instance that has been distinguished as the basic
* Valve for this Pipeline (if any).
*/
public Valve getFirst();
@@ -131,7 +131,7 @@ public interface Pipeline {
/**
- * Return the Container with which this Pipeline is associated.
+ * @return the Container with which this Pipeline is associated.
*/
public Container getContainer();
Modified: tomcat/trunk/java/org/apache/catalina/Realm.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Realm.java?rev=1708504&r1=1708503&r2=1708504&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Realm.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Realm.java Tue Oct 13 20:16:59 2015
@@ -41,7 +41,7 @@ public interface Realm {
// ------------------------------------------------------------- Properties
/**
- * Return the Container with which this Realm has been associated.
+ * @return the Container with which this Realm has been associated.
*/
public Container getContainer();
@@ -55,7 +55,7 @@ public interface Realm {
/**
- * Return the CredentialHandler configured for this Realm.
+ * @return the CredentialHandler configured for this Realm.
*/
public CredentialHandler getCredentialHandler();
@@ -76,37 +76,43 @@ public interface Realm {
/**
- * Return the Principal associated with the specified username, if there
- * is one; otherwise return <code>null</code>.
+ * Try to authenticate with the specified username.
*
* @param username Username of the Principal to look up
+ * @return the associated principal, or <code>null</code> if none is
+ * associated.
*/
public Principal authenticate(String username);
/**
- * Return the Principal associated with the specified username and
- * credentials, if there is one; otherwise return <code>null</code>.
+ * Try to authenticate using the specified username and
+ * credentials.
*
* @param username Username of the Principal to look up
* @param credentials Password or other credentials to use in
- * authenticating this username
+ * authenticating this username
+ * @return the associated principal, or <code>null</code> if there is none
*/
public Principal authenticate(String username, String credentials);
/**
- * Return the Principal associated with the specified username, which
+ * Try to authenticate with the specified username, which
* matches the digest calculated using the given parameters using the
- * method described in RFC 2069; otherwise return <code>null</code>.
+ * method described in RFC 2069.
*
* @param username Username of the Principal to look up
* @param digest Digest which has been submitted by the client
* @param nonce Unique (or supposedly unique) token which has been used
* for this request
+ * @param nc TODO
+ * @param cnonce TODO
+ * @param qop TODO
* @param realm Realm name
* @param md5a2 Second MD5 digest used to calculate the digest :
* MD5(Method + ":" + uri)
+ * @return the associated principal, or <code>null</code> if there is none.
*/
public Principal authenticate(String username, String digest,
String nonce, String nc, String cnonce,
@@ -115,22 +121,22 @@ public interface Realm {
/**
- * Return the Principal associated with the specified {@link GSSContext}.
- * If there is none, return <code>null</code>.
+ * Try to authenticate using a {@link GSSContext}
*
* @param gssContext The gssContext processed by the {@link Authenticator}.
* @param storeCreds Should the realm attempt to store the delegated
* credentials in the returned Principal?
+ * @return the associated principal, or <code>null</code> if there is none
*/
public Principal authenticate(GSSContext gssContext, boolean storeCreds);
/**
- * Return the Principal associated with the specified chain of X509
- * client certificates. If there is none, return <code>null</code>.
+ * Try to authenticate using {@link X509Certificate}s
*
* @param certs Array of client certificates, with the first one in
* the array being the certificate of the client itself.
+ * @return the associated principal, or <code>null</code> if there is none
*/
public Principal authenticate(X509Certificate certs[]);
@@ -144,10 +150,13 @@ public interface Realm {
/**
- * Return the SecurityConstraints configured to guard the request URI for
- * this request, or <code>null</code> if there is no such constraint.
+ * Find the SecurityConstraints configured to guard the request URI for
+ * this request.
*
* @param request Request we are processing
+ * @param context {@link Context} for this request
+ * @return the configured {@link SecurityConstraint}, of <code>null</code>
+ * if there is none
*/
public SecurityConstraint [] findSecurityConstraints(Request request,
Context context);
@@ -155,13 +164,13 @@ public interface Realm {
/**
* Perform access control based on the specified authorization constraint.
- * Return <code>true</code> if this constraint is satisfied and processing
- * should continue, or <code>false</code> otherwise.
*
* @param request Request we are processing
* @param response Response we are creating
* @param constraint Security constraint we are enforcing
* @param context The Context to which client of this class is attached.
+ * @return <code>true</code> if this constraint is satisfied and processing
+ * should continue, or <code>false</code> otherwise
*
* @exception IOException if an input/output error occurs
*/
@@ -173,26 +182,29 @@ public interface Realm {
/**
- * Return <code>true</code> if the specified Principal has the specified
- * security role, within the context of this Realm; otherwise return
- * <code>false</code>.
+ * Check if the specified Principal has the specified
+ * security role, within the context of this Realm.
*
* @param wrapper wrapper context for evaluating role
* @param principal Principal for whom the role is to be checked
* @param role Security role to be checked
+ * @return <code>true</code> if the specified Principal has the specified
+ * security role, within the context of this Realm; otherwise
return
+ * <code>false</code>.
*/
public boolean hasRole(Wrapper wrapper, Principal principal, String role);
/**
* Enforce any user data constraint required by the security constraint
- * guarding this request URI. Return <code>true</code> if this constraint
- * was not violated and processing should continue, or <code>false</code>
- * if we have created a response already.
+ * guarding this request URI.
*
* @param request Request we are processing
* @param response Response we are creating
* @param constraint Security constraint being checked
+ * @return <code>true</code> if this constraint
+ * was not violated and processing should continue, or
<code>false</code>
+ * if we have created a response already.
*
* @exception IOException if an input/output error occurs
*/
@@ -212,7 +224,7 @@ public interface Realm {
/**
* Return roles associated with given principal
- * @param principal
+ * @param principal the {@link Principal} to get the roles for.
* @return principal roles
*/
public String[] getRoles(Principal principal);
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
