GenericPCEPSession (PCE 1.3.3 API)

java.lang.Object
- java.lang.Thread
- - es.tid.pce.pcepsession.GenericPCEPSession

All Implemented Interfaces:

PCEPSession, Runnable

Direct Known Subclasses:

BackupPCESession, ChildPCESession, DomainPCESession, ParentPCESession, PCCPCEPSession, PCEPClientSession
```
public abstract class GenericPCEPSession
extends Thread
implements PCEPSession
```
Generic PCEP Session. Implements the basics of a PCEP Session Any particular session must inherit this one

Author:

ogondio

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`deadTimerLocal` Value of the deadtimer that the PCE sends, so the PCC uses it If in this time the PCC has not received anything, it closes the session It is set by the PCE (in this case, the local peer)
`protected int`	`deadTimerPeer` Value of the deadtimer that the PCC sends.
`protected DeadTimerThread`	`deadTimerT` Thread to check if the connection is still alive.
`protected int`	`FSMstate` Finite State Machine of the PCEP protocol
`protected DataInputStream`	`in` DataInputStream to receive messages from PCC
`protected boolean`	`isSessionSRCapable`
`protected boolean`	`isSessionStateful`
`protected int`	`keepAliveLocal` Value of the Keepalive timer set by the Local PCE.
`protected int`	`keepAlivePeer` Value of the Keepalive timer of the peer PCC.
`protected KeepAliveThread`	`keepAliveT` Thread to send periodic Keepalives
`protected boolean`	`localOK`
`protected PcepCapability`	`localPcepCapability` Capabilities of the LOCAL Entity
`protected org.slf4j.Logger`	`log` Logger to write the Parent PCE server log
`protected byte[]`	`msg` Byte array to store the last PCEP message read.
`protected es.tid.pce.pcep.objects.OPEN`	`open` OPEN object of PCEPOpen message.
`protected int`	`openRetry`
`protected DataOutputStream`	`out` DataOutputStream to send messages to the peer PCC
`protected PCEPSessionsInformation`	`pcepSessionManager` PCEP Session Manager
`protected PcepCapability`	`peerPcepCapability` Capabilities of the Peer Entity
`protected Inet4Address`	`remoteDomainId` Remote Domain ID null if not sent
`protected LinkedList<Integer>`	`remoteOfCodes` Remote List of OF Codes If sent by the peer PCE
`protected boolean`	`remoteOK` RemoteOK: a boolean that is set to 1 if the system has received an acceptable Open message.
`protected Inet4Address`	`remotePCEId` Remote PCE ID Address null if not sent
`protected Inet4Address`	`remotePeerIP` IP Address of the remote PCEP Peer
`protected RequestQueue`	`req` Queue to send the Computing Path Requests
`static long`	`sessionIdCounter` Initial number of the session ID (internal use only)
`protected int`	`sessionMSD`
`protected Socket`	`socket` Socket of the communication between PCC and PCE
`protected Timer`	`timer` Timer to schedule KeepWait and OpenWait Timers

Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description

GenericPCEPSession(PCEPSessionsInformation pcepSessionManager)

