Package org.jenkinsci.remoting.engine

Class JnlpConnectionStateListener

java.lang.Object

org.jenkinsci.remoting.engine.JnlpConnectionStateListener

public abstract class JnlpConnectionStateListener
extends Object

A listener for connection state changes. The listeners will be called in order for any unique event. Use JnlpConnectionState.setStash(JnlpConnectionState.ListenerState) and JnlpConnectionState.getStash(Class) if you need to maintain state between callbacks.

1. beforeProperties(JnlpConnectionState) (if closed then afterDisconnect(JnlpConnectionState))
2. afterProperties(JnlpConnectionState) (if closed then afterDisconnect(JnlpConnectionState))
3. beforeChannel(JnlpConnectionState) (if closed then afterDisconnect(JnlpConnectionState))
4. afterChannel(JnlpConnectionState) (if closed then channelClosed(JnlpConnectionState))
5. channelClosed(JnlpConnectionState)
6. afterDisconnect(JnlpConnectionState)

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
JnlpConnectionStateListener()

Method Summary

Modifier and Type	Method	Description
abstract void	afterChannel(JnlpConnectionState event)	Callback to notify the JnlpConnectionState.approve() listener that the Channel has been created and is available via JnlpConnectionState.getChannel().
void	afterDisconnect(JnlpConnectionState event)	Callback to notify the JnlpConnectionState.approve() listener that the Socket has been closed.
abstract void	afterProperties(JnlpConnectionState event)	Notification that properties have been exchanged.
void	beforeChannel(JnlpConnectionState event)	Callback to allow the JnlpConnectionState.approve() listener to decorate the ChannelBuilder via JnlpConnectionState.getChannelBuilder().
void	beforeProperties(JnlpConnectionState event)	Notification that the connection has been established and properties will be exchanged.
void	channelClosed(JnlpConnectionState event)	Callback to notify the JnlpConnectionState.approve() listener that the Channel has been closed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JnlpConnectionStateListener

public JnlpConnectionStateListener()

Method Detail

beforeProperties

public void beforeProperties(@NonNull
                             JnlpConnectionState event)

Notification that the connection has been established and properties will be exchanged. Call JnlpConnectionState.ignore() to suppress any further notifications of this event. Call JnlpConnectionState.reject(ConnectionRefusalException) to reject the connection. Call JnlpConnectionState.approve() to declare ownership of this event (normally better to defer this to afterProperties(JnlpConnectionState))

Parameters:

event - the event.

afterProperties

public abstract void afterProperties(@NonNull
                                     JnlpConnectionState event)

Notification that properties have been exchanged. Call JnlpConnectionState.ignore() to suppress any further notifications of this event. Call JnlpConnectionState.reject(ConnectionRefusalException) to reject the connection. Call JnlpConnectionState.approve() to declare ownership of this event.

Parameters:

event - the event.

beforeChannel

public void beforeChannel(@NonNull
                          JnlpConnectionState event)

Callback to allow the JnlpConnectionState.approve() listener to decorate the ChannelBuilder via JnlpConnectionState.getChannelBuilder().

Parameters:

event - the event.

afterChannel

public abstract void afterChannel(@NonNull
                                  JnlpConnectionState event)

Callback to notify the JnlpConnectionState.approve() listener that the Channel has been created and is available via JnlpConnectionState.getChannel().

Parameters:

event - the event.

channelClosed

public void channelClosed(@NonNull
                          JnlpConnectionState event)

Callback to notify the JnlpConnectionState.approve() listener that the Channel has been closed.

Parameters:

event - the event.

afterDisconnect

public void afterDisconnect(@NonNull
                            JnlpConnectionState event)

Callback to notify the JnlpConnectionState.approve() listener that the Socket has been closed.

Parameters:

event - the event.