Skip to content
Permalink
Browse files

Merge pull request #182 from oleg-nenashev/docs/JENKINS-45841-javadoc

[JENKINS-45841] - Update Remoting Javadoc to indicate the protocol support status
  • Loading branch information
oleg-nenashev committed Aug 2, 2017
2 parents fc7e28b + b7c0861 commit cd81fcf98ad7af7059703b9150e87f81fdc3aaf2
@@ -31,7 +31,7 @@
/**
* Represents the connection state of a {@link JnlpProtocol3Handler} connection.
*
* @since FIXME
* @since 3.0
*/
@Deprecated
public class Jnlp3ConnectionState extends LegacyJnlpConnectionState {
@@ -33,7 +33,7 @@
/**
* Represents the connection state for a {@link JnlpProtocol4Handler} connection.
*
* @since FIXME
* @since 3.0
*/
public class Jnlp4ConnectionState extends JnlpConnectionState {

@@ -45,7 +45,7 @@
/**
* Represents a {@code TcpSlaveAgentListener} endpoint details.
*
* @since FIXME
* @since 3.0
*/
public class JnlpAgentEndpoint {
/**
@@ -60,6 +60,7 @@

/**
* @author Stephen Connolly
* @since 3.0
*/
public class JnlpAgentEndpointResolver {

@@ -29,7 +29,7 @@
/**
* Represents a database of clients that are permitted to connect.
*
* @since FIXME
* @since 3.0
*/
public abstract class JnlpClientDatabase {

@@ -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 {
@@ -46,7 +46,7 @@
* <li>{@link #afterDisconnect(JnlpConnectionState)}</li>
* </ol>
*
* @since FIXME
* @since 3.0
*/
public abstract class JnlpConnectionStateListener {
/**
@@ -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> {
@@ -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> {
@@ -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> {
@@ -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> {
/**
@@ -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> {
/**
@@ -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> {

@@ -37,7 +37,7 @@
/**
* Builds a set of {@link JnlpProtocolHandler} instances from the supplied preconditions.
*
* @since FIXME
* @since 3.0
*/
public class JnlpProtocolHandlerFactory {
/**
@@ -42,7 +42,7 @@
/**
* Base class for {@link LegacyJnlpProtocolHandler} based protocols.
*
* @since FIXME
* @since 3.0
*/
public class LegacyJnlpConnectionState extends JnlpConnectionState {
/**
@@ -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> {
/**
@@ -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 {

0 comments on commit cd81fcf

Please sign in to comment.
You can’t perform that action at this time.