Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.transport
Interface AgentProxyFactory

All Known Implementing Classes:
AgentProxyFactoryImpl

public interface AgentProxyFactory

The interface for classes that create proxies to agent services.


Method Summary
 java.lang.Object createAsyncService(Agent agent, java.lang.Class serviceInterface, boolean guaranteed)
          Create an asynchronous proxy to an agent service where proxy method invocations return immediately.
 java.lang.Object createSyncService(Agent agent, java.lang.Class serviceInterface)
          Create a synchronous proxy to an agent service.
 void destroyService(java.lang.Object proxy)
          When a proxy to an agent service is no longer in use, it should be destroyed to reclaim resources.
 

Method Detail

createSyncService

java.lang.Object createSyncService(Agent agent,
                                   java.lang.Class serviceInterface)
                                   throws java.lang.Exception
Create a synchronous proxy to an agent service.

Parameters:
agent - The agent.
serviceInterface - The service interface.
Returns:
A proxy to the agent service.
Throws:
java.lang.Exception - if an exception occurs acquiring the proxy.

createAsyncService

java.lang.Object createAsyncService(Agent agent,
                                    java.lang.Class serviceInterface,
                                    boolean guaranteed)
                                    throws java.lang.Exception
Create an asynchronous proxy to an agent service where proxy method invocations return immediately. The return type for an asynchronous proxy method call is always null even if the service interface specifies another return type. In addition, exceptions thrown by the agent service are never propagated back to an asynchronous proxy.

Parameters:
agent - The agent.
serviceInterface - The service interface.
guaranteed - true to guarantee message delivery; false if guaranteed delivery is not required.
Returns:
A proxy to the agent service.
Throws:
java.lang.Exception - if an exception occurs acquiring the proxy.

destroyService

void destroyService(java.lang.Object proxy)
When a proxy to an agent service is no longer in use, it should be destroyed to reclaim resources.

Parameters:
proxy - The proxy to an agent service. Null values should be handled gracefully.

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.