es.tid.pce.pcep.objects

Class LSP

java.lang.Object

es.tid.pce.pcep.objects.PCEPObject

es.tid.pce.pcep.objects.LSP

All Implemented Interfaces:

PCEPElement

public class LSP
extends PCEPObject

http://tools.ietf.org/html/draft-ietf-pce-stateful-pce-9 7.3. LSP Object The LSP object MUST be present within PCRpt and PCUpd messages. The LSP object MAY be carried within PCReq and PCRep messages if the stateful PCE capability has been negotiated on the session. The LSP object contains a set of fields used to specify the target LSP, the operation to be performed on the LSP, and LSP Delegation. It also contains a flag indicating to a PCE that the LSP state synchronization is in progress. This document focuses on LSPs that are signaled with RSVP, many of the TLVs used with the LSP object mirror RSVP state. LSP Object-Class is [TBD]. LSP Object-Type is 1. The format of the LSP object body is shown in Figure 11: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PLSP-ID | Flag | O|A|R|S|D| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ // TLVs // | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 11: The LSP Object format PLSP-ID (20 bits): A PCEP-specific identifier for the LSP. A PCC creates a unique PLSP-ID for each LSP that is constant for the lifetime of a PCEP session. The PCC will advertise the same PLSP-ID on all PCEP sessions it maintains at a given times. The mapping of the Symbolic Path Name to PLSP-ID is communicated to the PCE by sending a PCRpt message containing the SYMBOLIC-PATH-NAME TLV. All subsequent PCEP messages then address the LSP by the PLSP-ID. The values of 0 and 0xFFFFF are reserved. Note that the PLSP-ID is a value that is constant for the lifetime of the PCEP session, during which time for an RSVP-signaled LSP there might be a different RSVP identifiers (LSP-id, tunnel-id) allocated it. Flags (12 bits): D (Delegate - 1 bit): on a PCRpt message, the D Flag set to 1 indicates that the PCC is delegating the LSP to the PCE. On a PCUpd message, the D flag set to 1 indicates that the PCE is confirming the LSP Delegation. To keep an LSP delegated to the PCE, the PCC must set the D flag to 1 on each PCRpt message for the duration of the delegation - the first PCRpt with the D flag set to 0 revokes the delegation. To keep the delegation, the PCE must set the D flag to 1 on each PCUpd message for the duration of the delegation - the first PCUpd with the D flag set to 0 returns the delegation. S (SYNC - 1 bit): the S Flag MUST be set to 1 on each PCRpt sent from a PCC during State Synchronization. The S Flag MUST be set to 0 in other PCRpt messages sent from the PCC. R(Remove - 1 bit): On PCRpt messages the R Flag indicates that the LSP has been removed from the PCC and the PCE SHOULD remove all state from its database. Upon receiving an LSP State Report with the R Flag set to 1 for an RSVP-signaled LSP, the PCE SHOULD remove all state for the path identified by the LSP Identifiers TLV from its database. When the all-zeros LSP-IDENTIFIERS-TLV is used, the PCE SHOULD remove all state for the PLSP-ID from its database. A(Administrative - 1 bit): On PCRpt messages, the A Flag indicates the PCC's target operational status for this LSP. On PCUpd messages, the A Flag indicates the LSP status that the PCE desires for this LSP. In both cases, a value of '1' means that the desired operational state is active, and a value of '0' means that the desired operational state is inactive. A PCC ignores the A flag on a PCUpd message unless the operator's policy allows the PCE to control the corresponding LSP's administrative state. O(Operational - 3 bits): On PCRpt messages, the O Field represents the operational status of the LSP. The following values are defined: 0 - DOWN: not active. 1 - UP: signalled. 2 - ACTIVE: up and carrying traffic. 3 - GOING-DOWN: LSP is being torn down, resources are being released. 4 - GOING-UP: LSP is being signalled. 5-7 - Reserved: these values are reserved for future use. Unassigned bits are considered reserved. They MUST be set to 0 on transmission and MUST be ignored on receipt. TLVs that may be included in the LSP Object are described in the following sections.

Author:

Fernando Munoz del Nuevo, Oscar Gonzalez de Dios

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	aFlag
protected boolean	dFlag
protected int	lspId
protected int	opFlags
protected boolean	rFlag
protected boolean	sFlag

Fields inherited from class es.tid.pce.pcep.objects.PCEPObject

Ibit, log, object_bytes, ObjectClass, ObjectLength, OT, Pbit, Res

Constructor Summary

Constructors

Constructor and Description
LSP()
LSP(byte[] bytes, int offset)

Method Summary

