com.apama.net.beans.interfaces
Interface GenericComponentManagementOperationsInterface

All Superinterfaces:

BaseClientInterface, PingClientInterface, PingOperationsInterface

All Known Implementing Classes:

GenericComponentManagementBean

public interface GenericComponentManagementOperationsInterface
extends PingClientInterface

Field Summary

Fields inherited from interface com.apama.net.beans.interfaces.BaseClientInterface

COPYRIGHT, DEFAULT_CONNECTION_POLLING_INTERVAL, DEFAULT_HOST, DEFAULT_PORT, DEFAULT_PROCESS_NAME, PRODUCTNAME, PROPERTY_BEAN_CONNECTED, PROPERTY_CONNECTION_POLLING_INTERVAL, PROPERTY_HOST, PROPERTY_PORT, PROPERTY_PROCESS_NAME, PROPERTY_VERBOSE, VERSION

Method Summary

boolean	deepPing() Perform a component-specific 'deep' ping
java.lang.String	doRequest(java.lang.String request) Execute a component-specific command
java.lang.String	getBuildNumber() Get the component's build number
java.lang.String	getBuildPlatform() Get the component's build platform
java.lang.String	getComponentVersion() Get the component's version number
java.lang.String	getCurrentDirectory() Get the component's current working directory path
java.lang.String	getHostname() Get the hostname that component is running on
GenericComponentManagement.GenericComponentInfo	getInfo(java.lang.String category) Request component-specific status/configuration information
long	getLogicalId() Get the unique logical ID of the component
GenericComponentManagement.GenericComponentLogLevel	getLogLevel() Get the component's current logging level
java.lang.String	getName() Get the name of the component, encoded as UTF-8
long	getPhysicalId() Get the globally unique physical ID of the component
long	getPID() Return the component's process ID
java.lang.String	getProductVersion() Get the version number of the product the component belongs to
int	getRemotePort() Get the port number that the component is listening on
java.lang.String	getType() Get the type of the component, encoded as UTF-8
java.lang.String	getUsername() Get the effective username the component is running as
boolean	isGenericComponentManagementAvailable() Returns true if the GenericComponentManagement interface is available
void	setLogLevel(GenericComponentManagement.GenericComponentLogLevel logLevel) Set the component's logging level
void	shutdown(java.lang.String why) Tell the component to shut itself down NOW

Methods inherited from interface com.apama.net.beans.interfaces.PingOperationsInterface

pingServer

Methods inherited from interface com.apama.net.beans.interfaces.BaseClientInterface

addPropertyChangeListener, addPropertyChangeListener, connectNow, disconnect, dispose, getBeanConnected, getConnectionPollingInterval, getHost, getPort, getProcessName, isBeanConnected, removePropertyChangeListener, removePropertyChangeListener, setConnectionPollingInterval, setHost, setPort, setProcessName

Method Detail

isGenericComponentManagementAvailable

boolean isGenericComponentManagementAvailable()

Returns true if the GenericComponentManagement interface is available

deepPing

boolean deepPing()
                 throws GenericComponentManagementException

Perform a component-specific 'deep' ping

Throws:

GenericComponentManagementException

getPID

long getPID()
            throws GenericComponentManagementException

Return the component's process ID

Throws:

GenericComponentManagementException

shutdown

void shutdown(java.lang.String why)
              throws GenericComponentManagementException

Tell the component to shut itself down NOW

Throws:

GenericComponentManagementException

getName

java.lang.String getName()
                         throws GenericComponentManagementException

Get the name of the component, encoded as UTF-8

Throws:

GenericComponentManagementException

getType

java.lang.String getType()
                         throws GenericComponentManagementException

Get the type of the component, encoded as UTF-8

Throws:

GenericComponentManagementException

getPhysicalId

long getPhysicalId()
                   throws GenericComponentManagementException

Get the globally unique physical ID of the component

Throws:

GenericComponentManagementException

getLogicalId

long getLogicalId()
                  throws GenericComponentManagementException

Get the unique logical ID of the component

Throws:

GenericComponentManagementException

getLogLevel

GenericComponentManagement.GenericComponentLogLevel getLogLevel()
                                                                throws GenericComponentManagementException

Get the component's current logging level

Throws:

GenericComponentManagementException

setLogLevel

void setLogLevel(GenericComponentManagement.GenericComponentLogLevel logLevel)
                 throws GenericComponentManagementException

Set the component's logging level

Throws:

GenericComponentManagementException

getComponentVersion

java.lang.String getComponentVersion()
                                     throws GenericComponentManagementException

Get the component's version number

Throws:

GenericComponentManagementException

getProductVersion

java.lang.String getProductVersion()
                                   throws GenericComponentManagementException

Get the version number of the product the component belongs to

Throws:

GenericComponentManagementException

getBuildNumber

java.lang.String getBuildNumber()
                                throws GenericComponentManagementException

Get the component's build number

Throws:

GenericComponentManagementException

getBuildPlatform

java.lang.String getBuildPlatform()
                                  throws GenericComponentManagementException

Get the component's build platform

Throws:

GenericComponentManagementException

getHostname

java.lang.String getHostname()
                             throws GenericComponentManagementException

Get the hostname that component is running on

Throws:

GenericComponentManagementException

getUsername

java.lang.String getUsername()
                             throws GenericComponentManagementException

Get the effective username the component is running as

Throws:

GenericComponentManagementException

getCurrentDirectory

java.lang.String getCurrentDirectory()
                                     throws GenericComponentManagementException

Get the component's current working directory path

Throws:

GenericComponentManagementException

getRemotePort

int getRemotePort()
                  throws GenericComponentManagementException

Get the port number that the component is listening on

Throws:

GenericComponentManagementException

doRequest

java.lang.String doRequest(java.lang.String request)
                           throws GenericComponentManagementException

Execute a component-specific command

Throws:

GenericComponentManagementException

getInfo

GenericComponentManagement.GenericComponentInfo getInfo(java.lang.String category)
                                                        throws GenericComponentManagementException

Request component-specific status/configuration information

Throws:

GenericComponentManagementException