COM.TIBCO.hawk.ami

Class AmiAsyncMethod

java.lang.Object

COM.TIBCO.hawk.ami.AmiMethod

COM.TIBCO.hawk.ami.AmiAsyncMethod

All Implemented Interfaces:

AmiAsyncMethodInterface, AmiMethodInterface, java.lang.Comparable

public abstract class AmiAsyncMethod
extends AmiMethod
implements AmiAsyncMethodInterface

The AmiAsyncMethod is the default implementation of the AmiAsyncMethodInterface provided by this AMI Java API implementation as a convenient abstract class of the AmiAsyncMethodInterface.

User of this AmiAsyncMethod class must implement the following abstract methods:

• public abstract AmiParameterList getArguments();
• public abstract AmiParameterList getReturns();
• public abstract AmiParameterList onInvoke(AmiParameterList arguments) throws AmiException;
• public abstract void onStart(Integer context, AmiParameterList args) throws AmiException;
• public abstract void onStop(Integer context, AmiParameterList args) throws AmiException;

Constructor Summary

Constructors

Constructor and Description
AmiAsyncMethod(java.lang.String name, java.lang.String help, AmiMethodType type) Constructor to create an asynchronous AMI method.
AmiAsyncMethod(java.lang.String name, java.lang.String help, AmiMethodType type, int timeout) Constructor to create an asynchronous AMI method.
AmiAsyncMethod(java.lang.String name, java.lang.String help, AmiMethodType type, int timeout, java.lang.String indexName) Constructor to create an asynchronous AMI method.
AmiAsyncMethod(java.lang.String name, java.lang.String help, AmiMethodType type, int timeout, java.lang.String[] indexName) Constructor to create an asynchronous AMI method.
AmiAsyncMethod(java.lang.String name, java.lang.String help, AmiMethodType type, java.lang.String indexName) Constructor to create an asynchronous AMI method.
AmiAsyncMethod(java.lang.String name, java.lang.String help, AmiMethodType type, java.lang.String[] indexName) Constructor to create an asynchronous AMI method.

Method Summary

Modifier and Type	Method and Description
void	onData() Sends data to all the interesting subscribers
void	onStart(AmiMethodContext context, AmiParameterList args) This method is invoked by the AMI Java API when an interest, or subscription, on this asynchronous method arrives.
void	onStop(AmiMethodContext context, AmiParameterList args) This method is invoked by the AMI Java API when the interest on this asynchronous method no longer exists.

Methods inherited from class COM.TIBCO.hawk.ami.AmiMethod

compareTo, equals, getArguments, getHelp, getIndexName, getName, getReturns, getSession, getTimeout, getType, onInvoke, setIndexName, setIndexName, setSession, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface COM.TIBCO.hawk.ami.AmiMethodInterface

getArguments, getHelp, getIndexName, getName, getReturns, getSession, getTimeout, getType, onInvoke, setIndexName, setIndexName, setSession

Constructor Detail

AmiAsyncMethod

public AmiAsyncMethod(java.lang.String name,
                      java.lang.String help,
                      AmiMethodType type)

Constructor to create an asynchronous AMI method.

Parameters:

name - Name of the method

help - Help text of the method

type - Type of the method.

This constructor does not make any effort to perform input argument validation. Validation is performed only at AmiSession.addMethod.

For the method type parameter, use one of the following:

• AmiConstants.METHOD_TYPE_INFO
• AmiConstants.METHOD_TYPE_ACTION
• AmiConstants.METHOD_TYPE_ACTION_INFO

Please refer

COM.TIBCO.hawk.ami.AmiSession#addMethod(AmiMethodInterface), COM.TIBCO.hawk.ami.AmiTraceInterface#AMI_AMI, COM.TIBCO.hawk.ami.AmiTraceInterface#setLevel(int), COM.TIBCO.hawk.ami.AmiConstants#METHOD_TYPE_INFO, COM.TIBCO.hawk.ami.AmiConstants#METHOD_TYPE_ACTION, COM.TIBCO.hawk.ami.AmiConstants#METHOD_TYPE_ACTION_INFO

AmiAsyncMethod

public AmiAsyncMethod(java.lang.String name,
                      java.lang.String help,
                      AmiMethodType type,
                      int timeout)

