com.hp.of.json

Class DataPathInfoCodec

java.lang.Object

com.hp.util.json.AbstractJsonCodec<DataPathInfo>

com.hp.of.json.DataPathInfoCodec

All Implemented Interfaces:

JsonCodec<DataPathInfo>

public class DataPathInfoCodec
extends AbstractJsonCodec<DataPathInfo>

A JSON codec for DataPathInfo. Requires PortCodec as a pre-requisite.

Author:

Liem Nguyen, Narasimha Reddy Vaka, Simon Hunt

Field Summary

Fields inherited from class com.hp.util.json.AbstractJsonCodec

log, mapper, NO_DECODING_SUP, root, roots

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataPathInfoCodec() Constructs a DataPathInfo Codec.

Method Summary

Methods

Modifier and Type	Method and Description
DataPathInfo	decode(com.fasterxml.jackson.databind.node.ObjectNode node) Decodes the JSON into a typed POJO.
com.fasterxml.jackson.databind.node.ObjectNode	encode(DataPathInfo dpi) Encodes the given POJO to its JSON representation.
protected DataPathId	getDpid(com.fasterxml.jackson.databind.node.ObjectNode node, String key) Reads the property with the given key from the given object node and attempts to interpret it as a datapath identifier.
protected int	getIntOrZero(com.fasterxml.jackson.databind.node.ObjectNode node, String key) Returns the property with the given key from the given object node, interpreted as an int value.
protected IpAddress	getIp(com.fasterxml.jackson.databind.node.ObjectNode node, String key) Returns the property with the given key from the given object node, interpreted as an IP address.
protected long	getLongOrZero(com.fasterxml.jackson.databind.node.ObjectNode node, String key) Returns the property with the given key from the given object node, interpreted as a long value.
protected PortNumber	getPortNumber(com.fasterxml.jackson.databind.node.ObjectNode node, String key) Returns the property with the given key from the given object node, interpreted as a TCP port number.
protected ProtocolVersion	getPv(com.fasterxml.jackson.databind.node.ObjectNode node, String key) Reads the property with the given key from the given object node and attempts to interpret it as an OpenFlow protocol version.
protected String	getText(com.fasterxml.jackson.databind.node.ObjectNode node, String key) Returns the JsonNode.textValue() of a property on the given object node for the given key.
protected long	getTime(com.fasterxml.jackson.databind.node.ObjectNode node, String key) Reads the property with the given key from the given object node and attempts to interpret it as an RFC822 timestamp, returning a value representing the number of milliseconds since January 1, 1970, 00:00:00 GMT.

Methods inherited from class com.hp.util.json.AbstractJsonCodec

arrayNode, decode, decodeList, encode, encodeIterator, encodeIterator, encodeList, encodeList, fromEnums, isMissingContent, longVal, objectNode, read, root, roots, toEnums, write

Methods inherited from class java.lang.Object

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

Constructor Detail

DataPathInfoCodec

protected DataPathInfoCodec()

Constructs a DataPathInfo Codec.

Method Detail

encode

public com.fasterxml.jackson.databind.node.ObjectNode encode(DataPathInfo dpi)

Description copied from interface: JsonCodec

Encodes the given POJO to its JSON representation.

Parameters:

dpi - POJO to encode

Returns:

ObjectNode representation of POJO. This does not have a "top" root

getText

protected String getText(com.fasterxml.jackson.databind.node.ObjectNode node,
             String key)

Returns the JsonNode.textValue() of a property on the given object node for the given key. If the property does not exist, an empty string is returned.

Parameters:

node - the object node

key - the property key

Returns:

the text value of the property (or empty string)

getTime

protected long getTime(com.fasterxml.jackson.databind.node.ObjectNode node,
           String key)

Reads the property with the given key from the given object node and attempts to interpret it as an RFC822 timestamp, returning a value representing the number of milliseconds since January 1, 1970, 00:00:00 GMT.

Parameters:

node - the object node

key - the property key

Returns:

epoch timestamp value

Throws:

IllegalArgumentException - if the value is not correctly formatted

See Also:

Date.getTime()

getPv

protected ProtocolVersion getPv(com.fasterxml.jackson.databind.node.ObjectNode node,
                    String key)

Reads the property with the given key from the given object node and attempts to interpret it as an OpenFlow protocol version.

Parameters:

node - the object node

key - the property key

Returns:

protocol version

Throws:

IllegalArgumentException - if the value is not recognized

getDpid

protected DataPathId getDpid(com.fasterxml.jackson.databind.node.ObjectNode node,
                 String key)

Reads the property with the given key from the given object node and attempts to interpret it as a datapath identifier.

Parameters:

node - the object node

key - the property key

Returns:

datapath ID

Throws:

IllegalArgumentException - if the value is malformed

getLongOrZero

protected long getLongOrZero(com.fasterxml.jackson.databind.node.ObjectNode node,
                 String key)

Returns the property with the given key from the given object node, interpreted as a long value. If no such property exists then zero is returned.

Parameters:

node - the object node

key - the property key

Returns:

the value

getIntOrZero

protected int getIntOrZero(com.fasterxml.jackson.databind.node.ObjectNode node,
               String key)

Returns the property with the given key from the given object node, interpreted as an int value. If no such property exists then zero is returned.

Parameters:

node - the object node

key - the property key

Returns:

the value

getIp

protected IpAddress getIp(com.fasterxml.jackson.databind.node.ObjectNode node,
              String key)

Returns the property with the given key from the given object node, interpreted as an IP address.

Parameters:

node - the object node

key - the property key

Returns:

the IP address

Throws:

IllegalArgumentException - if the value is malformed

getPortNumber

protected PortNumber getPortNumber(com.fasterxml.jackson.databind.node.ObjectNode node,
                       String key)

Returns the property with the given key from the given object node, interpreted as a TCP port number.

Parameters:

node - the object node

key - the property key

Returns:

the port number

Throws:

IllegalArgumentException - if the value is not valid

decode

public DataPathInfo decode(com.fasterxml.jackson.databind.node.ObjectNode node)

Description copied from interface: JsonCodec

Decodes the JSON into a typed POJO.

Parameters:

node - JSON representation of the typed POJO. This does not have a "top" root

Returns:

typed POJO