org.apache.sshd.common

Interface AttributeStore

All Known Subinterfaces:

Channel, ClientChannel, ClientFactoryManager, ClientSession, FactoryManager, ServerChannel, ServerFactoryManager, ServerSession, Session

All Known Implementing Classes:

AbstractChannel, AbstractClientChannel, AbstractClientSession, AbstractFactoryManager, AbstractServerChannel, AbstractServerSession, AbstractSession, AgentForwardedChannel, AgentForwardedChannel, ChannelAgentForwarding, ChannelAgentForwarding, ChannelDirectTcpip, ChannelExec, ChannelForwardedX11, ChannelSession, ChannelSession, ChannelShell, ChannelSubsystem, ClientSessionImpl, PtyCapableChannelSession, ServerSessionImpl, SshClient, SshServer, TcpipClientChannel, TcpipServerChannel

public interface AttributeStore

Provides the capability to attach in-memory attributes to the entity

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AttributeStore.AttributeKey<T> Type safe key for storage of user attributes.

Method Summary

Modifier and Type	Method and Description
<T> T	getAttribute(AttributeStore.AttributeKey<T> key) Returns the value of the user-defined attribute.
<T> T	removeAttribute(AttributeStore.AttributeKey<T> key) Removes the user-defined attribute
<T> T	resolveAttribute(AttributeStore.AttributeKey<T> key) Attempts to resolve the associated value by going up the store's hierarchy (if any)
static <T> T	resolveAttribute(Channel channel, AttributeStore.AttributeKey<T> key) Attempts to use the channel attribute, if not found then tries the session
static <T> T	resolveAttribute(FactoryManager manager, AttributeStore.AttributeKey<T> key)
static <T> T	resolveAttribute(Session session, AttributeStore.AttributeKey<T> key) Attempts to use the session's attribute, if not found then tries the factory manager
<T> T	setAttribute(AttributeStore.AttributeKey<T> key, T value) Sets a user-defined attribute.

Method Detail

getAttribute

<T> T getAttribute(AttributeStore.AttributeKey<T> key)

Returns the value of the user-defined attribute.

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

Returns:

null if there is no value associated with the specified key

setAttribute

<T> T setAttribute(AttributeStore.AttributeKey<T> key,
                   T value)

Sets a user-defined attribute.

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

value - The value of the attribute; must not be null.

Returns:

The old value of the attribute; null if it is new.

removeAttribute

<T> T removeAttribute(AttributeStore.AttributeKey<T> key)

Removes the user-defined attribute

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

Returns:

The removed value; null if no previous value

resolveAttribute

<T> T resolveAttribute(AttributeStore.AttributeKey<T> key)

Attempts to resolve the associated value by going up the store's hierarchy (if any)

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

Returns:

null if there is no value associated with the specified key

resolveAttribute

static <T> T resolveAttribute(FactoryManager manager,
                              AttributeStore.AttributeKey<T> key)

Type Parameters:

T - The generic attribute type

Parameters:

manager - The FactoryManager - ignored if null

key - The attribute key - never null

Returns:

Associated value - null if not found

resolveAttribute

static <T> T resolveAttribute(Session session,
                              AttributeStore.AttributeKey<T> key)

Attempts to use the session's attribute, if not found then tries the factory manager

Type Parameters:

T - The generic attribute type

Parameters:

session - The Session - ignored if null

key - The attribute key - never null

Returns:

Associated value - null if not found

See Also:

FactoryManagerHolder.getFactoryManager(), resolveAttribute(FactoryManager, AttributeKey)

resolveAttribute

static <T> T resolveAttribute(Channel channel,
                              AttributeStore.AttributeKey<T> key)

Attempts to use the channel attribute, if not found then tries the session

Type Parameters:

T - The generic attribute type

Parameters:

channel - The Channel - ignored if null

key - The attribute key - never null

Returns:

Associated value - null if not found

See Also:

FactoryManagerHolder.getFactoryManager(), resolveAttribute(Session, AttributeKey)