org.onosproject.pcep.controller.impl

Class PcepClientImpl

java.lang.Object

org.onosproject.pcep.controller.impl.PcepClientImpl

All Implemented Interfaces:

PcepClientDriver, PcepClient

public class PcepClientImpl
extends Object
implements PcepClientDriver

An abstract representation of an OpenFlow switch. Can be extended by others to serve as a base for their vendor specific representation of a switch.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	channelId
protected boolean	isHandShakeComplete
protected org.slf4j.Logger	log
protected boolean	startDriverHandshakeCalled

Constructor Summary

Constructors

Constructor and Description
PcepClientImpl()

Method Summary

Modifier and Type	Method and Description
void	addNode(PcepClient pc) Adds PCEP device when session is successfully established.
void	addSyncMsgToList(PccId pccId, PcepStateReport rptMsg) Adds report message received during LSPDB sync into temporary cache.
ClientCapability	capability() Obtains capability supported by client.
String	channelId() Identifies the channel used to communicate with the pcc.
boolean	connectClient() Announce to the Pcep agent that this pcc client has connected.
Boolean	delegationInfo(LspKey lspKey) Returns delegation flag for the given LSP info.
void	deleteNode(PccId pccId) Removes PCEP device when session is disconnected.
void	disconnectClient() Disconnects the pcc by closing the TCP connection.
PcepFactory	factory() Provides the factory for this PCEP version.
PccId	getPccId() Gets the ipAddress of the client.
String	getStringId() Gets a string version of the ID for this pcc.
List<PcepStateReport>	getSyncMsgList(PccId pccId) Returns the list of report messages received during LSPDB sync.
void	handleMessage(PcepMessage m) Handle a message from the pcc.
void	init(PccId pccId, PcepVersion pcepVersion, PcepPacketStats pktStats) Initializes the behavior.
void	initializeSyncMsgList(PccId pccId) Creates a temporary cache to hold report messages received during LSPDB sync.
boolean	isConnected() Checks if the pcc is still connected.
boolean	isHandshakeComplete() Checks whether the handshake is complete.
boolean	isOptical() Indicates if this pcc is optical.
PcepSyncStatus	labelDbSyncStatus() Indicates the label DB synchronization status of this pcc.
PcepSyncStatus	lspDbSyncStatus() Indicates the LSP state synchronization status of this pcc.
void	removeConnectedClient() Remove this pcc client from the Pcep agent.
void	removeSyncMsgList(PccId pccId) Removes the list of report messages received during LSPDB sync.
void	sendMessage(List<PcepMessage> msgs) Writes the PcepMessage list to the driver.
void	sendMessage(PcepMessage m) Writes the message to the driver.
void	setAgent(PcepAgent ag) Sets the Pcep agent to be used.
void	setCapability(ClientCapability capability) Sets capability negotiated during open message exchange.
void	setChannel(org.jboss.netty.channel.Channel channel) Sets the associated Netty channel for this pcc.
void	setConnected(boolean connected) Sets whether the pcc is connected.
void	setLabelDbSyncStatus(PcepSyncStatus syncStatus) Sets the status of label DB synchronization.
void	setLspAndDelegationInfo(LspKey lspKey, boolean dFlag) Sets D flag for the given LSP and its LSP info.
void	setLspDbSyncStatus(PcepSyncStatus syncStatus) Sets the status of LSP state synchronization.
void	setPcDeadTime(byte deadTime) Sets the dead time for this pcc.
void	setPcKeepAliveTime(byte keepAliveTime) Sets the keep alive time for this pcc.
void	setPcSessionId(byte sessionId) Sets the session id for this pcc.
void	setPcVersion(PcepVersion pcepVersion) Sets the PCEP version for this pcc.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

channelId

protected String channelId

startDriverHandshakeCalled

protected boolean startDriverHandshakeCalled

isHandShakeComplete

protected boolean isHandShakeComplete

Constructor Detail

PcepClientImpl

public PcepClientImpl()

Method Detail

init

public void init(PccId pccId,
                 PcepVersion pcepVersion,
                 PcepPacketStats pktStats)

Description copied from interface: PcepClientDriver

Initializes the behavior.

Specified by:

init in interface PcepClientDriver

Parameters:

pccId - id of pcc

pcepVersion - Pcep version

pktStats - Pcep Packet Stats

