This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 8.5.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/8.5.x by this push:
new e6744b4a40 Remove unnecessary duplication of Javadoc
e6744b4a40 is described below
commit e6744b4a40c677fd716ff80ee1dd1be3dc97c1a4
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Thu Mar 9 14:00:30 2023 +0000
Remove unnecessary duplication of Javadoc
---
java/org/apache/catalina/Valve.java | 6 +++-
.../catalina/authenticator/AuthenticatorBase.java | 32 ++++------------------
.../authenticator/NonLoginAuthenticator.java | 3 --
java/org/apache/catalina/valves/ValveBase.java | 24 ++--------------
4 files changed, 13 insertions(+), 52 deletions(-)
diff --git a/java/org/apache/catalina/Valve.java
b/java/org/apache/catalina/Valve.java
index d97545e3b4..b5a79954c7 100644
--- a/java/org/apache/catalina/Valve.java
+++ b/java/org/apache/catalina/Valve.java
@@ -43,7 +43,11 @@ public interface Valve {
//-------------------------------------------------------------- Properties
/**
- * @return the next Valve in the pipeline containing this Valve, if any.
+ * Returns the next Valve in this pipeline, or <code>null</code> if this is
+ * the last Valve in the pipeline.
+ *
+ * @return the next Valve in the pipeline containing this Valve, or
+ * <code>null</code> if this is the last Valve in the pipeline.
*/
Valve getNext();
diff --git a/java/org/apache/catalina/authenticator/AuthenticatorBase.java
b/java/org/apache/catalina/authenticator/AuthenticatorBase.java
index 24d82fd2a3..e25174750f 100644
--- a/java/org/apache/catalina/authenticator/AuthenticatorBase.java
+++ b/java/org/apache/catalina/authenticator/AuthenticatorBase.java
@@ -264,29 +264,18 @@ public abstract class AuthenticatorBase extends ValveBase
implements Authenticat
this.cache = cache;
}
- /**
- * Return the Container to which this Valve is attached.
- */
@Override
public Container getContainer() {
return this.context;
}
- /**
- * Set the Container to which this Valve is attached.
- *
- * @param container The container to which we are attached
- */
@Override
public void setContainer(Container container) {
-
if (container != null && !(container instanceof Context)) {
throw new
IllegalArgumentException(sm.getString("authenticator.notContext"));
}
-
super.setContainer(container);
this.context = (Context) container;
-
}
/**
@@ -1148,6 +1137,11 @@ public abstract class AuthenticatorBase extends
ValveBase implements Authenticat
register(request, request.getResponse(), principal, getAuthMethod(),
username, password);
}
+ /**
+ * Return the authentication method, which is vendor-specific and not
defined by HttpServletRequest.
+ *
+ * @return the authentication method, which is vendor-specific and not
defined by HttpServletRequest.
+ */
protected abstract String getAuthMethod();
/**
@@ -1203,13 +1197,6 @@ public abstract class AuthenticatorBase extends
ValveBase implements Authenticat
}
- /**
- * Start this component and implement the requirements of
- * {@link org.apache.catalina.util.LifecycleBase#startInternal()}.
- *
- * @exception LifecycleException if this component detects a fatal error
that prevents this component from being
- * used
- */
@Override
protected synchronized void startInternal() throws LifecycleException {
ServletContext servletContext = context.getServletContext();
@@ -1247,18 +1234,9 @@ public abstract class AuthenticatorBase extends
ValveBase implements Authenticat
}
- /**
- * Stop this component and implement the requirements of
- * {@link org.apache.catalina.util.LifecycleBase#stopInternal()}.
- *
- * @exception LifecycleException if this component detects a fatal error
that prevents this component from being
- * used
- */
@Override
protected synchronized void stopInternal() throws LifecycleException {
-
super.stopInternal();
-
sso = null;
}
diff --git a/java/org/apache/catalina/authenticator/NonLoginAuthenticator.java
b/java/org/apache/catalina/authenticator/NonLoginAuthenticator.java
index db9133f475..ba836c20e9 100644
--- a/java/org/apache/catalina/authenticator/NonLoginAuthenticator.java
+++ b/java/org/apache/catalina/authenticator/NonLoginAuthenticator.java
@@ -97,9 +97,6 @@ public final class NonLoginAuthenticator extends
AuthenticatorBase {
}
- /**
- * Return the authentication method, which is vendor-specific and not
defined by HttpServletRequest.
- */
@Override
protected String getAuthMethod() {
return "NONE";
diff --git a/java/org/apache/catalina/valves/ValveBase.java
b/java/org/apache/catalina/valves/ValveBase.java
index 493acc3f93..08c319fb22 100644
--- a/java/org/apache/catalina/valves/ValveBase.java
+++ b/java/org/apache/catalina/valves/ValveBase.java
@@ -78,20 +78,12 @@ public abstract class ValveBase extends LifecycleMBeanBase
implements Contained,
// --------------------------------------------------------------
Properties
- /**
- * Return the Container with which this Valve is associated, if any.
- */
@Override
public Container getContainer() {
return container;
}
- /**
- * Set the Container with which this Valve is associated, if any.
- *
- * @param container The new associated container
- */
@Override
public void setContainer(Container container) {
this.container = container;
@@ -109,20 +101,12 @@ public abstract class ValveBase extends
LifecycleMBeanBase implements Contained,
}
- /**
- * Return the next Valve in this pipeline, or <code>null</code> if this is
the last Valve in the pipeline.
- */
@Override
public Valve getNext() {
return next;
}
- /**
- * Set the Valve that follows this one in the pipeline it is part of.
- *
- * @param valve The new next valve
- */
@Override
public void setNext(Valve valve) {
this.next = valve;
@@ -132,8 +116,9 @@ public abstract class ValveBase extends LifecycleMBeanBase
implements Contained,
// ---------------------------------------------------------- Public
Methods
/**
- * Execute a periodic task, such as reloading, etc. This method will be
invoked inside the classloading context of
- * this container. Unexpected throwables will be caught and logged.
+ * {@inheritDoc}
+ * <p>
+ * The default implementation is NO-OP.
*/
@Override
public void backgroundProcess() {
@@ -174,9 +159,6 @@ public abstract class ValveBase extends LifecycleMBeanBase
implements Contained,
}
- /**
- * Return a String rendering of this object.
- */
@Override
public String toString() {
StringBuilder sb = new StringBuilder(this.getClass().getName());
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
