COM.TIBCO.hawk.ami

Class AmiGetVersionMethod

java.lang.Object

COM.TIBCO.hawk.ami.AmiMethod

COM.TIBCO.hawk.ami.AmiGetVersionMethod

All Implemented Interfaces:

AmiMethodInterface, java.lang.Comparable

public class AmiGetVersionMethod
extends AmiMethod
implements AmiMethodInterface

AmiGetVersionMethod implements the AmiMethodInterface to provide a synchronous AMI method that allows the monitoring TIB/Hawk Agent to query for the component versions information.

By default, the current AMI library version information is returned.

If the application uses other components that carry their own version information, then the component version can be added into AmiGetVersionMethod object for return by calling the AmiGetVersionMethod.addComponentVersion(Component) method.

Constructor Summary

Constructors

Constructor and Description
AmiGetVersionMethod() Create a new instance of AmiGetVersionMethod object.

Method Summary

Modifier and Type	Method and Description
void	addComponentVersion(COM.TIBCO.hawk.util.release.Component componentVersion) Add new component version information to be returned from this AMI method.
AmiParameterList	getArguments() Returns the input parameter list for this AMI method.
java.lang.String[]	getIndexName() Returns the index name of this AMI method.
AmiParameterList	getReturns() Returns the output parameter list for this AMI method.
AmiParameterList	onInvoke(AmiParameterList args) The callback method for the AmiGetVersionMethod object.

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

compareTo, equals, getHelp, getName, getSession, getTimeout, getType, 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

getHelp, getName, getSession, getTimeout, getType, setIndexName, setIndexName, setSession

Constructor Detail

AmiGetVersionMethod

public AmiGetVersionMethod()

Create a new instance of AmiGetVersionMethod object.

This is an AMI method object that can be added to an AmiSession for returning component version information.

Method Detail

addComponentVersion

public void addComponentVersion(COM.TIBCO.hawk.util.release.Component componentVersion)

Add new component version information to be returned from this AMI method.

Parameters:

componentVersion - A component version object that implements the Component interface.

getIndexName

public java.lang.String[] getIndexName()

Returns the index name of this AMI method.

Specified by:

getIndexName in interface AmiMethodInterface

Overrides:

getIndexName in class AmiMethod

Returns:

String - Parameter index name.

The index name for this method is the Name parameter.

getArguments

public AmiParameterList getArguments()

Returns the input parameter list for this AMI method.

Specified by:

getArguments in interface AmiMethodInterface

Specified by:

getArguments in class AmiMethod

Returns:

AmiParameterList - input parameter list.

This method does not accept any input arguments, therefore returns null.

getReturns

public AmiParameterList getReturns()

Returns the output parameter list for this AMI method.

Specified by:

getReturns in interface AmiMethodInterface

Specified by:

getReturns in class AmiMethod

Returns:

AmiParameterList - output parameter list.

This method return three AmiParameter objects:

• Name - Name of the component.
• Version - Version of the component.
• Date - Date of the component build.

onInvoke

public AmiParameterList onInvoke(AmiParameterList args)
                          throws AmiException

The callback method for the AmiGetVersionMethod object.

Specified by:

onInvoke in interface AmiMethodInterface

Specified by:

onInvoke in class AmiMethod

Parameters:

args - Input arguments.

Returns:

AmiParameterList - List of component version information.

Note that this method may return multiple rows of component version information. One row per component.

Throws:

AmiException