Constructor to create an asynchronous AMI method.

Parameters:

name - Name of the method

help - Help text of the method

type - Type of the method.

This constructor does not make any effort to perform input argument validation. Validation is performed only at AmiSession.addMethod.

For the method type parameter, use one of the following:

• AmiConstants.METHOD_TYPE_INFO
• AmiConstants.METHOD_TYPE_ACTION
• AmiConstants.METHOD_TYPE_ACTION_INFO

Please refer

COM.TIBCO.hawk.ami.AmiSession#addMethod(AmiMethodInterface), COM.TIBCO.hawk.ami.AmiTraceInterface#AMI_AMI, COM.TIBCO.hawk.ami.AmiTraceInterface#setLevel(int), COM.TIBCO.hawk.ami.AmiConstants#METHOD_TYPE_INFO, COM.TIBCO.hawk.ami.AmiConstants#METHOD_TYPE_ACTION, COM.TIBCO.hawk.ami.AmiConstants#METHOD_TYPE_ACTION_INFO

AmiAsyncMethod

public AmiAsyncMethod(java.lang.String name,
                      java.lang.String help,
                      AmiMethodType type,
                      java.lang.String indexName)

Constructor to create an asynchronous AMI method.

Parameters:

name - Name of the method

help - Help text of the method

type - Type of the method.

indexName - AMI method parameter name that serves as the index.

Please refer

COM.TIBCO.hawk.ami.AmiAsyncMethod#AmiAsyncMethod(String, String, AmiMethodType)

AmiAsyncMethod

public AmiAsyncMethod(java.lang.String name,
                      java.lang.String help,
                      AmiMethodType type,
                      int timeout,
                      java.lang.String indexName)

Constructor to create an asynchronous AMI method.

Parameters:

name - Name of the method

help - Help text of the method

type - Type of the method.

timeout - Timeout of the method.

indexName - AMI method parameter name that serves as the index.

Please refer

COM.TIBCO.hawk.ami.AmiAsyncMethod#AmiAsyncMethod(String, String, AmiMethodType)

AmiAsyncMethod

public AmiAsyncMethod(java.lang.String name,
                      java.lang.String help,
                      AmiMethodType type,
                      java.lang.String[] indexName)

Constructor to create an asynchronous AMI method.

Parameters:

name - Name of the method

help - Help text of the method

type - Type of the method.

indexName - AMI method parameter name that serves as the index.

Please refer

COM.TIBCO.hawk.ami.AmiAsyncMethod#AmiAsyncMethod(String, String, AmiMethodType)

AmiAsyncMethod

public AmiAsyncMethod(java.lang.String name,
                      java.lang.String help,
                      AmiMethodType type,
                      int timeout,
                      java.lang.String[] indexName)

Constructor to create an asynchronous AMI method.

Parameters:

name - Name of the method

help - Help text of the method

type - Type of the method.

timeout - Timeout of the method.

indexName - AMI method parameter name that serves as the index.

Please refer

COM.TIBCO.hawk.ami.AmiAsyncMethod#AmiAsyncMethod(String, String, AmiMethodType)

Method Detail

onStart

public void onStart(AmiMethodContext context,
                    AmiParameterList args)
             throws java.lang.Exception

This method is invoked by the AMI Java API when an interest, or subscription, on this asynchronous method arrives.

Specified by:

onStart in interface AmiAsyncMethodInterface

Parameters:

context - The context associated with the subscription.

args - The start subscription input arguments.

Throws:

java.lang.Exception - is thrown if incorrect data has been passed or the AmiSession object was unable to send the data.

onStop

public void onStop(AmiMethodContext context,
                   AmiParameterList args)
            throws java.lang.Exception

This method is invoked by the AMI Java API when the interest on this asynchronous method no longer exists.

Specified by:

onStop in interface AmiAsyncMethodInterface

Parameters:

context - The context associated with the subscription.

args - The stop subscription input arguments.

Throws:

java.lang.Exception

onData

public void onData()
            throws AmiException

Sends data to all the interesting subscribers

Throws:

AmiException - is thrown if the the publication fails.

When data from an AMI asynchronous method becomes available, this method allows the application to publish the data.

Please refer

COM.TIBCO.hawk.ami.AmiMethodContext