disconnectClient

public final void disconnectClient()

Description copied from interface: PcepClient

Disconnects the pcc by closing the TCP connection. Results in a call to the channel handler's channelDisconnected method for cleanup.

Specified by:

disconnectClient in interface PcepClient

setCapability

public void setCapability(ClientCapability capability)

Description copied from interface: PcepClient

Sets capability negotiated during open message exchange.

Specified by:

setCapability in interface PcepClient

Parameters:

capability - supported by client

capability

public ClientCapability capability()

Description copied from interface: PcepClient

Obtains capability supported by client.

Specified by:

capability in interface PcepClient

Returns:

capability supported by client

sendMessage

public final void sendMessage(PcepMessage m)

Description copied from interface: PcepClient

Writes the message to the driver.

Specified by:

sendMessage in interface PcepClient

Parameters:

m - the message to write

sendMessage

public final void sendMessage(List<PcepMessage> msgs)

Description copied from interface: PcepClient

Writes the PcepMessage list to the driver.

Specified by:

sendMessage in interface PcepClient

Parameters:

msgs - the messages to be written

isConnected

public final boolean isConnected()

Description copied from interface: PcepClient

Checks if the pcc is still connected.

Specified by:

isConnected in interface PcepClient

Returns:

true if client is connected, false otherwise

setConnected

public final void setConnected(boolean connected)

Description copied from interface: PcepClientDriver

Sets whether the pcc is connected.

Specified by:

setConnected in interface PcepClientDriver

Parameters:

connected - whether the pcc is connected

setChannel

public final void setChannel(org.jboss.netty.channel.Channel channel)

Description copied from interface: PcepClientDriver

Sets the associated Netty channel for this pcc.

Specified by:

setChannel in interface PcepClientDriver

Parameters:

channel - the Netty channel

channelId

public String channelId()

Description copied from interface: PcepClient

Identifies the channel used to communicate with the pcc.

Specified by:

channelId in interface PcepClient

Returns:

string representation of the connection to the client

getPccId

public final PccId getPccId()

Description copied from interface: PcepClient

Gets the ipAddress of the client.

Specified by:

getPccId in interface PcepClient

Returns:

the client pccId in IPAddress format

getStringId

public final String getStringId()

Description copied from interface: PcepClient

Gets a string version of the ID for this pcc.

Specified by:

getStringId in interface PcepClient

Returns:

string version of the ID

setPcVersion

public final void setPcVersion(PcepVersion pcepVersion)

Description copied from interface: PcepClientDriver

Sets the PCEP version for this pcc.

Specified by:

setPcVersion in interface PcepClientDriver

Parameters:

pcepVersion - the version to set.

setPcKeepAliveTime

public void setPcKeepAliveTime(byte keepAliveTime)

Description copied from interface: PcepClientDriver

Sets the keep alive time for this pcc.

Specified by:

setPcKeepAliveTime in interface PcepClientDriver

Parameters:

keepAliveTime - the keep alive time to set.

setPcDeadTime

public void setPcDeadTime(byte deadTime)

Description copied from interface: PcepClientDriver

Sets the dead time for this pcc.

Specified by:

setPcDeadTime in interface PcepClientDriver

Parameters:

deadTime - the dead timer value to set.

setPcSessionId

public void setPcSessionId(byte sessionId)

Description copied from interface: PcepClientDriver

Sets the session id for this pcc.

Specified by:

setPcSessionId in interface PcepClientDriver

Parameters:

sessionId - the session id value to set.

setLspDbSyncStatus

public void setLspDbSyncStatus(PcepSyncStatus syncStatus)

Description copied from interface: PcepClient

Sets the status of LSP state synchronization.

Specified by:

setLspDbSyncStatus in interface PcepClient

Parameters:

syncStatus - LSP synchronization status to be set

lspDbSyncStatus

public PcepSyncStatus lspDbSyncStatus()

Description copied from interface: PcepClient

Indicates the LSP state synchronization status of this pcc.

Specified by:

lspDbSyncStatus in interface PcepClient

Returns:

LSP state synchronization status.

setLabelDbSyncStatus

public void setLabelDbSyncStatus(PcepSyncStatus syncStatus)

Description copied from interface: PcepClient

Sets the status of label DB synchronization.

Specified by:

setLabelDbSyncStatus in interface PcepClient

