PCEPObject (Netphony Network Protocols 1.2.2 API)

java.lang.Object
- es.tid.pce.pcep.objects.PCEPObject

All Implemented Interfaces:

PCEPElement

Direct Known Subclasses:

AdvanceReservationObject, Bandwidth, Close, EndPoints, ExcludeRouteObject, ExplicitRouteObject, IncludeRouteObject, InterLayer, LabelSet, LoadBalancing, LSP, LSPA, Metric, Monitoring, NetQuotationIPv4, NetQuotationNSAP, NoPath, Notification, ObjectiveFunction, OPEN, PccReqId, PceId, PCEPErrorObject, ProcTime, ReportedRouteObject, ReqAdapCap, RequestParameters, Reservation, ReservationConf, ServerIndication, SRP, SuggestedLabel, Svec, SwitchLayer, UnknownObject, WavelengthAssignementObject
```
public abstract class PCEPObject
extends Object
implements PCEPElement
```
Base class for PCEPObject. Implements PCEP Object Header as defined in RFC 5440. PCEP Object must extend this class. This class is abstract, so it cannot be instantiated 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 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Object-Class | OT |Res|P|I| Object Length (bytes) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | // (Object body) // | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Object-Class (8 bits): identifies the PCEP object class. OT (Object-Type - 4 bits): identifies the PCEP object type. The Object-Class and Object-Type fields are managed by IANA. The Object-Class and Object-Type fields uniquely identify each PCEP object. Res flags (2 bits): Reserved field. This field MUST be set to zero on transmission and MUST be ignored on receipt. P flag (Processing-Rule - 1-bit): the P flag allows a PCC to specify in a PCReq message sent to a PCE whether the object must be taken into account by the PCE during path computation or is just optional. When the P flag is set, the object MUST be taken into account by the PCE. Conversely, when the P flag is cleared, the object is optional and the PCE is free to ignore it. I flag (Ignore - 1 bit): the I flag is used by a PCE in a PCRep message to indicate to a PCC whether or not an optional object was processed. The PCE MAY include the ignored optional object in its reply and set the I flag to indicate that the optional object was ignored during path computation. When the I flag is cleared, the PCE indicates that the optional object was processed during the path computation. The setting of the I flag for optional objects is purely indicative and optional. The I flag has no meaning in a PCRep message when the P flag has been set in the corresponding PCReq message. If the PCE does not understand an object with the P flag set or understands the object but decides to ignore the object, the entire PCEP message MUST be rejected and the PCE MUST send a PCErr message with Error-Type="Unknown Object" or "Not supported Object" along with the corresponding RP object. Note that if a PCReq includes multiple requests, only requests for which an object with the P flag set is unknown/unrecognized MUST be rejected. Object Length (16 bits): Specifies the total object length including the header, in bytes. The Object Length field MUST always be a multiple of 4, and at least 4. The maximum object content length is 65528 bytes.

Author:

Oscar Gonzalez de Dios

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`Ibit` I flag (Ignore - 1 bit): the I flag is used by a PCE in a PCRep message to indicate to a PCC whether or not an optional object was processed.
`protected static org.slf4j.Logger`	`log`
`protected byte[]`	`object_bytes` Bytes of the object
`protected int`	`ObjectClass` Object-Class (8 bits): identifies the PCEP object class.
`protected int`	`ObjectLength` Object Length (16 bits): Specifies the total object length including the header, in bytes.
`protected int`	`OT` OT (Object-Type - 4 bits): identifies the PCEP object type.
`protected boolean`	`Pbit` P flag (Processing-Rule - 1-bit): the P flag allows a PCC to specify in a PCReq message sent to a PCE whether the object must be taken into account by the PCE during path computation or is just optional.
`protected int`	`Res` Res flags (2 bits): Reserved field.

Constructor Summary

Constructors
Constructor and Description

PCEPObject()
Constructs a PCEPObject

PCEPObject(byte[] bytes, int offset)
Construct a new PCEP Object from a sequence of bytes.

