public class AmiGetVersionMethod extends AmiMethod implements AmiMethodInterface
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 and Description |
---|
AmiGetVersionMethod()
Create a new instance of AmiGetVersionMethod object.
|
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.
|
compareTo, equals, getHelp, getName, getSession, getTimeout, getType, setIndexName, setIndexName, setSession, toString
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
getHelp, getName, getSession, getTimeout, getType, setIndexName, setIndexName, setSession
public AmiGetVersionMethod()
This is an AMI method object that can be added to an AmiSession for returning component version information.
public void addComponentVersion(COM.TIBCO.hawk.util.release.Component componentVersion)
componentVersion
- A component version object that implements the
Component
interface.public java.lang.String[] getIndexName()
getIndexName
in interface AmiMethodInterface
getIndexName
in class AmiMethod
The index name for this method is the Name
parameter.
public AmiParameterList getArguments()
getArguments
in interface AmiMethodInterface
getArguments
in class AmiMethod
This method does not accept any input arguments, therefore returns null.
public AmiParameterList getReturns()
getReturns
in interface AmiMethodInterface
getReturns
in class AmiMethod
This method return three AmiParameter objects:
Name
- Name of the component.
Version
- Version of the component.
Date
- Date of the component build.
public AmiParameterList onInvoke(AmiParameterList args) throws AmiException
onInvoke
in interface AmiMethodInterface
onInvoke
in class AmiMethod
args
- Input arguments.Note that this method may return multiple rows of component version information. One row per component.
AmiException
Copyright © 2000-2019 TIBCO Inc. All Rights Reserved.