This is an automated email from the ASF dual-hosted git repository.
markt-asf pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/9.0.x by this push:
new a3c0bc6557 Fix Javadoc error and 4 warnings
a3c0bc6557 is described below
commit a3c0bc65572abb9d22a256020371566a55a4b892
Author: Mark Thomas <[email protected]>
AuthorDate: Tue Sep 1 16:57:10 2026 +0100
Fix Javadoc error and 4 warnings
---
java/org/apache/catalina/authenticator/AuthenticatorBase.java | 5 +++++
.../tribes/membership/cloud/CloudMembershipProvider.java | 2 +-
java/org/apache/catalina/webresources/AbstractResource.java | 7 +++++++
.../tomcat/websocket/server/WsHttpSessionBindingListener.java | 9 +++++++++
java/org/apache/tomcat/websocket/server/WsServerContainer.java | 7 +++++++
5 files changed, 29 insertions(+), 1 deletion(-)
diff --git a/java/org/apache/catalina/authenticator/AuthenticatorBase.java
b/java/org/apache/catalina/authenticator/AuthenticatorBase.java
index c00726aec8..fdb581a07e 100644
--- a/java/org/apache/catalina/authenticator/AuthenticatorBase.java
+++ b/java/org/apache/catalina/authenticator/AuthenticatorBase.java
@@ -1533,6 +1533,11 @@ public abstract class AuthenticatorBase extends
ValveBase implements Authenticat
this.authenticated = authenticated;
}
+ /**
+ * Was the authentication successful?
+ *
+ * @return {@code true} if successful, otherwise {@code false}
+ */
public boolean getAuthenticated() {
return authenticated;
}
diff --git
a/java/org/apache/catalina/tribes/membership/cloud/CloudMembershipProvider.java
b/java/org/apache/catalina/tribes/membership/cloud/CloudMembershipProvider.java
index 9012eafd62..b31b3efa37 100644
---
a/java/org/apache/catalina/tribes/membership/cloud/CloudMembershipProvider.java
+++
b/java/org/apache/catalina/tribes/membership/cloud/CloudMembershipProvider.java
@@ -212,7 +212,7 @@ public abstract class CloudMembershipProvider extends
MembershipProviderBase imp
/**
* Fetch current cluster members from the cloud orchestration.
*
- * @return the member array, or {@null} if an error occurred
+ * @return the member array, or {@code null} if an error occurred
*/
protected abstract Member[] fetchMembers();
diff --git a/java/org/apache/catalina/webresources/AbstractResource.java
b/java/org/apache/catalina/webresources/AbstractResource.java
index 88f6f8c895..1b679aceca 100644
--- a/java/org/apache/catalina/webresources/AbstractResource.java
+++ b/java/org/apache/catalina/webresources/AbstractResource.java
@@ -230,6 +230,13 @@ public abstract class AbstractResource implements
WebResource {
protected abstract Log getLog();
+ /**
+ * Gets the creation time for the given file
+ *
+ * @param file The file for which the creation time is required
+ *
+ * @return The creation time or, if not available the value of {@link
File#lastModified()}
+ */
protected long getCreation(File file) {
try {
BasicFileAttributes attrs = Files.readAttributes(file.toPath(),
BasicFileAttributes.class);
diff --git
a/java/org/apache/tomcat/websocket/server/WsHttpSessionBindingListener.java
b/java/org/apache/tomcat/websocket/server/WsHttpSessionBindingListener.java
index 94cfabca63..9a8f57d7d0 100644
--- a/java/org/apache/tomcat/websocket/server/WsHttpSessionBindingListener.java
+++ b/java/org/apache/tomcat/websocket/server/WsHttpSessionBindingListener.java
@@ -22,12 +22,21 @@ import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpSessionBindingEvent;
import javax.servlet.http.HttpSessionBindingListener;
+/**
+ * Listener used to track when an HTTP session expires and notifies the
WebSocket container so any associated WebSocket
+ * session can be closed.
+ */
public class WsHttpSessionBindingListener implements
HttpSessionBindingListener, Serializable {
private static final long serialVersionUID = 1L;
private final String key;
+ /**
+ * Create a new listener.
+ *
+ * @param key The key that identifies the HTTP session
+ */
public WsHttpSessionBindingListener(String key) {
this.key = key;
}
diff --git a/java/org/apache/tomcat/websocket/server/WsServerContainer.java
b/java/org/apache/tomcat/websocket/server/WsServerContainer.java
index d1b2abaa39..b3c4f39089 100644
--- a/java/org/apache/tomcat/websocket/server/WsServerContainer.java
+++ b/java/org/apache/tomcat/websocket/server/WsServerContainer.java
@@ -433,6 +433,13 @@ public class WsServerContainer extends
WsWebSocketContainer implements ServerCon
}
+ /**
+ * Register the link between the HTTP session and WebSocket session if the
HTTP session is authenticated.
+ *
+ * @param key The key to use to identify the HTTP session (session
IDs can change)
+ * @param wsSession The WebSocket session
+ * @param httpSession The HTTP session
+ */
protected void registerSession(Object key, WsSession wsSession, Object
httpSession) {
super.registerSession(key, wsSession);
if (wsSession.isOpen() && wsSession.getUserPrincipal() != null &&
httpSession != null) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