Constructors
Constructor and Description
`PCEPObject()` Constructs a PCEPObject
`PCEPObject(byte[] bytes, int offset)` Construct a new PCEP Object from a sequence of bytes.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`decode()` Decode the object.
`void`	`decode(byte[] bytes, int offset)` Decodes an object from a sequence of bytes starting in offset.
`void`	`decodeHeader()` Decodes the PCEP Object Header
`void`	`encode_header()` Encodes the header of the PCEP object (4 bytes)
`abstract void`	`encode()` Encode the object.
`boolean`	`equals(Object obj)`
`byte[]`	`getBytes()` Get the bytes of the message.
`int`	`getLength()` Get the object Length.
`byte[]`	`getObject_bytes()`
`int`	`getObjectClass()` Returns the Object-Class (8 bits) which identifies the PCEP object class.
`static int`	`getObjectClass(byte[] bytes, int offset)` Static method to obtain the object class of an object encoded in a byte array
`static int`	`getObjectLength(byte[] bytes, int offset)` Static method to get the length of an object in a sequence of bytes
`static int`	`getObjectType(byte[] bytes, int offset)` Static method to get the Object type of an object encoded in a byte array
`int`	`getOT()`
`int`	`getRes()`
`int`	`hashCode()`
`boolean`	`isIbit()`
`boolean`	`isPbit()`
`void`	`setIbit(boolean ibit)`
`void`	`setObject_bytes(byte[] object_bytes)`
`void`	`setObjectClass(int objectClass)` Sets the Object-Class (8 bits) which identifies the PCEP object class.
`protected void`	`setObjectLength(int objectLength)`
`void`	`setOT(int oT)`
`void`	`setPbit(boolean pbit)`
`void`	`setRes(int res)`
`static boolean`	`supportedObject(int oc)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ObjectClass
```
protected int ObjectClass
```
    Object-Class (8 bits): identifies the PCEP object class.
  - OT
```
protected int OT
```
    OT (Object-Type - 4 bits): identifies the PCEP object type.
  - Res
```
protected int Res
```
    Res flags (2 bits): Reserved field. This field MUST be set to zero on transmission and MUST be ignored on receipt.
  - Pbit
```
protected boolean Pbit
```
    P flag (Processing-Rule - 1-bit): the P flag allows a PCC to specify in a PCReq message sent to a PCE whether the object must be taken into account by the PCE during path computation or is just optional. When the P flag is set, the object MUST be taken into account by the PCE. Conversely, when the P flag is cleared, the object is optional and the PCE is free to ignore it.
  - Ibit
```
protected boolean Ibit
```
    I flag (Ignore - 1 bit): the I flag is used by a PCE in a PCRep message to indicate to a PCC whether or not an optional object was processed. The PCE MAY include the ignored optional object in its reply and set the I flag to indicate that the optional object was ignored during path computation. When the I flag is cleared, the PCE indicates that the optional object was processed during the path computation. The setting of the I flag for optional objects is purely indicative and optional. The I flag has no meaning in a PCRep message when the P flag has been set in the corresponding PCReq message.
  - ObjectLength
```
protected int ObjectLength
```
    Object Length (16 bits): Specifies the total object length including the header, in bytes. The Object Length field MUST always be a multiple of 4, and at least 4. The maximum object content length is 65528 bytes.
  - object_bytes
```
protected byte[] object_bytes
```
    Bytes of the object
  - log
```
protected static final org.slf4j.Logger log
```
- Constructor Detail
  - PCEPObject
```
public PCEPObject()
```
    Constructs a PCEPObject
  - PCEPObject
```
public PCEPObject(byte[] bytes,
                  int offset)
           throws MalformedPCEPObjectException
```
    Construct a new PCEP Object from a sequence of bytes.
    
    Parameters:
    
    bytes -
    
    offset -
    
    Throws:
    
    MalformedPCEPObjectException
- Method Detail
  - encode
```
public abstract void encode()
```
    Encode the object. It is specific to the PCEP Object. Must be implemented in each object!!!!!
    
    Specified by:
    
    encode in interface PCEPElement
  - decode
```
public abstract void decode()
                     throws MalformedPCEPObjectException