Constructors
Constructor and Description
`GenericPCEPSession(PCEPSessionsInformation pcepSessionManager)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`cancelDeadTimer()` Ends the DeadTimer Thread
`void`	`cancelKeepAlive()` Ends the KeepAlive Thread
`void`	`close(int reason)` Close the PCE session List of reasons (RFC 5440): Value Meaning 1 No explanation provided 2 DeadTimer expired 3 Reception of a malformed PCEP message 4 Reception of an unacceptable number of unknown requests/replies 5 Reception of an unacceptable number of unrecognized PCEP messages
`protected void`	`endConnections()` Ends current connections
`protected abstract void`	`endSession()` DO HERE ANYTHING NEEDED AT CLOSING??
`int`	`getFSMstate()`
`DataOutputStream`	`getOut()`
`LinkedList<Integer>`	`getRemoteOfCodes()`
`Inet4Address`	`getRemotePCEId()`
`Socket`	`getSocket()`
`protected void`	`initializePCEPSession(boolean zeroDeadTimerAccepted, int minimumKeepAliveTimerAccepted, int maxDeadTimerAccepted, boolean isParentPCE, boolean requestsParentPCE, Inet4Address domainId, Inet4Address pceId, int databaseVersion)`
`void`	`killSession()` Finish the PCEP Session abruptly,
`void`	`newSessionId()`
`protected byte[]`	`readMsg(DataInputStream in)`
`protected byte[]`	`readMsgOptimized(DataInputStream in)`
`protected void`	`resetDeadTimer()` Resets the DeadTimerThread To be called every time a message in the session is received
`void`	`sendPCEPMessage(es.tid.pce.pcep.messages.PCEPMessage message)`
`protected void`	`setFSMstate(int fSMstate)`
`void`	`setOut(DataOutputStream out)`
`void`	`setRemotePCEId(Inet4Address remotePCEId)`
`String`	`shortInfo()`
`protected void`	`startDeadTimer()` Starts the deadTimerThread
`void`	`startKeepAlive()` Starts the Keep Alive Thread
`String`	`toString()`

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - localPcepCapability
```
protected PcepCapability localPcepCapability
```
    Capabilities of the LOCAL Entity
  - peerPcepCapability
```
protected PcepCapability peerPcepCapability
```
    Capabilities of the Peer Entity
  - pcepSessionManager
```
protected PCEPSessionsInformation pcepSessionManager
```
    PCEP Session Manager
  - keepAliveT
```
protected KeepAliveThread keepAliveT
```
    Thread to send periodic Keepalives
  - keepAliveLocal
```
protected int keepAliveLocal
```
    Value of the Keepalive timer set by the Local PCE. Used to send keepalives
  - keepAlivePeer
```
protected int keepAlivePeer
```
    Value of the Keepalive timer of the peer PCC. It is not used in the server!!!
  - deadTimerT
```
protected DeadTimerThread deadTimerT
```
    Thread to check if the connection is still alive. If in this time the PCE has not received anything, it closes the session It is set by the PCC (in this case, the remote peer)
  - deadTimerLocal
```
protected int deadTimerLocal
```
    Value of the deadtimer that the PCE sends, so the PCC uses it If in this time the PCC has not received anything, it closes the session It is set by the PCE (in this case, the local peer)
  - deadTimerPeer
```
protected int deadTimerPeer
```
    Value of the deadtimer that the PCC sends. It is used in the PCC in the thread
  - socket
```
protected Socket socket
```
    Socket of the communication between PCC and PCE
  - remotePeerIP
```
protected Inet4Address remotePeerIP
```
    IP Address of the remote PCEP Peer
  - out
```
protected DataOutputStream out
```
    DataOutputStream to send messages to the peer PCC
  - in
```
protected DataInputStream in
```
    DataInputStream to receive messages from PCC
  - req
```
protected RequestQueue req
```
    Queue to send the Computing Path Requests
  - log
```
protected org.slf4j.Logger log
```
    Logger to write the Parent PCE server log
  - timer
```
protected Timer timer
```
    Timer to schedule KeepWait and OpenWait Timers
  - FSMstate
```
protected int FSMstate
```
    Finite State Machine of the PCEP protocol
  - remotePCEId
```
protected Inet4Address remotePCEId
```
    Remote PCE ID Address null if not sent
  - remoteDomainId
```
protected Inet4Address remoteDomainId
```
    Remote Domain ID null if not sent
  - remoteOfCodes
```
protected LinkedList<Integer> remoteOfCodes
```
    Remote List of OF Codes If sent by the peer PCE
  - remoteOK
```
protected boolean remoteOK
```
    RemoteOK: a boolean that is set to 1 if the system has received an acceptable Open message.
  - localOK
```
protected boolean localOK
```
  - openRetry
```
protected int openRetry
```
  - msg
```
protected byte[] msg
```
    Byte array to store the last PCEP message read.
  - sessionIdCounter
```
public static long sessionIdCounter
```
    Initial number of the session ID (internal use only)
  - open
```
protected es.tid.pce.pcep.objects.OPEN open
```
    OPEN object of PCEPOpen message. It is used for stateful operations
  - isSessionStateful
```
protected boolean isSessionStateful
```
  - isSessionSRCapable
```
protected boolean isSessionSRCapable
```
  - sessionMSD
```
protected int sessionMSD
```
- Constructor Detail
  - GenericPCEPSession
```
public GenericPCEPSession(PCEPSessionsInformation pcepSessionManager)
```
- Method Detail
  - readMsg
```
protected byte[] readMsg(DataInputStream in)
                  throws IOException
