TPTP 4.1.0 Platform Project
Public API Specification

org.eclipse.hyades.execution.local.util
Interface IAgentControllerDescriptor

All Known Implementing Classes:
AgentControllerDescriptor

public interface IAgentControllerDescriptor

The agent controller descriptor interface, abstracts key agent controller metadata such as version


Method Summary
 java.lang.String getProperty(java.lang.String name, java.lang.String type)
          Retrieves a general property from the agent controller, given the name and type
 java.lang.String getVersion()
          Retrieves the version of the agent controller identified by the node instance argument
 boolean isVersionAtLeast(java.lang.String lowerLimitInclusive)
          Determines if the agent controller version is at least the specified lower limit inclusive value
 boolean isVersionAtMost(java.lang.String upperLimitInclusive)
          Determines if version is less than or equal to the upper limit inclusive value
 boolean isVersionEqual(java.lang.String version)
          Indicates if the version of the agent controller is exactly equal to the version passed in as an argument
 boolean isVersionWithin(java.lang.String lowerLimitInclusive, java.lang.String upperLimitInclusive)
          Indicates if the version of the agent controller is at least the lower limit version and at most the upper limit version inclusive
 

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String name,
                                    java.lang.String type)
Retrieves a general property from the agent controller, given the name and type

Parameters:
name - the name of the property such as 'version'
type - the type of the value
Returns:
the property value returned as a string

getVersion

public java.lang.String getVersion()
Retrieves the version of the agent controller identified by the node instance argument

Returns:
the version of the agent controller

isVersionAtLeast

public boolean isVersionAtLeast(java.lang.String lowerLimitInclusive)
Determines if the agent controller version is at least the specified lower limit inclusive value

Parameters:
lowerLimitInclusive - the version is must at least be
Returns:
true if the version is at least the given version

isVersionAtMost

public boolean isVersionAtMost(java.lang.String upperLimitInclusive)
Determines if version is less than or equal to the upper limit inclusive value

Parameters:
upperLimitInclusive - the maximum version
Returns:
true if the version is at most the version specified

isVersionEqual

public boolean isVersionEqual(java.lang.String version)
Indicates if the version of the agent controller is exactly equal to the version passed in as an argument

Parameters:
version - the version that the agent controller must match
Returns:
true if the version matches precisely

isVersionWithin

public boolean isVersionWithin(java.lang.String lowerLimitInclusive,
                               java.lang.String upperLimitInclusive)
Indicates if the version of the agent controller is at least the lower limit version and at most the upper limit version inclusive

Parameters:
lowerLimitInclusive - the minimum version
upperLimitInclusive - the maximum version

TPTP 4.1.0 Platform Project
Public API Specification