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

Interface DOMRpcProviderService

All Superinterfaces:

DOMService, DOMService

All Known Implementing Classes:

AbstractDOMRpcProviderService, DOMRpcRouter, ForwardingDOMRpcProviderService

@Deprecated(forRemoval=true)
public interface DOMRpcProviderService
extends DOMService

Deprecated, for removal: This API element is subject to removal in a future version.

Use DOMRpcProviderService instead

A DOMService which allows registration of RPC implementations with a conceptual router. The client counterpart of this service is DOMRpcService.

This interface supports both RFC6020 RPCs and RFC7950 actions (formerly known as 'Routed RPCs'. Invocation for RFC6020 RPCs is always based on an empty context reference. Invocation of actions requires a non-empty context reference and is matched against registered implementations as follows:

• First, attempt to look up the implementation based on exact match. If a match is found the invocation is on that implementation, returning its result.
• Second, attempt to look up the implementation which registered for empty context reference. If a such an implementation exists, invoke that implementation, returning its result
• Throw DOMRpcImplementationNotAvailableException

All implementations are required to perform these steps as specified above.

Method Summary

Modifier and Type	Method	Description
<T extends DOMRpcImplementation> @NonNull DOMRpcImplementationRegistration<T>	registerRpcImplementation(@NonNull T implementation, @NonNull Set<DOMRpcIdentifier> rpcs)	Deprecated, for removal: This API element is subject to removal in a future version. Register an DOMRpcImplementation object with this service.
<T extends DOMRpcImplementation> @NonNull DOMRpcImplementationRegistration<T>	registerRpcImplementation(@NonNull T implementation, @NonNull DOMRpcIdentifier... rpcs)	Deprecated, for removal: This API element is subject to removal in a future version. Register an DOMRpcImplementation object with this service.

Method Detail

registerRpcImplementation

<T extends DOMRpcImplementation> @NonNull DOMRpcImplementationRegistration<T> registerRpcImplementation(@NonNull T implementation,
                                                                                                        @NonNull DOMRpcIdentifier... rpcs)

Deprecated, for removal: This API element is subject to removal in a future version.

Register an DOMRpcImplementation object with this service.

Parameters:

implementation - RPC implementation, must not be null

rpcs - Array of supported RPC identifiers. Must not be null, empty, or contain a null element. Each identifier is added exactly once, no matter how many times it occurs.

Returns:

A DOMRpcImplementationRegistration object, guaranteed to be non-null.

Throws:

NullPointerException - if implementation or types is null

IllegalArgumentException - if types is empty or contains a null element.

registerRpcImplementation

<T extends DOMRpcImplementation> @NonNull DOMRpcImplementationRegistration<T> registerRpcImplementation(@NonNull T implementation,
                                                                                                        @NonNull Set<DOMRpcIdentifier> rpcs)

Deprecated, for removal: This API element is subject to removal in a future version.

Register an DOMRpcImplementation object with this service.

Parameters:

implementation - RPC implementation, must not be null

rpcs - Set of supported RPC identifiers. Must not be null, empty, or contain a null element.

Returns:

A DOMRpcImplementationRegistration object, guaranteed to be non-null.

Throws:

NullPointerException - if implementation or types is null

IllegalArgumentException - if types is empty or contains a null element.