Parameters:

syncStatus - label DB synchronization status to be set

labelDbSyncStatus

public PcepSyncStatus labelDbSyncStatus()

Description copied from interface: PcepClient

Indicates the label DB synchronization status of this pcc.

Specified by:

labelDbSyncStatus in interface PcepClient

Returns:

label DB synchronization status.

handleMessage

public final void handleMessage(PcepMessage m)

Description copied from interface: PcepClient

Handle a message from the pcc.

Specified by:

handleMessage in interface PcepClient

Parameters:

m - the message to handle

addNode

public void addNode(PcepClient pc)

Description copied from interface: PcepClient

Adds PCEP device when session is successfully established.

Specified by:

addNode in interface PcepClient

Parameters:

pc - PCEP client details

deleteNode

public void deleteNode(PccId pccId)

Description copied from interface: PcepClient

Removes PCEP device when session is disconnected.

Specified by:

deleteNode in interface PcepClient

Parameters:

pccId - PCEP client ID

connectClient

public final boolean connectClient()

Description copied from interface: PcepClientDriver

Announce to the Pcep agent that this pcc client has connected.

Specified by:

connectClient in interface PcepClientDriver

Returns:

true if successful, false if duplicate switch.

removeConnectedClient

public final void removeConnectedClient()

Description copied from interface: PcepClientDriver

Remove this pcc client from the Pcep agent.

Specified by:

removeConnectedClient in interface PcepClientDriver

factory

public PcepFactory factory()

Description copied from interface: PcepClient

Provides the factory for this PCEP version.

Specified by:

factory in interface PcepClient

Returns:

PCEP version specific factory.

isHandshakeComplete

public boolean isHandshakeComplete()

Description copied from interface: PcepClientDriver

Checks whether the handshake is complete.

Specified by:

isHandshakeComplete in interface PcepClientDriver

Returns:

true is finished, false if not.

setAgent

public final void setAgent(PcepAgent ag)

Description copied from interface: PcepClientDriver

Sets the Pcep agent to be used. This method can only be called once.

Specified by:

setAgent in interface PcepClientDriver

Parameters:

ag - the agent to set.

setLspAndDelegationInfo

public void setLspAndDelegationInfo(LspKey lspKey,
                                    boolean dFlag)

Description copied from interface: PcepClient

Sets D flag for the given LSP and its LSP info.

Specified by:

setLspAndDelegationInfo in interface PcepClient

Parameters:

lspKey - contains LSP info

dFlag - delegation flag in LSP object

delegationInfo

public Boolean delegationInfo(LspKey lspKey)

Description copied from interface: PcepClient

Returns delegation flag for the given LSP info.

Specified by:

delegationInfo in interface PcepClient

Parameters:

lspKey - contains LSP info

Returns:

delegation flag

initializeSyncMsgList

public void initializeSyncMsgList(PccId pccId)

Description copied from interface: PcepClient

Creates a temporary cache to hold report messages received during LSPDB sync.

Specified by:

initializeSyncMsgList in interface PcepClient

Parameters:

pccId - PCC id which is the key to store report messages

getSyncMsgList

public List<PcepStateReport> getSyncMsgList(PccId pccId)

Description copied from interface: PcepClient

Returns the list of report messages received during LSPDB sync.

Specified by:

getSyncMsgList in interface PcepClient

Parameters:

pccId - PCC id which is the key for all the report messages

Returns:

list of report messages received during LSPDB sync

removeSyncMsgList

public void removeSyncMsgList(PccId pccId)

Description copied from interface: PcepClient

Removes the list of report messages received during LSPDB sync.

Specified by:

removeSyncMsgList in interface PcepClient

Parameters:

pccId - PCC id which is the key for all the report messages

addSyncMsgToList

public void addSyncMsgToList(PccId pccId,
                             PcepStateReport rptMsg)

Description copied from interface: PcepClient

Adds report message received during LSPDB sync into temporary cache.

Specified by:

addSyncMsgToList in interface PcepClient

Parameters:

pccId - PCC id which is the key to store report messages

rptMsg - the report message to be stored

isOptical

public boolean isOptical()

Description copied from interface: PcepClient

Indicates if this pcc is optical.

Specified by:

isOptical in interface PcepClient

Returns:

true if optical

toString

public String toString()

Overrides:

toString in class Object