com.inprise.vbroker.ObjLocation
Interface AgentOperations

All Known Subinterfaces:

Agent

public interface AgentOperations

The Location Service Agent is a collection of methods that enable you to discover objects on a network of Smart Agents. Methods for the Agent interface can be divided into two groups: those that query a Smart Agent for data describing instances, and those that register and unregisters triggers. You can query based on the interface's repository ID, or based on a combination of the interface's repository ID and the instance name. Results of a query can be returned as either object references or more complete instance descriptions. Triggers are a notification mechanism by which clients of the Location Service can be notified of changes to the availability of instances.

Method Summary

java.lang.String[]	all_agent_locations() Returns a sequence of hostnames on which OSAgents reside.
Desc[][]	all_available_descs() Returns full description information for all objects which are currently active (registered with some Smart Agent), organized into sequences by repository id.
Object[][]	all_available() Returns a sequence of all available Objects for each type, organized into sequences by repository id.
Desc[]	all_instances_descs(java.lang.String repository_id) Returns full description information for instances of the interface which implement the given repository id.
Object[]	all_instances(java.lang.String repository_id) Returns a sequence of CORBA::Objects with the given repository id.
Desc[]	all_replica_descs(java.lang.String repository_id, java.lang.String instance_name) Returns full description information for all like-named instances of the interface which implement the given repository id and have the given instance name.
Object[]	all_replica(java.lang.String repository_id, java.lang.String instance_name) Returns a set of CORBA::Objects with matching repository id and instance name.
java.lang.String[]	all_repository_ids() Returns all the interfaces known to any OSAgent.
void	reg_trigger(TriggerDesc desc, TriggerHandler handler) Registers a trigger handler.
void	unreg_trigger(TriggerDesc desc, TriggerHandler handler) Unregisters a trigger handler.
boolean	willRefreshOADs() When set to false, the Agent will not refresh its set of Activation Daemons on every invocation.
void	willRefreshOADs(boolean arg0) When set to false, the Agent will not refresh its set of Activation Daemons on every invocation.

Method Detail

willRefreshOADs

boolean willRefreshOADs()

When set to false, the Agent will not refresh its set of Activation Daemons on every invocation. Otherwise, the set is updated on every Agent query operation to ensure that Activable providers are properly reported. Default is true.

willRefreshOADs

void willRefreshOADs(boolean arg0)

When set to false, the Agent will not refresh its set of Activation Daemons on every invocation. Otherwise, the set is updated on every Agent query operation to ensure that Activable providers are properly reported. Default is true.

unreg_trigger

void unreg_trigger(TriggerDesc desc,
                   TriggerHandler handler)
                   throws Fail

Unregisters a trigger handler.

Parameters:

desc - Description of the instance. The instance description can contain combinations of the following instance information: repository ID, instance name, and host name. The more instance information provided, the more particular your specification of the instance.

handler - The TriggerHandler object you want to register.

Throws:

Fail - There is no such trigger.

reg_trigger

void reg_trigger(TriggerDesc desc,
                 TriggerHandler handler)
                 throws Fail

Registers a trigger handler.

Parameters:

desc - Description of the instance. The instance description can contain combinations of the following instance information: repository ID, instance name, and host name. The more instance information provided, the more particular your specification of the instance.

handler - The TriggerHandler object you want to register.

Throws:

Fail - There is no such trigger.

all_repository_ids

java.lang.String[] all_repository_ids()
                                      throws Fail

Returns all the interfaces known to any OSAgent.

Returns:

a sequence of repository ids which are registered with any OSAgent.

Throws:

Fail - Either there is no agent available or there is unsuccessful communication with the OSAgent.

all_replica_descs

Desc[] all_replica_descs(java.lang.String repository_id,
                         java.lang.String instance_name)
                         throws Fail

Returns full description information for all like-named instances of the interface which implement the given repository id and have the given instance name.

Parameters:

repository_id - The repository id of the desired object, e.g. IDL:omg.org/Object:1.0

instance_name - The instance name of the desired object, e.g. the oid used when it was activated.

Returns:

An array with full descriptions of each object.

Throws:

Fail - A communication problem with the agent occurred or the repository or instance id is invalid

all_replica

Object[] all_replica(java.lang.String repository_id,
                     java.lang.String instance_name)
                     throws Fail

Returns a set of CORBA::Objects with matching repository id and instance name.

Parameters:

repository_id - The repository id of the desired object, e.g. IDL:omg.org/Object:1.0

instance_name - The instance name of the desired object, e.g. the oid used when it was activated.

Returns:

a set of CORBA::Objects with matching id.

Throws:

Fail - A communication problem with the agent occurred or the repository or instance id is invalid.

all_instances_descs

Desc[] all_instances_descs(java.lang.String repository_id)
                           throws Fail

Returns full description information for instances of the interface which implement the given repository id.

Parameters:

repository_id - The repository id of the desired object, e.g. IDL:omg.org/Object:1.0

Returns:

An array of object descriptions.

Throws:

Fail - A communication problem with the agent occurred or the repository id is invalid.

all_instances

Object[] all_instances(java.lang.String repository_id)
                       throws Fail

Returns a sequence of CORBA::Objects with the given repository id. Wildcards cannot be used.

Parameters:

repository_id - The repository id of the desired object, e.g. IDL:omg.org/Object:1.0

Returns:

a set of CORBA::Objects with matching id.

Throws:

Fail - A communication problem with the agent occurred or the repository id is invalid.

all_available_descs

Desc[][] all_available_descs()
                             throws Fail

Returns full description information for all objects which are currently active (registered with some Smart Agent), organized into sequences by repository id.

Returns:

full description information for all objects which are currently active (registered with some Smart Agent), organized into sequences by repository id.

Throws:

Fail - Either there is no agent available or there is unsuccessful communication with the OSAgent.

all_available

Object[][] all_available()
                         throws Fail

Returns a sequence of all available Objects for each type, organized into sequences by repository id.

Returns:

a sequence of all available Objects for each type.

Throws:

Fail - Either there is no agent available or there is unsuccessful communication with the OSAgent.

all_agent_locations

java.lang.String[] all_agent_locations()
                                       throws Fail

Returns a sequence of hostnames on which OSAgents reside.

Returns:

Returns a sequence of hostnames (IP address string sequence) on which OSAgents reside.

Throws:

Fail - Either there is no agent available or there is unsuccessful communication with the OSAgent.