Modifier and Type	Method and Description
void	decode() Decode the object.
void	encode() Encode the object.
boolean	equals(Object obj)
int	getLSP_sig_type()
LSPDatabaseVersionTLV	getLspDBVersion_tlv()
LSPErrorCodeTLV	getLspErrorCodes_tlv()
int	getLspId()
IPv4LSPIdentifiersTLV	getLspIdentifiers_tlv()
int	getOpFlags()
RSVPErrorSpecTLV	getRsvpErrorSpec_tlv()
SymbolicPathNameTLV	getSymbolicPathNameTLV_tlv()
int	hashCode()
boolean	isaFlag()
boolean	isdFlag()
boolean	isrFlag()
boolean	issFlag()
void	setAFlag(boolean aFlag)
void	setDFlag(boolean dFlag)
void	setLSP_sig_type(int lSP_sig_type)
void	setLspDBVersion_tlv(LSPDatabaseVersionTLV lspDBVersion_tlv)
void	setLspErrorCodes_tlv(LSPErrorCodeTLV lspErrorCodes_tlv)
void	setLspId(int lspId)
void	setLspIdentifiers_tlv(IPv4LSPIdentifiersTLV lspIdentifiers_tlv)
void	setOpFlags(int opFlags)
void	setRFlag(boolean rFlag)
void	setRsvpErrorSpec_tlv(RSVPErrorSpecTLV rsvpErrorSpec_tlv)
void	setSFlag(boolean sFlag)
void	setSymbolicPathNameTLV_tlv(SymbolicPathNameTLV symbolicPathNameTLV_tlv)
String	toString()

Methods inherited from class es.tid.pce.pcep.objects.PCEPObject

decode, decodeHeader, encode_header, getBytes, getLength, getObject_bytes, getObjectClass, getObjectClass, getObjectLength, getObjectType, getOT, getRes, isIbit, isPbit, setIbit, setObject_bytes, setObjectClass, setObjectLength, setOT, setPbit, setRes, supportedObject

Methods inherited from class java.lang.Object

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

Field Detail

lspId

protected int lspId

dFlag

protected boolean dFlag

sFlag

protected boolean sFlag

rFlag

protected boolean rFlag

aFlag

protected boolean aFlag

opFlags

protected int opFlags

Constructor Detail

LSP

public LSP()

LSP

public LSP(byte[] bytes,
           int offset)
    throws MalformedPCEPObjectException

Throws:

MalformedPCEPObjectException

Method Detail

encode

public void encode()

Description copied from class: PCEPObject

Encode the object. It is specific to the PCEP Object. Must be implemented in each object!!!!!

Specified by:

encode in interface PCEPElement

Specified by:

encode in class PCEPObject

decode

public void decode()
            throws MalformedPCEPObjectException

Description copied from class: PCEPObject

Decode the object. It is specific to the PCEP Object. Must be implemented in each object!!!!

Specified by:

decode in class PCEPObject

Throws:

MalformedPCEPObjectException

getLspId

public int getLspId()

getSymbolicPathNameTLV_tlv

public SymbolicPathNameTLV getSymbolicPathNameTLV_tlv()

setSymbolicPathNameTLV_tlv

public void setSymbolicPathNameTLV_tlv(SymbolicPathNameTLV symbolicPathNameTLV_tlv)

getLspIdentifiers_tlv

public IPv4LSPIdentifiersTLV getLspIdentifiers_tlv()

setLspIdentifiers_tlv

public void setLspIdentifiers_tlv(IPv4LSPIdentifiersTLV lspIdentifiers_tlv)

getLspErrorCodes_tlv

public LSPErrorCodeTLV getLspErrorCodes_tlv()

setLspErrorCodes_tlv

public void setLspErrorCodes_tlv(LSPErrorCodeTLV lspErrorCodes_tlv)

getRsvpErrorSpec_tlv

public RSVPErrorSpecTLV getRsvpErrorSpec_tlv()

setRsvpErrorSpec_tlv

public void setRsvpErrorSpec_tlv(RSVPErrorSpecTLV rsvpErrorSpec_tlv)

setLspId

public void setLspId(int lspId)

isdFlag

public boolean isdFlag()

setDFlag

public void setDFlag(boolean dFlag)

issFlag

public boolean issFlag()

setSFlag

public void setSFlag(boolean sFlag)

getOpFlags

public int getOpFlags()

setOpFlags

public void setOpFlags(int opFlags)

getLSP_sig_type

public int getLSP_sig_type()

setLSP_sig_type

public void setLSP_sig_type(int lSP_sig_type)

isrFlag

public boolean isrFlag()

setRFlag

public void setRFlag(boolean rFlag)

isaFlag

public boolean isaFlag()

setAFlag

public void setAFlag(boolean aFlag)

getLspDBVersion_tlv

public LSPDatabaseVersionTLV getLspDBVersion_tlv()

setLspDBVersion_tlv

public void setLspDBVersion_tlv(LSPDatabaseVersionTLV lspDBVersion_tlv)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class PCEPObject

equals

public boolean equals(Object obj)

Overrides:

equals in class PCEPObject