```
    Throws:
    
    IOException
  - readMsgOptimized
```
protected byte[] readMsgOptimized(DataInputStream in)
                           throws IOException
```
    Throws:
    
    IOException
  - close
```
public void close(int reason)
```
    Close the PCE session
    
    List of reasons (RFC 5440):
    Value Meaning 1 No explanation provided 2 DeadTimer expired 3 Reception of a malformed PCEP message 4 Reception of an unacceptable number of unknown requests/replies 5 Reception of an unacceptable number of unrecognized PCEP messages
    
    Specified by:
    
    close in interface PCEPSession
    
    Parameters:
    
    reason - Reason for closing the PCEP Session
  - getOut
```
public DataOutputStream getOut()
```
  - setOut
```
public void setOut(DataOutputStream out)
```
  - startDeadTimer
```
protected void startDeadTimer()
```
    Starts the deadTimerThread
  - resetDeadTimer
```
protected void resetDeadTimer()
```
    Resets the DeadTimerThread To be called every time a message in the session is received
  - getSocket
```
public Socket getSocket()
```
  - cancelDeadTimer
```
protected void cancelDeadTimer()
```
    Ends the DeadTimer Thread
  - startKeepAlive
```
public void startKeepAlive()
```
    Starts the Keep Alive Thread
  - cancelKeepAlive
```
public void cancelKeepAlive()
```
    Ends the KeepAlive Thread
  - endConnections
```
protected void endConnections()
```
    Ends current connections
  - getFSMstate
```
public int getFSMstate()
```
  - setFSMstate
```
protected void setFSMstate(int fSMstate)
```
  - killSession
```
public void killSession()
```
    Description copied from interface: PCEPSession
    
    Finish the PCEP Session abruptly,
    
    Specified by:
    
    killSession in interface PCEPSession
  - endSession
```
protected abstract void endSession()
```
    DO HERE ANYTHING NEEDED AT CLOSING?? STATISTICS, ETC
  - initializePCEPSession
```
protected void initializePCEPSession(boolean zeroDeadTimerAccepted,
                                     int minimumKeepAliveTimerAccepted,
                                     int maxDeadTimerAccepted,
                                     boolean isParentPCE,
                                     boolean requestsParentPCE,
                                     Inet4Address domainId,
                                     Inet4Address pceId,
                                     int databaseVersion)
```
  - sendPCEPMessage
```
public void sendPCEPMessage(es.tid.pce.pcep.messages.PCEPMessage message)
```
    Specified by:
    
    sendPCEPMessage in interface PCEPSession
  - getRemotePCEId
```
public Inet4Address getRemotePCEId()
```
  - setRemotePCEId
```
public void setRemotePCEId(Inet4Address remotePCEId)
```
  - getRemoteOfCodes
```
public LinkedList<Integer> getRemoteOfCodes()
```
  - shortInfo
```
public String shortInfo()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Thread
  - newSessionId
```
public void newSessionId()
```

Class GenericPCEPSession

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Field Detail

localPcepCapability

peerPcepCapability

pcepSessionManager

keepAliveT

keepAliveLocal

keepAlivePeer

deadTimerT

deadTimerLocal

deadTimerPeer

socket

remotePeerIP

out

in

req

log

timer

FSMstate

remotePCEId

remoteDomainId

remoteOfCodes

remoteOK

localOK

openRetry

msg

sessionIdCounter

open

isSessionStateful

isSessionSRCapable

sessionMSD

Constructor Detail

GenericPCEPSession

Method Detail

readMsg

readMsgOptimized

close

getOut

setOut

startDeadTimer

resetDeadTimer

getSocket

cancelDeadTimer

startKeepAlive

cancelKeepAlive

endConnections

getFSMstate

setFSMstate

killSession

endSession

initializePCEPSession

sendPCEPMessage

getRemotePCEId

setRemotePCEId

getRemoteOfCodes

shortInfo

toString

newSessionId