[JENKINS-45841] - Update Remoting Javadoc.

Just to make the protocol deprecation fact more explicit.
jenkinsci · Jul 31, 2017 · b7c0861 · b7c0861
1 parent 67edc4b
commit b7c0861
Show file tree

Hide file tree

Showing 17 changed files with 25 additions and 13 deletions.
diff --git a/src/main/java/org/jenkinsci/remoting/engine/Jnlp3ConnectionState.java b/src/main/java/org/jenkinsci/remoting/engine/Jnlp3ConnectionState.java
@@ -31,7 +31,7 @@
 /**
  * Represents the connection state of a {@link JnlpProtocol3Handler} connection.
  *
- * @since FIXME
+ * @since 3.0
  */
 @Deprecated
 public class Jnlp3ConnectionState extends LegacyJnlpConnectionState {

diff --git a/src/main/java/org/jenkinsci/remoting/engine/Jnlp4ConnectionState.java b/src/main/java/org/jenkinsci/remoting/engine/Jnlp4ConnectionState.java
@@ -33,7 +33,7 @@
 /**
  * Represents the connection state for a {@link JnlpProtocol4Handler} connection.
  *
- * @since FIXME
+ * @since 3.0
  */
 public class Jnlp4ConnectionState extends JnlpConnectionState {
 

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpAgentEndpoint.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpAgentEndpoint.java
@@ -45,7 +45,7 @@
 /**
  * Represents a {@code TcpSlaveAgentListener} endpoint details.
  *
- * @since FIXME
+ * @since 3.0
  */
 public class JnlpAgentEndpoint {
     /**

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpAgentEndpointResolver.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpAgentEndpointResolver.java
@@ -60,6 +60,7 @@
 
 /**
  * @author Stephen Connolly
+ * @since 3.0
  */
 public class JnlpAgentEndpointResolver {
 

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpClientDatabase.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpClientDatabase.java
@@ -29,7 +29,7 @@
 /**
  * Represents a database of clients that are permitted to connect.
  *
- * @since FIXME
+ * @since 3.0
  */
 public abstract class JnlpClientDatabase {
 

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpConnectionState.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpConnectionState.java
@@ -42,7 +42,7 @@
  * Represents the state of a connection event. This object should not be retained by the
  * {@link JnlpConnectionStateListener}
  *
- * @since FIXME
+ * @since 3.0
  */
 @NotThreadSafe
 public class JnlpConnectionState {

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpConnectionStateListener.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpConnectionStateListener.java
@@ -46,7 +46,7 @@
  * <li>{@link #afterDisconnect(JnlpConnectionState)}</li>
  * </ol>
  *
- * @since FIXME
+ * @since 3.0
  */
 public abstract class JnlpConnectionStateListener {
     /**

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocol1Handler.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocol1Handler.java
@@ -50,7 +50,9 @@
  * This was the first protocol supported by Jenkins. JNLP slaves will use this
  * as a last resort when connecting to old versions of Jenkins masters.
  *
- * @since FIXME
+ * @since 3.0
+ * @deprecated Replaced by JNLP4
+ * @see JnlpProtocol4Handler
  */
 @Deprecated
 public class JnlpProtocol1Handler extends LegacyJnlpProtocolHandler<LegacyJnlpConnectionState> {

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocol2Handler.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocol2Handler.java
@@ -54,6 +54,10 @@
  * the new connection request. The master can use the cookie to determine if
  * the incoming request is an initial connection request or a reconnection
  * and take appropriate action.
+ * 
+ * @since 3.0
+ * @deprecated Replaced by JNLP4
+ * @see JnlpProtocol4Handler
  */
 @Deprecated
 public class JnlpProtocol2Handler extends LegacyJnlpProtocolHandler<LegacyJnlpConnectionState> {

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocol3Handler.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocol3Handler.java
@@ -121,6 +121,8 @@
  * 256bit sizes are supported.
  * 
  * @deprecated Deprecated after the release of JNLP4, see {@link JnlpProtocol4Handler} 
+ * @since 3.0
+ * @see JnlpProtocol4Handler
  */
 @Deprecated
 public class JnlpProtocol3Handler extends LegacyJnlpProtocolHandler<Jnlp3ConnectionState> {

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocol4Handler.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocol4Handler.java
@@ -64,7 +64,7 @@
  * implementation uses the {@link IOHub} for non-blocking I/O wherever possible which removes the bottleneck of
  * the selector thread being used for linearization and I/O that creates a throughput limit with {@link NioChannelHub}.
  *
- * @since FIXME
+ * @since 3.0
  */
 public class JnlpProtocol4Handler extends JnlpProtocolHandler<Jnlp4ConnectionState> {
     /**

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocol4PlainHandler.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocol4PlainHandler.java
@@ -58,7 +58,7 @@
  * implementation uses the {@link IOHub} for non-blocking I/O wherever possible which removes the bottleneck of
  * the selector thread being used for linearization and I/O that creates a throughput limit with {@link NioChannelHub}.
  *
- * @since FIXME
+ * @since 3.0
  */
 public class JnlpProtocol4PlainHandler extends JnlpProtocolHandler<JnlpConnectionState> {
     /**

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocolHandler.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocolHandler.java
@@ -36,6 +36,9 @@
 
 /**
  * Consolidates the protocol handling for both the server and the client ends of the connection.
+ * 
+ * @param <STATE> State class for connection events
+ * @since 3.0
  */
 public abstract class JnlpProtocolHandler<STATE extends JnlpConnectionState> {
 

diff --git a/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocolHandlerFactory.java b/src/main/java/org/jenkinsci/remoting/engine/JnlpProtocolHandlerFactory.java
@@ -37,7 +37,7 @@
 /**
  * Builds a set of {@link JnlpProtocolHandler} instances from the supplied preconditions.
  *
- * @since FIXME
+ * @since 3.0
  */
 public class JnlpProtocolHandlerFactory {
     /**

diff --git a/src/main/java/org/jenkinsci/remoting/engine/LegacyJnlpConnectionState.java b/src/main/java/org/jenkinsci/remoting/engine/LegacyJnlpConnectionState.java
@@ -42,7 +42,7 @@
 /**
  * Base class for {@link LegacyJnlpProtocolHandler} based protocols.
  *
- * @since FIXME
+ * @since 3.0
  */
 public class LegacyJnlpConnectionState extends JnlpConnectionState {
     /**

diff --git a/src/main/java/org/jenkinsci/remoting/engine/LegacyJnlpProtocolHandler.java b/src/main/java/org/jenkinsci/remoting/engine/LegacyJnlpProtocolHandler.java
@@ -42,7 +42,7 @@
 /**
  * Base class for the {@link JnlpProtocolHandler} implementations that use {@link NioChannelHub}.
  *
- * @since FIXME
+ * @since 3.0
  */
 abstract class LegacyJnlpProtocolHandler<STATE extends LegacyJnlpConnectionState> extends JnlpProtocolHandler<STATE> {
     /**

diff --git a/src/main/java/org/jenkinsci/remoting/engine/WorkDirManager.java b/src/main/java/org/jenkinsci/remoting/engine/WorkDirManager.java
@@ -55,7 +55,7 @@
  * Using this manager remoting can initialize its working directory and put the data there.
  * The structure of the directory is described in {@link DirType}.
  * @author Oleg Nenashev
- * @since TODO
+ * @since 3.8
  */
 @Restricted(NoExternalUse.class)
 public class WorkDirManager {