Package org.opendaylight.openflowplugin.impl.connection

Class ConnectionContextImpl

java.lang.Object

org.opendaylight.openflowplugin.impl.connection.ConnectionContextImpl

All Implemented Interfaces:

ConnectionContext

public class ConnectionContextImpl
extends Object
implements ConnectionContext

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext

ConnectionContext.CONNECTION_STATE

Constructor Summary

Constructors

Constructor	Description
ConnectionContextImpl(ConnectionAdapter connectionAdapter, DeviceConnectionStatusProvider deviceConnectionStatusProvider)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	changeStateToHandshaking()	change internal state to ConnectionContext.CONNECTION_STATE.HANDSHAKING.
void	changeStateToTimeouting()	change internal state to ConnectionContext.CONNECTION_STATE.TIMEOUTING.
void	changeStateToWorking()	change internal state to ConnectionContext.CONNECTION_STATE.WORKING.
void	closeConnection(boolean propagate)	actively drop associated connection.
boolean	equals(Object object)
ConnectionAdapter	getConnectionAdapter()	Returns connection adapter.
ConnectionContext.CONNECTION_STATE	getConnectionState()	Method returns current connection state.
DeviceInfo	getDeviceInfo()	Create and return basic device info.
FeaturesReply	getFeatures()	Getter.
NodeId	getNodeId()	Method returns identifier of device whic connection represents this context.
OutboundQueue	getOutboundQueueProvider()	Returns reference to OFJava outbound queue provider.
String	getSafeNodeIdForLOG()	Get safe nodeId for logging.
void	handlePortStatusMessage(PortStatusMessage portStatusMessage)	Handle received port status message.
void	handshakeSuccessful()	This method creates a basic device information.
int	hashCode()
void	onConnectionClosed()	cleanup context upon connection closed event (by device).
List<PortStatusMessage>	retrieveAndClearPortStatusMessages()
void	setDeviceDisconnectedHandler(DeviceDisconnectedHandler deviceDisconnectedHandler)	Method sets handler for handling closing connections.
void	setFeatures(FeaturesReply newFeaturesReply)	Setter.
void	setHandshakeContext(HandshakeContext handshakeContext)	Setter.
void	setNodeId(NodeId nodeId)	Setter for nodeId.
void	setOutboundQueueHandleRegistration(OutboundQueueHandlerRegistration<OutboundQueueProvider> newRegistration)
void	setOutboundQueueProvider(OutboundQueueProvider outboundQueueProvider)	Method sets reference to OFJava outbound queue provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionContextImpl

public ConnectionContextImpl(ConnectionAdapter connectionAdapter,
                             DeviceConnectionStatusProvider deviceConnectionStatusProvider)

Constructor.

Parameters:

connectionAdapter - - connection adapter

Method Detail

getConnectionAdapter

public ConnectionAdapter getConnectionAdapter()

Description copied from interface: ConnectionContext

Returns connection adapter.

Specified by:

getConnectionAdapter in interface ConnectionContext

Returns:

the connectionAdapter

getOutboundQueueProvider

public OutboundQueue getOutboundQueueProvider()

Description copied from interface: ConnectionContext

Returns reference to OFJava outbound queue provider. Outbound queue is used for outbound messages processing.

Specified by:

getOutboundQueueProvider in interface ConnectionContext

Returns:

OutboundQueueProvider

setOutboundQueueProvider

public void setOutboundQueueProvider(OutboundQueueProvider outboundQueueProvider)

Description copied from interface: ConnectionContext

Method sets reference to OFJava outbound queue provider.

Specified by:

setOutboundQueueProvider in interface ConnectionContext

Parameters:

outboundQueueProvider - OutboundQueueProvider

getConnectionState

public ConnectionContext.CONNECTION_STATE getConnectionState()

Description copied from interface: ConnectionContext

Method returns current connection state.

Specified by:

getConnectionState in interface ConnectionContext

Returns:

ConnectionContext.CONNECTION_STATE

getNodeId

public NodeId getNodeId()

Description copied from interface: ConnectionContext

Method returns identifier of device whic connection represents this context.

Specified by:

