org.opendaylight.controller.md.sal.dom.api

Class DOMRpcIdentifier

java.lang.Object

org.opendaylight.controller.md.sal.dom.api.DOMRpcIdentifier

public abstract class DOMRpcIdentifier
extends Object

Identifier of a RPC context. This is an extension of the YANG RPC, which always has global context. It allows an RPC to have a instance identifier attached, so that there can be multiple implementations bound to different contexts concurrently.

Method Summary

Methods

Modifier and Type	Method and Description
static DOMRpcIdentifier	create(SchemaPath type) Create a global RPC identifier.
static DOMRpcIdentifier	create(SchemaPath type, YangInstanceIdentifier contextReference) Create an RPC identifier with a particular context reference.
boolean	equals(Object obj)
abstract YangInstanceIdentifier	getContextReference() Return the RPC context reference.
SchemaPath	getType() Return the RPC type.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

@Nonnull
public static DOMRpcIdentifier create(@Nonnull
                              SchemaPath type)

Create a global RPC identifier.

Parameters:

type - RPC type, SchemaPath of its definition, may not be null

Returns:

A global RPC identifier, guaranteed to be non-null.

create

@Nonnull
public static DOMRpcIdentifier create(@Nonnull
                              SchemaPath type,
                              @Nullable
                              YangInstanceIdentifier contextReference)

Create an RPC identifier with a particular context reference.

Parameters:

type - RPC type, SchemaPath of its definition, may not be null

contextReference - Context reference, null means a global RPC identifier.

Returns:

A global RPC identifier, guaranteed to be non-null.

getType

@Nonnull
public final SchemaPath getType()

Return the RPC type.

Returns:

RPC type.

getContextReference

@Nonnull
public abstract YangInstanceIdentifier getContextReference()

Return the RPC context reference. Null value indicates global context.

Returns:

RPC context reference.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object