es.tid.pce.pcep.objects

Class ExcludeRouteObject

java.lang.Object

es.tid.pce.pcep.objects.PCEPObject

es.tid.pce.pcep.objects.ExcludeRouteObject

All Implemented Interfaces:

PCEPElement

public class ExcludeRouteObject
extends PCEPObject

Exclude Route Object from RFC 5521 2.1. Exclude Route Object (XRO) 2.1.1. Definition The XRO is OPTIONAL and MAY be carried within Path Computation Request (PCReq) and Path Computation Reply (PCRep) messages. When present in a PCReq message, the XRO provides a list of network resources that the PCE is requested to exclude from the path that it computes. Flags associated with each list member instruct the PCE as to whether the network resources must be excluded from the computed path, or whether the PCE should make best efforts to exclude the resources from the computed path. The XRO MAY be used on a PCRep message that carries the NO-PATH object (i.e., one that reports a path computation failure) to indicate the set of elements of the original XRO that prevented the PCE from finding a path. The XRO MAY also be used on a PCRep message for a successful path computation when the PCE wishes to provide a set of exclusions to be signaled during LSP setup using the extensions to Resource Reservation Protocol (RSVP)-TE [RFC4874]. The XRO Object-Class is 17. The XRO Object-Type is 1. 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 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Reserved | Flags |F| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | // (Subobjects) // | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 1: XRO Body Format Reserved: 16 bits - MUST be set to zero on transmission and SHOULD be ignored on receipt. Flags: 16 bits - The following flags are currently defined: F (Fail - 1 bit): when set, the requesting PCC requires the computation of a new path for an existing TE LSP that has failed. If the F bit is set, the path of the existing TE LSP MUST be provided in the PCReq message by means of a Record Route Object (RRO) defined in [RFC5440]. This allows the path computation to take into account the previous path and reserved resources to avoid double bandwidth booking should the Traffic Engineering Database (TED) have not yet been updated or the corresponding resources not be yet been released. This will usually be used in conjunction with the exclusion from the path computation of the failed resource that caused the LSP to fail. Subobjects: The XRO is made up of one or more subobject(s). An XRO with no subobjects MUST NOT be sent and SHOULD be ignored on receipt. In the following subobject definitions, a set of fields have consistent meaning as follows: X The X-bit indicates whether the exclusion is mandatory or desired. 0 indicates that the resource specified MUST be excluded from the path computed by the PCE. 1 indicates that the resource specified SHOULD be excluded from the path computed by the PCE, but MAY be included subject to PCE policy and the absence of a viable path that meets the other constraints and excludes the resource. Type The type of the subobject. The following subobject types are defined. Type Subobject -------------+------------------------------- 1 IPv4 prefix 2 IPv6 prefix 4 Unnumbered Interface ID 32 Autonomous system number 34 SRLG Length The length of the subobject including the Type and Length fields. Prefix Length Where present, this field can be used to indicate a set of addresses matching a prefix. If the subobject indicates a single address, the prefix length MUST be set to the full length of the address. Attribute The Attribute field indicates how the exclusion subobject is to be interpreted. 0 Interface The subobject is to be interpreted as an interface or set of interfaces. All interfaces identified by the subobject are to be excluded from the computed path according to the setting of the X-bit. This value is valid only for subobject types 1, 2, and 3. 1 Node The subobject is to be interpreted as a node or set of nodes. All nodes identified by the subobject are to be excluded from the computed path according to the setting of the X-bit. This value is valid only for subobject types 1, 2, 3, and 4. 2 SRLG The subobject identifies an SRLG explicitly or indicates all of the SRLGs associated with the resource or resources identified by the subobject. Resources that share any SRLG with those identified are to be excluded from the computed path according to the setting of the X-bit. This value is valid for all subobjects. Reserved Reserved fields within subobjects MUST be transmitted as zero and SHOULD be ignored on receipt.

Author:

ogondio

Field Summary

Fields

Modifier and Type	Field and Description
LinkedList<XROSubobject>	XROSubobjectList List of ERO subobjetcts

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
ExcludeRouteObject()
ExcludeRouteObject(byte[] bytes, int offset) Constructs a new ERO (Explicit Route Object) from a sequence of bytes

Method Summary

Modifier and Type	Method and Description
void	addEROSubobjectList(LinkedList<XROSubobject> erosovec)
void	addXROSubobject(XROSubobject eroso)
void	decode() Decode the object.
void	encode() Encode the object.
boolean	equals(Object obj)
LinkedList<XROSubobject>	getXROSubobjectList()
int	hashCode()
boolean	isfail()
void	setFail(boolean fail)
void	setXROSubobjectList(LinkedList<XROSubobject> eROSubobjectList)
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

XROSubobjectList

public LinkedList<XROSubobject> XROSubobjectList

List of ERO subobjetcts

Constructor Detail

ExcludeRouteObject

public ExcludeRouteObject()

ExcludeRouteObject

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

Constructs a new ERO (Explicit Route Object) from a sequence of bytes

Parameters:

bytes - Sequence of bytes where the object is present

offset - Position at which the object starts

Throws:

MalformedPCEPObjectException - Thrown if the decoded object is not well formed

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

addXROSubobject

public void addXROSubobject(XROSubobject eroso)

addEROSubobjectList

public void addEROSubobjectList(LinkedList<XROSubobject> erosovec)

getXROSubobjectList

public LinkedList<XROSubobject> getXROSubobjectList()

setXROSubobjectList

public void setXROSubobjectList(LinkedList<XROSubobject> eROSubobjectList)

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

isfail

public boolean isfail()

setFail

public void setFail(boolean fail)