com.apama.net.interfaces
Interface GenericComponentManagement

public interface GenericComponentManagement

Generic management interface for Apama components.

Nested Class Summary

static interface	GenericComponentManagement.GenericComponentConnection The interface describing a messaging connection to a component
static interface	GenericComponentManagement.GenericComponentConnectionSet
static interface	GenericComponentManagement.GenericComponentInfo A set of related component info tuples
static interface	GenericComponentManagement.GenericComponentInfoTuple A name-value pair holding some information about a component
static class	GenericComponentManagement.GenericComponentLogLevel Log verbosity levels
static interface	GenericComponentManagement.GenericComponentReceiver The interface describing a messaging receiver connected to a component
static interface	GenericComponentManagement.GenericComponentSender The interface describing a messaging sender connected to a component

Field Summary

static java.lang.String[]

GenericComponentLogLevelNames Deprecated. Use GenericComponentManagement.GenericComponentLogLevel.getLogLevel() instead.

Method Summary

boolean	deepPing() Perform a component-specific 'deep' ping
boolean	disconnectReceiverByPhysicalId(long id, java.lang.String why) Disconnect the receiver connected to this component that has physical ID id.
boolean	disconnectSenderByPhysicalId(long id, java.lang.String why) Disconnect the sender connected to this component that has physical ID id.
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
GenericComponentManagement.GenericComponentConnectionSet	getConnections() Request the set of messaging peers attached to the component
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
void	ping() This method is used to check that the component is still alive.
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

Field Detail

GenericComponentLogLevelNames

static final java.lang.String[] GenericComponentLogLevelNames

Deprecated. Use GenericComponentManagement.GenericComponentLogLevel.getLogLevel() instead.

Log verbosity strings

Method Detail

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

disconnectReceiverByPhysicalId

boolean disconnectReceiverByPhysicalId(long id,
                                       java.lang.String why)
                                       throws GenericComponentManagementException

Disconnect the receiver connected to this component that has physical ID id. IDs can be discovered through the getConnections() call. You can provide a reason.

Parameters:

id - the ID

why - free form text that is sent to the remote receiver

Throws:

GenericComponentManagementException

See Also:

getConnections()

disconnectSenderByPhysicalId

boolean disconnectSenderByPhysicalId(long id,
                                     java.lang.String why)
                                     throws GenericComponentManagementException

Disconnect the sender connected to this component that has physical ID id. IDs can be discovered through the getConnections() call. You can provide a reason.

Parameters:

id - the ID

why - free form text that is sent to the remote sender

Throws:

GenericComponentManagementException

See Also:

getConnections()

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

getConnections

GenericComponentManagement.GenericComponentConnectionSet getConnections()
                                                                        throws GenericComponentManagementException

Request the set of messaging peers attached to the component

Throws:

GenericComponentManagementException

ping

void ping()
          throws GenericComponentManagementException

This method is used to check that the component is still alive. If the server is alive it returns normally. If there is a problem then a GenericComponentManagementException is thrown.

Throws:

GenericComponentManagementException