org.jenkinsci.remoting.engine

Class JnlpConnectionState

java.lang.Object

org.jenkinsci.remoting.engine.JnlpConnectionState

Direct Known Subclasses:

Jnlp4ConnectionState, LegacyJnlpConnectionState

@NotThreadSafe
public class JnlpConnectionState
extends Object

Represents the state of a connection event. This object should not be retained by the JnlpConnectionStateListener

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JnlpConnectionState.ListenerState Marker base class for all stashed state data.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_NAME_KEY The property name for the client name key.
static String	COOKIE_KEY The proprty name for the cookie name key.
static String	SECRET_KEY The property name for the secret key.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JnlpConnectionState(Socket socket, List<? extends JnlpConnectionStateListener> listeners) Constructor.

Method Summary

Modifier and Type	Method and Description
void	approve() Signals that the current JnlpConnectionStateListener is declaring ownership of this event, approving the connection and all other JnlpConnectionStateListener instances will now be ignored.
Channel	getChannel() Gets the connection's Channel.
ChannelBuilder	getChannelBuilder() Gets the ChannelBuilder that will be used to create the connection's Channel.
IOException	getCloseCause() Gets the reason for the channel being closed if available.
Map<String,String>	getProperties() Gets the connection properties.
String	getProperty(String name) Gets the named connection property.
Socket	getSocket() Gets the socket that the connection is on.
<S extends JnlpConnectionState.ListenerState> S	getStash(Class<S> clazz) Retrieves the previously stashed state.
void	ignore() Signals that the current JnlpConnectionStateListener is not interested in this event any more.
void	reject(ConnectionRefusalException reason) Signals that the current JnlpConnectionStateListener is declaring ownership of this event, rejecting the connection and all other JnlpConnectionStateListener instances will now be ignored.
<S extends JnlpConnectionState.ListenerState> void	setStash(S stash) Stores some listener specific state for later retrieval.

Methods inherited from class java.lang.Object

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

Field Detail

SECRET_KEY

public static final String SECRET_KEY

The property name for the secret key.

See Also:

Constant Field Values

CLIENT_NAME_KEY

public static final String CLIENT_NAME_KEY

The property name for the client name key.

See Also:

Constant Field Values

COOKIE_KEY

public static final String COOKIE_KEY

The proprty name for the cookie name key.

See Also:

Constant Field Values

Constructor Detail

JnlpConnectionState

protected JnlpConnectionState(@Nonnull
                              Socket socket,
                              List<? extends JnlpConnectionStateListener> listeners)

Constructor.

Parameters:

socket - the Socket.

listeners - the JnlpConnectionStateListener instances.

Method Detail

getSocket

@Nonnull
public Socket getSocket()

Gets the socket that the connection is on.

Returns:

the socket that the connection is on.

getProperties

public Map<String,String> getProperties()

Gets the connection properties.

Returns:

the connection properties.

Throws:

IllegalStateException - if invoked before JnlpConnectionStateListener.afterProperties(JnlpConnectionState)

getProperty

public String getProperty(String name)

Gets the named connection property.

Parameters:

name - the property name.

Returns:

the connection property.

Throws:

IllegalStateException - if invoked before JnlpConnectionStateListener.afterProperties(JnlpConnectionState)

getChannelBuilder

public ChannelBuilder getChannelBuilder()

Gets the ChannelBuilder that will be used to create the connection's Channel.

Returns:

the ChannelBuilder

Throws:

IllegalStateException - if invoked outside of JnlpConnectionStateListener.beforeChannel(JnlpConnectionState)

getChannel

public Channel getChannel()

Gets the connection's Channel.

Returns:

the Channel (may be closed already), may be null in JnlpConnectionStateListener.afterDisconnect(JnlpConnectionState) if the socket was closed by the client.

Throws:

IllegalStateException - if invoked before JnlpConnectionStateListener.afterChannel(JnlpConnectionState)

getCloseCause

@CheckForNull
public IOException getCloseCause()

Gets the reason for the channel being closed if available.

Returns:

the reason or null if termination was normal.

Throws:

IllegalStateException - if invoked before JnlpConnectionStateListener.channelClosed(JnlpConnectionState)

ignore

public void ignore()

Signals that the current JnlpConnectionStateListener is not interested in this event any more. If all JnlpConnectionStateListener implementations ignore() the event then the connection will be rejected.

Throws:

IllegalStateException - if invoked outside of JnlpConnectionStateListener.beforeProperties(JnlpConnectionState) or JnlpConnectionStateListener.afterProperties(JnlpConnectionState).

approve

public void approve()

Signals that the current JnlpConnectionStateListener is declaring ownership of this event, approving the connection and all other JnlpConnectionStateListener instances will now be ignored. This method must be called by at least one JnlpConnectionStateListener or the connection will be rejected.

Throws:

IllegalStateException - if invoked outside of JnlpConnectionStateListener.beforeProperties(JnlpConnectionState) or JnlpConnectionStateListener.afterProperties(JnlpConnectionState).

reject

public void reject(ConnectionRefusalException reason)

Signals that the current JnlpConnectionStateListener is declaring ownership of this event, rejecting the connection and all other JnlpConnectionStateListener instances will now be ignored.

Throws:

IllegalStateException - if invoked outside of JnlpConnectionStateListener.beforeProperties(JnlpConnectionState) or JnlpConnectionStateListener.afterProperties(JnlpConnectionState).

getStash

@CheckForNull
public <S extends JnlpConnectionState.ListenerState> S getStash(Class<S> clazz)

Retrieves the previously stashed state.

Type Parameters:

S - the expected class of the stashed state.

Parameters:

clazz - the expected class of the stashed state.

Returns:

the stashed state.

Throws:

IllegalStateException - if invoked before approve()

See Also:

setStash(ListenerState)

setStash

public <S extends JnlpConnectionState.ListenerState> void setStash(@CheckForNull
                                                                   S stash)

Stores some listener specific state for later retrieval.

Type Parameters:

S - the expected class of the stashed state.

Parameters:

stash - the state to stash.

Throws:

IllegalStateException - if invoked before approve()

See Also:

getStash(Class)