org.opendaylight.controller.md.sal.common.api.clustering

Class Entity

java.lang.Object

org.opendaylight.controller.md.sal.common.api.clustering.Entity

All Implemented Interfaces:

Serializable

Deprecated.

Use org.opendaylight.mdsal.binding.api.clustering.Entity or org.opendaylight.mdsal.eos.dom.api.DOMEntity instead

@Deprecated
public final class Entity
extends Object
implements Serializable

A clustered Entity is something which is shared by multiple applications across a cluster. An Entity has a type and an identifier.

The type describes the type of the Entity where examples of a type maybe "openflow" or "netconf" etc. An Entity type could be tied to how exactly an application shares and "owns" an entity. For example we may want an application which deals with the openflow entity to be assigned ownership of that entity based on a first come first served basis. On the other hand for netconf entity types we may want applications to gain ownership based on a load balancing approach. While this mechanism of assigning a ownership acquisition strategy is not finalized the intention is that the entity type will play a role in determining the strategy and thus should be put in place.

The identifier is a YangInstanceIdentifier. The reason for the choice of YangInstanceIdentifier is because it can easily be used to represent a data node. For example an inventory node represents a shared entity and it is best referenced by the YangInstanceIdentifier if the inventory node is stored in the data store.

Note that an entity identifier must conform to a valid yang schema. If there is no existing yang schema to represent an entity, the general-entity yang model can be used.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Entity(String type, String entityName) Deprecated. Construct an Entity with an with a name.
Entity(String type, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier id) Deprecated. Construct an Entity with a YangInstanceIdentifier.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Deprecated.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	getId() Deprecated.
String	getType() Deprecated.
int	hashCode() Deprecated.
String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Entity

public Entity(@Nonnull
              String type,
              @Nonnull
              org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier id)

Deprecated.

Construct an Entity with a YangInstanceIdentifier.

Parameters:

type - the type of the entity

id - the identifier of the entity

Entity

public Entity(@Nonnull
              String type,
              @Nonnull
              String entityName)

Deprecated.

Construct an Entity with an with a name. The general-entity schema is used to construct the YangInstanceIdentifier.

Parameters:

type - the type of the entity

entityName - the name of the entity used to construct a general-entity YangInstanceIdentifier

Method Detail

getId

@Nonnull
public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier getId()

Deprecated.

Returns:

id of entity

getType

@Nonnull
public String getType()

Deprecated.

Returns:

type of entity

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

toString

public String toString()

Deprecated.

Overrides:

toString in class Object