org.onosproject.lisp.msg.protocols

Class DefaultLispInfo

java.lang.Object

org.onosproject.lisp.msg.protocols.AbstractLispMessage

org.onosproject.lisp.msg.protocols.DefaultLispInfo

All Implemented Interfaces:

LispInfo, LispMessage

Direct Known Subclasses:

DefaultLispInfoReply, DefaultLispInfoRequest

public class DefaultLispInfo
extends AbstractLispMessage
implements LispInfo

A class that contains a set of helper methods for LISP info request and reply.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.lisp.msg.protocols.LispMessage

LispMessage.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	authData
protected short	authDataLength
protected LispAfiAddress	eidPrefix
protected boolean	infoReply
protected short	keyId
protected byte	maskLength
protected long	nonce
protected int	ttl

Fields inherited from class org.onosproject.lisp.msg.protocols.AbstractLispMessage

sender

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultLispInfo(boolean infoReply, long nonce, short keyId, short authDataLength, byte[] authData, int ttl, byte maskLength, LispAfiAddress eidPrefix) A private constructor that protects object instantiation from external.

Method Summary

Modifier and Type	Method and Description
LispMessage.Builder	createBuilder() Generates LISP message builder.
static LispInfo	deserialize(io.netty.buffer.ByteBuf byteBuf)
byte[]	getAuthData() Obtains authentication data.
short	getAuthDataLength() Obtains authentication data length.
short	getKeyId() Obtains key identifier.
byte	getMaskLength() Obtains mask length of the EID Record.
long	getNonce() Obtains nonce value.
LispAfiAddress	getPrefix() Obtains EID prefix.
int	getTtl() Obtains TTL value.
LispType	getType() Obtains LISP message type.
boolean	isInfoReply() Obtains has info reply flag value.
static void	serialize(io.netty.buffer.ByteBuf byteBuf, LispInfo message)
void	writeTo(io.netty.buffer.ByteBuf byteBuf) Writes LISP message object into communication channel.

Methods inherited from class org.onosproject.lisp.msg.protocols.AbstractLispMessage

configSender, getSender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.lisp.msg.protocols.LispMessage

configSender, getSender

Field Detail

infoReply

protected final boolean infoReply

nonce

protected final long nonce

keyId

protected final short keyId

authDataLength

protected final short authDataLength

authData

protected final byte[] authData

ttl

protected final int ttl

maskLength

protected final byte maskLength

eidPrefix

protected final LispAfiAddress eidPrefix

Constructor Detail

DefaultLispInfo

protected DefaultLispInfo(boolean infoReply,
                          long nonce,
                          short keyId,
                          short authDataLength,
                          byte[] authData,
                          int ttl,
                          byte maskLength,
                          LispAfiAddress eidPrefix)

A private constructor that protects object instantiation from external.

Parameters:

infoReply - info reply flag

nonce - nonce

keyId - key identifier

authDataLength - authentication data length

authData - authentication data

ttl - Time-To-Live value

maskLength - EID prefix mask length

eidPrefix - EID prefix

Method Detail

getType

public LispType getType()

Description copied from interface: LispMessage

Obtains LISP message type.

Specified by:

getType in interface LispMessage

Overrides:

getType in class AbstractLispMessage

Returns:

LISP message type

writeTo

public void writeTo(io.netty.buffer.ByteBuf byteBuf)
             throws LispWriterException

Description copied from interface: LispMessage

Writes LISP message object into communication channel.

Specified by:

writeTo in interface LispMessage

Overrides:

writeTo in class AbstractLispMessage

Parameters:

byteBuf - byte buffer

Throws:

LispWriterException - if the writing request is failed due to the lisp object cannot be written to the buffer.

createBuilder

public LispMessage.Builder createBuilder()

Description copied from interface: LispMessage

Generates LISP message builder.

Specified by:

createBuilder in interface LispMessage

Overrides:

createBuilder in class AbstractLispMessage

Returns:

builder object

isInfoReply

public boolean isInfoReply()

Description copied from interface: LispInfo

Obtains has info reply flag value.

Specified by:

isInfoReply in interface LispInfo

Returns:

has info reply flag value

getNonce

public long getNonce()

Description copied from interface: LispInfo

Obtains nonce value.

Specified by:

getNonce in interface LispInfo

Returns:

nonce value

getKeyId

public short getKeyId()

Description copied from interface: LispInfo

Obtains key identifier.

Specified by:

getKeyId in interface LispInfo

Returns:

key identifier

getAuthDataLength

public short getAuthDataLength()

Description copied from interface: LispInfo

Obtains authentication data length.

Specified by:

getAuthDataLength in interface LispInfo

Returns:

authentication data length

getAuthData

public byte[] getAuthData()

Description copied from interface: LispInfo

Obtains authentication data.

Specified by:

getAuthData in interface LispInfo

Returns:

authentication data

getTtl

public int getTtl()

Description copied from interface: LispInfo

Obtains TTL value.

Specified by:

getTtl in interface LispInfo

Returns:

record TTL value

getMaskLength

public byte getMaskLength()

Description copied from interface: LispInfo

Obtains mask length of the EID Record.

Specified by:

getMaskLength in interface LispInfo

Returns:

mask length of the EID Record

getPrefix

public LispAfiAddress getPrefix()

Description copied from interface: LispInfo

Obtains EID prefix.

Specified by:

getPrefix in interface LispInfo

Returns:

EID prefix

deserialize

public static LispInfo deserialize(io.netty.buffer.ByteBuf byteBuf)
                            throws LispParseError,
                                   LispReaderException

Throws:

LispParseError

LispReaderException

serialize

public static void serialize(io.netty.buffer.ByteBuf byteBuf,
                             LispInfo message)
                      throws LispWriterException

Throws:

LispWriterException