getNodeId in interface ConnectionContext

Returns:

NodeId

setNodeId

public void setNodeId(NodeId nodeId)

Description copied from interface: ConnectionContext

Setter for nodeId.

Specified by:

setNodeId in interface ConnectionContext

Parameters:

nodeId - node id

getFeatures

public FeaturesReply getFeatures()

Description copied from interface: ConnectionContext

Getter.

Specified by:

getFeatures in interface ConnectionContext

Returns:

featureReply as received from device during handshake

setDeviceDisconnectedHandler

public void setDeviceDisconnectedHandler(DeviceDisconnectedHandler deviceDisconnectedHandler)

Description copied from interface: ConnectionContext

Method sets handler for handling closing connections.

Specified by:

setDeviceDisconnectedHandler in interface ConnectionContext

Parameters:

deviceDisconnectedHandler - handler for disconnect

setFeatures

public void setFeatures(FeaturesReply newFeaturesReply)

Description copied from interface: ConnectionContext

Setter.

Specified by:

setFeatures in interface ConnectionContext

Parameters:

newFeaturesReply - as received from device during handshake

closeConnection

public void closeConnection(boolean propagate)

Description copied from interface: ConnectionContext

actively drop associated connection.

Specified by:

closeConnection in interface ConnectionContext

Parameters:

propagate - true if event need to be propagated to higher contexts (device, stats, rpc..) or false if invoked from higher context

See Also:

ConnectionAdapter.disconnect()

onConnectionClosed

public void onConnectionClosed()

Description copied from interface: ConnectionContext

cleanup context upon connection closed event (by device).

Specified by:

onConnectionClosed in interface ConnectionContext

getSafeNodeIdForLOG

public String getSafeNodeIdForLOG()

Get safe nodeId for logging.

Specified by:

getSafeNodeIdForLOG in interface ConnectionContext

Returns:

string value od nodeId or string "null"

setOutboundQueueHandleRegistration

public void setOutboundQueueHandleRegistration(OutboundQueueHandlerRegistration<OutboundQueueProvider> newRegistration)

Specified by:

setOutboundQueueHandleRegistration in interface ConnectionContext

changeStateToHandshaking

public void changeStateToHandshaking()

Description copied from interface: ConnectionContext

change internal state to ConnectionContext.CONNECTION_STATE.HANDSHAKING.

Specified by:

changeStateToHandshaking in interface ConnectionContext

changeStateToTimeouting

public void changeStateToTimeouting()

Description copied from interface: ConnectionContext

change internal state to ConnectionContext.CONNECTION_STATE.TIMEOUTING.

Specified by:

changeStateToTimeouting in interface ConnectionContext

changeStateToWorking

public void changeStateToWorking()

Description copied from interface: ConnectionContext

change internal state to ConnectionContext.CONNECTION_STATE.WORKING.

Specified by:

changeStateToWorking in interface ConnectionContext

handlePortStatusMessage

public void handlePortStatusMessage(PortStatusMessage portStatusMessage)

Description copied from interface: ConnectionContext

Handle received port status message.

Specified by:

handlePortStatusMessage in interface ConnectionContext

Parameters:

portStatusMessage - port status message

retrieveAndClearPortStatusMessages

public List<PortStatusMessage> retrieveAndClearPortStatusMessages()

Specified by:

retrieveAndClearPortStatusMessages in interface ConnectionContext

getDeviceInfo

public DeviceInfo getDeviceInfo()

Description copied from interface: ConnectionContext

Create and return basic device info.

Specified by:

getDeviceInfo in interface ConnectionContext

Returns:

created device info

handshakeSuccessful

public void handshakeSuccessful()

Description copied from interface: ConnectionContext

This method creates a basic device information. Should be called after nodeId and features are set in connection context.

Specified by:

handshakeSuccessful in interface ConnectionContext

setHandshakeContext

public void setHandshakeContext(HandshakeContext handshakeContext)

Description copied from interface: ConnectionContext

Setter.

Specified by:

setHandshakeContext in interface ConnectionContext

Parameters:

handshakeContext - corresponding handshake context used upon this connection

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object