fulmine.rpc
Interface IRpcRegistry

All Superinterfaces:

IDestroyable, ILifeCycle, IRpcPublishOperations

All Known Implementing Classes:

RpcRegistry

public interface IRpcRegistry
extends ILifeCycle, IRpcPublishOperations

A component that is responsible for managing the current registered RPC definitions for a local context.

Author:

Ramon Servadei

Field Summary

static String	RPC_KEY The prefix for each key in the registry record.
static String	RPC_KEY_COUNT The field name in the registry record that indicates how many RPC definition keys are currently registered
static String	RPC_REGISTRY The name for the registry record

Method Summary

IRpcDefinition	getDefinition(String registryKey) Get the IRpcDefinition registered against the RPC registry key.
IRpcHandler	getHandler(String registryKey) Get the handler for the RPC registry key.
String	getRegistryKey(String rpcName, IField[] args) Get the RPC registry key for the RPC defined by the procedure name and arguments.

Methods inherited from interface fulmine.ILifeCycle

isActive, start

Methods inherited from interface fulmine.IDestroyable

destroy

Methods inherited from interface fulmine.rpc.IRpcPublishOperations

publishProdedure, publishRpcs, unpublishProdedure, unpublishRpcs

Field Detail

RPC_REGISTRY

static final String RPC_REGISTRY

The name for the registry record

See Also:

Constant Field Values

RPC_KEY

static final String RPC_KEY

The prefix for each key in the registry record. Each key value is the 'toString' value of the RPC definition

See Also:

Constant Field Values

RPC_KEY_COUNT

static final String RPC_KEY_COUNT

The field name in the registry record that indicates how many RPC definition keys are currently registered

See Also:

Constant Field Values

Method Detail

getHandler

IRpcHandler getHandler(String registryKey)

Get the handler for the RPC registry key. When a remote context invokes an RPC on the local context, only the registry key and the arguments are sent from the remote context.

Parameters:

registryKey - the registry key of the RPC

Returns:

the handler or null if not found

getDefinition

IRpcDefinition getDefinition(String registryKey)

Get the IRpcDefinition registered against the RPC registry key.

Parameters:

registryKey - the registry key of the RPC

Returns:

the definition or null if not found

getRegistryKey

String getRegistryKey(String rpcName,
                      IField[] args)

Get the RPC registry key for the RPC defined by the procedure name and arguments.

Parameters:

rpcName - the name of the RPC

args - the arguments for the RPC

Returns:

the registry key or null if no match is found