org.onosproject.net.intent

Class IntentData

java.lang.Object

org.onosproject.net.intent.IntentData

@Beta
public class IntentData
extends Object

A wrapper class that contains an intents, its state, and other metadata for internal use.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IntentData()
	IntentData(IntentData intentData) Copy constructor.
	IntentData(IntentData original, List<Intent> installables) Create a new instance based on the original instance with new installables.
	IntentData(Intent intent, IntentState state, Timestamp version) Creates a new intent data object.
	IntentData(Intent intent, IntentState state, Timestamp version, NodeId origin) Creates a new intent data object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	errorCount() Returns the number of times that this intent has encountered an error during installation or withdrawal.
int	hashCode()
void	incrementErrorCount() Increments the error count for this intent.
List<Intent>	installables() Returns the installables associated with this intent.
Intent	intent() Returns the intent this metadata references.
static boolean	isUpdateAcceptable(IntentData currentData, IntentData newData) Determines whether an intent data update is allowed.
Key	key() Returns the intent key.
NodeId	origin() Returns the origin node that created this intent.
IntentState	request()
void	setErrorCount(int newCount) Sets the error count for this intent.
void	setState(IntentState newState) Updates the state of the intent to the given new state.
IntentState	state() Returns the state of the intent.
String	toString()
Timestamp	version() Returns the version of the intent for this key.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntentData

public IntentData(Intent intent,
                  IntentState state,
                  Timestamp version)

Creates a new intent data object.

Parameters:

intent - intent this metadata references

state - intent state

version - version of the intent for this key

IntentData

public IntentData(Intent intent,
                  IntentState state,
                  Timestamp version,
                  NodeId origin)

Creates a new intent data object.

Parameters:

intent - intent this metadata references

state - intent state

version - version of the intent for this key

origin - ID of the node where the data was originally created

IntentData

public IntentData(IntentData intentData)

Copy constructor.

Parameters:

intentData - intent data to copy

IntentData

public IntentData(IntentData original,
                  List<Intent> installables)

Create a new instance based on the original instance with new installables.

Parameters:

original - original data

installables - new installable intents to set

IntentData

protected IntentData()

Method Detail

intent

public Intent intent()

Returns the intent this metadata references.

Returns:

intent

state

public IntentState state()

Returns the state of the intent.

Returns:

intent state

request

public IntentState request()

key

public Key key()

Returns the intent key.

Returns:

intent key

version

public Timestamp version()

Returns the version of the intent for this key.

Returns:

intent version

origin

public NodeId origin()

Returns the origin node that created this intent.

Returns:

origin node ID

setState

public void setState(IntentState newState)

Updates the state of the intent to the given new state.

Parameters:

newState - new state of the intent

incrementErrorCount

public void incrementErrorCount()

Increments the error count for this intent.

setErrorCount

public void setErrorCount(int newCount)

Sets the error count for this intent.

Parameters:

newCount - new count

errorCount

public int errorCount()

Returns the number of times that this intent has encountered an error during installation or withdrawal.

Returns:

error count

installables

public List<Intent> installables()

Returns the installables associated with this intent.

Returns:

list of installable intents

isUpdateAcceptable

public static boolean isUpdateAcceptable(IntentData currentData,
                                         IntentData newData)

Determines whether an intent data update is allowed. The update must either have a higher version than the current data, or the state transition between two updates of the same version must be sane.

Parameters:

currentData - existing intent data in the store

newData - new intent data update proposal

Returns:

true if we can apply the update, otherwise false

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object