```
    Decode the object. It is specific to the PCEP Object. Must be implemented in each object!!!!
    
    Throws:
    
    MalformedPCEPObjectException
  - decode
```
public void decode(byte[] bytes,
                   int offset)
            throws MalformedPCEPObjectException
```
    Decodes an object from a sequence of bytes starting in offset. It is the same as calling the constructor with the sequence of bytes.
    
    Parameters:
    
    bytes -
    
    offset -
    
    Throws:
    
    MalformedPCEPObjectException
  - encode_header
```
public void encode_header()
```
    Encodes the header of the PCEP object (4 bytes)
  - decodeHeader
```
public void decodeHeader()
```
    Decodes the PCEP Object Header
  - getObjectClass
```
public int getObjectClass()
```
    Returns the Object-Class (8 bits) which identifies the PCEP object class.
  - setObjectClass
```
public void setObjectClass(int objectClass)
```
    Sets the Object-Class (8 bits) which identifies the PCEP object class.
    
    Parameters:
    
    objectClass - Object-Class
  - getOT
```
public int getOT()
```
    Returns:
    
    OT
  - setOT
```
public void setOT(int oT)
```
    Parameters:
    
    oT -
  - getRes
```
public int getRes()
```
    Returns:
    
    Res
  - setRes
```
public void setRes(int res)
```
    Parameters:
    
    res -
  - isPbit
```
public boolean isPbit()
```
  - setPbit
```
public void setPbit(boolean pbit)
```
  - isIbit
```
public boolean isIbit()
```
  - setIbit
```
public void setIbit(boolean ibit)
```
  - getLength
```
public int getLength()
```
    Get the object Length. Generic for all objects
    
    Specified by:
    
    getLength in interface PCEPElement
    
    Returns:
    
    Object Length
  - setObjectLength
```
protected void setObjectLength(int objectLength)
```
  - getObject_bytes
```
public byte[] getObject_bytes()
```
  - setObject_bytes
```
public void setObject_bytes(byte[] object_bytes)
```
  - getBytes
```
public byte[] getBytes()
```
    Get the bytes of the message. Remember to call encode first!!!
    
    Specified by:
    
    getBytes in interface PCEPElement
    
    Returns:
    
    Bytes of the message
  - getObjectClass
```
public static int getObjectClass(byte[] bytes,
                                 int offset)
```
    Static method to obtain the object class of an object encoded in a byte array
    
    Parameters:
    
    bytes - Byte array where the object appears
    
    offset - Byte where the the object starts in the byte array
    
    Returns:
    
    ObjectClass
  - getObjectType
```
public static int getObjectType(byte[] bytes,
                                int offset)
```
    Static method to get the Object type of an object encoded in a byte array
    
    Parameters:
    
    bytes - Byte array where the object appears
    
    offset - Byte where the the object starts in the byte array
    
    Returns:
    
    ObjectType
  - getObjectLength
```
public static int getObjectLength(byte[] bytes,
                                  int offset)
```
    Static method to get the length of an object in a sequence of bytes
    
    Parameters:
    
    bytes - Byte array where the object appears
    
    offset - Byte where the the object starts in the byte array
    
    Returns:
    
    ObjectLegth
  - supportedObject
```
public static boolean supportedObject(int oc)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class PCEPObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ObjectClass

OT

Res

Pbit

Ibit

ObjectLength

object_bytes

log

Constructor Detail

PCEPObject

PCEPObject

Method Detail

encode

decode

decode

encode_header

decodeHeader

getObjectClass

setObjectClass

getOT

setOT

getRes

setRes

isPbit

setPbit

isIbit

setIbit

getLength

setObjectLength

getObject_bytes

setObject_bytes

getBytes

getObjectClass

getObjectType

getObjectLength

supportedObject

hashCode

equals