public interface GenericComponentManagement
Modifier and Type | Interface and Description |
---|---|
static interface |
GenericComponentManagement.GenericComponentConnection
The interface describing a messaging connection to a component
|
static interface |
GenericComponentManagement.GenericComponentConnectionSet |
static interface |
GenericComponentManagement.GenericComponentInfo
A list 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
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String[] |
GenericComponentLogLevelNames
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
boolean |
deepPing()
Perform a component-specific 'deep' ping
|
boolean |
disconnectReceiverByComponentId(com.apama.message.ComponentIDTuple id,
java.lang.String why)
Disconnect the receiver connected to this component that has component ID
id.
|
boolean |
disconnectSenderByComponentId(com.apama.message.ComponentIDTuple id,
java.lang.String why)
Disconnect the sender connected to this component that has component ID
id.
|
java.lang.String |
doRequest(java.lang.String type,
java.lang.String[] args)
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
|
float |
getPMemory()
Get the physical memory usage of the component, in megabytes
|
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
|
int |
getUptime()
Get the uptime of the component, in ms
|
java.lang.String |
getUsername()
Get the effective username the component is running as
|
float |
getVMemory()
Get the virtual memory usage of the component, in megabytes
|
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
|
@Deprecated static final java.lang.String[] GenericComponentLogLevelNames
GenericComponentManagement.GenericComponentLogLevel.getLogLevel()
instead.boolean deepPing() throws GenericComponentManagementException
long getPID() throws GenericComponentManagementException
void shutdown(java.lang.String why) throws GenericComponentManagementException
boolean disconnectReceiverByComponentId(com.apama.message.ComponentIDTuple id, java.lang.String why) throws GenericComponentManagementException
id
- the IDwhy
- free form text that is sent to the remote receiverGenericComponentManagementException
getConnections()
boolean disconnectSenderByComponentId(com.apama.message.ComponentIDTuple id, java.lang.String why) throws GenericComponentManagementException
id
- the IDwhy
- free form text that is sent to the remote senderGenericComponentManagementException
getConnections()
java.lang.String getName() throws GenericComponentManagementException
java.lang.String getType() throws GenericComponentManagementException
int getUptime() throws GenericComponentManagementException
float getVMemory() throws GenericComponentManagementException
float getPMemory() throws GenericComponentManagementException
long getPhysicalId() throws GenericComponentManagementException
long getLogicalId() throws GenericComponentManagementException
GenericComponentManagement.GenericComponentLogLevel getLogLevel() throws GenericComponentManagementException
void setLogLevel(GenericComponentManagement.GenericComponentLogLevel logLevel) throws GenericComponentManagementException
java.lang.String getComponentVersion() throws GenericComponentManagementException
java.lang.String getProductVersion() throws GenericComponentManagementException
java.lang.String getBuildNumber() throws GenericComponentManagementException
java.lang.String getBuildPlatform() throws GenericComponentManagementException
java.lang.String getHostname() throws GenericComponentManagementException
java.lang.String getUsername() throws GenericComponentManagementException
java.lang.String getCurrentDirectory() throws GenericComponentManagementException
int getRemotePort() throws GenericComponentManagementException
java.lang.String doRequest(java.lang.String type, java.lang.String[] args) throws GenericComponentManagementException
GenericComponentManagement.GenericComponentInfo getInfo(java.lang.String category) throws GenericComponentManagementException
GenericComponentManagement.GenericComponentConnectionSet getConnections() throws GenericComponentManagementException
void ping() throws GenericComponentManagementException
Submit a bug or feature
Copyright (c) 2013-2021 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.