org.opendaylight.mdsal.dom.api

Interface DOMRpcProviderService

All Superinterfaces:

DOMService

All Known Implementing Classes:

AbstractDOMRpcProviderService, DOMRpcRouter, ForwardingDOMRpcProviderService

public interface DOMRpcProviderService
extends DOMService

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

Method Summary

Modifier and Type	Method and Description
<T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T>	registerRpcImplementation(T implementation, DOMRpcIdentifier... rpcs) Register an DOMRpcImplementation object with this service.
<T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T>	registerRpcImplementation(T implementation, Set<DOMRpcIdentifier> rpcs) Register an DOMRpcImplementation object with this service.

Method Detail

registerRpcImplementation

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

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

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

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.