Serialized Form (RHQ Enterprise Agent-Server Communications Layer 4.9.0 API)

Package org.rhq.enterprise.communications.command
- Class org.rhq.enterprise.communications.command.AbstractCommand extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_commandType
```
CommandType m_commandType
```
      this command's type, which includes the name of the command
    - m_parameterDefinitions
```
Map<K,V> m_parameterDefinitions
```
      this command's parameter definitions; may be null if all parameters are accepted
    - m_commandParameters
```
Map<K,V> m_commandParameters
```
      optional parameters to this command; may be null
    - m_commandInResponse
```
boolean m_commandInResponse
```
      if true, the command processor will return this command in the response back to the client
    - m_config
```
Properties m_config
```
      This instance's configuration.
- Class org.rhq.enterprise.communications.command.AbstractCommandResponse extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_successful
```
boolean m_successful
```
      flag to indicate if the command was successfully executed or not
    - m_results
```
Object m_results
```
      the actual response data that resulted from the command execution
    - m_exception
```
Throwable m_exception
```
      an exception that typically is the result of a failed command
    - m_command
```
Command m_command
```
      if the command that was executed had requested itself to be saved in the response, this will be it
- Class org.rhq.enterprise.communications.command.CommandType extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_name
```
String m_name
```
      the command name
    - m_version
```
int m_version
```
      the version of the command
Package org.rhq.enterprise.communications.command.client
- Class org.rhq.enterprise.communications.command.client.ClientCommandSenderConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - queueSize
```
int queueSize
```
      the maximum number of commands that can be queued up (if 0 or less, its unbounded).
    - maxConcurrent
```
int maxConcurrent
```
      the maximum number of commands that can concurrently be sent.
    - defaultTimeoutMillis
```
long defaultTimeoutMillis
```
      milliseconds to wait for a command to be sent before timing out (commands can override this in their configuration). If this is less than or equal to 0, by default a command is never timed out (while this could conceivably cause a thread to hang waiting for a rogue command to never finish, it also reduces the amount of short-lived threads created by the system and increases throughput).
    - enableQueueThrottling
```
boolean enableQueueThrottling
```
      If true, the sender will be initialized with queue throttling enabled. The throttling parameters are defined by ClientCommandSenderConfiguration.queueThrottleMaxCommands and ClientCommandSenderConfiguration.queueThrottleBurstPeriodMillis. If false, the sender will disable its queue throttling mechanism and dequeue commands as fast as it can.
    - queueThrottleMaxCommands
```
long queueThrottleMaxCommands
```
      The maximum number of commands that can be dequeued during a burst period. This defines the size of each "burst".
      This will be ignored if ClientCommandSenderConfiguration.enableQueueThrottling is false.
    - queueThrottleBurstPeriodMillis
```
long queueThrottleBurstPeriodMillis
```
      The number of milliseconds the queue throttling mechanism will wait before allowing more commands (over the ClientCommandSenderConfiguration.maxConcurrent) to be dequeued. This is the time period of each "burst".
      This will be ignored if ClientCommandSenderConfiguration.enableQueueThrottling is false.
    - enableSendThrottling
```
boolean enableSendThrottling
```
      If true, then "send throttling" will be enabled. This means that messages will not be sent during a quiet period defined by the send throttling parameters ClientCommandSenderConfiguration.sendThrottleMaxCommands and ClientCommandSenderConfiguration.sendThrottleQuietPeriodDurationMillis. If false then all messages that are asked to be sent will be sent immediately without a quiet period being enforced. Note that only commands that are configured for "send-throtting" will be affected by this setting.
    - sendThrottleMaxCommands
```
long sendThrottleMaxCommands
```
      The maximum number of commands that are allowed to be sent before the send throttling's quiet period starts.
      This will be ignored if ClientCommandSenderConfiguration.enableSendThrottling is false.
    - sendThrottleQuietPeriodDurationMillis
```
long sendThrottleQuietPeriodDurationMillis
```
      The duration of the send throttling's quiet period. Commands will not be sent during this quiet period, unless the commands are configured to explicitly ignore the send throttling quiet period.
      This will be ignored if ClientCommandSenderConfiguration.enableSendThrottling is false.
    - serverPollingIntervalMillis
```
long serverPollingIntervalMillis
```
      If larger than 0, this indicates the sender should periodically poll the server to make sure its still up or (if it was down) see when it comes back up. The value is the number of milliseconds to wait in between polls.
    - dataDirectory
```
File dataDirectory
```
      A path to a data directory where this sender can store things on the file system - like persisted commands.
    - retryInterval
```
long retryInterval
```
      This is the time period the sender will wait before retrying to send a guaranteed command that previously failed. Note: if the sender is currently waiting in this retry period, the agent will not be able to be shutdown. If the agent is asked to shutdown, it will wait until any current retries are completed. This is to help ensure those commands are not lost.
    - maxRetries
```
int maxRetries
```
      If a guaranteed delivery message is sent, but the sender fails to connect to the server and deliver the message, it will always be retried. However, if the error was something other than a "cannot connect" error, the command will only be retried this amount of times before the command is dropped. When this happens, the guaranteed command will never be delivered. This will normally happen under very odd and rare circumstances (bugs in the software is one cause).
    - commandSpoolFileName
```
String commandSpoolFileName
```
      The name of the command spool file (to be located in the ClientCommandSenderConfiguration.dataDirectory}. If this value is null, it will be assumed that commands should not be persisted (this means guaranteed delivery will be implicitly unsupported).
    - commandSpoolFileMaxSize
```
long commandSpoolFileMaxSize
```
      This is the maximum size of the command spool file. If the file grows beyond this, it will be purged in order to shrink its size down.
    - commandSpoolFilePurgePercentage
```
int commandSpoolFilePurgePercentage
```
      If the command spool file crosses its max size threshold and a purge is initiated, this is the percentage of bytes the command spool file will be allowed to be after the purge completes. This is a percentage of ClientCommandSenderConfiguration.commandSpoolFileMaxSize. See PersistentFifo for more info on this parameter.
    - commandSpoolFileCompressData
```
boolean commandSpoolFileCompressData
```
      If this flag is true, the commands stored in the spool file will be compressed. This can potentially save about 30%-40% in disk space (give or take), however, it slows down the persistence considerably. Recommended setting for this should be false unless something on the agent's deployment box warrants disk-saving over persistence performance. The performance hit will only appear when unusual conditions occur, such as shutting down while some guaranteed commands haven't been sent yet or while the server is down. It will not affect the agent under normal conditions (while running with the server up and communicating with the agent). In those unusual/rare conditions, having performance degradation may not be as important.
    - commandPreprocessors
```
String commandPreprocessors
```
      A fully qualified class name of a CommandPreprocessor implementation that will be used to preprocess all commands that are to be queued and sent by the client command sender. May be null or empty string in which case no preprocessor is specified. You may optionally specify multiple class names, separating each class name with a colon (e.g. org.foo.Preproc1:org.foo.Preproc2).
    - securityServerAuthMode
```
boolean securityServerAuthMode
```
      When sending over an SSL socket, this will determine if the server must be authenticated in order for the handshake to be successful.
    - securityKeystoreFile
```
String securityKeystoreFile
```
      The path to the keystore file (that contain's the client's key).
    - securityKeystoreType
```
String securityKeystoreType
```
      The type of file that the keystore file is.
    - securityKeystoreAlgorithm
```
String securityKeystoreAlgorithm
```
      The key management algorithm used in the keystore file.
    - securityKeystorePassword
```
String securityKeystorePassword
```
      The password that gains access to the keystore file.
    - securityKeystoreKeyPassword
```
String securityKeystoreKeyPassword
```
      The password that gains access to the client key within the keystore file.
    - securityKeystoreAlias
```
String securityKeystoreAlias
```
      The alias of the client key within the keystore file.
    - securityTruststoreFile
```
String securityTruststoreFile
```
      The path to the truststore that contains the public keys of all trusted remote endpoints.
    - securityTruststoreType
```
String securityTruststoreType
```
      The type of file that the truststore file is.
    - securityTruststoreAlgorithm
```
String securityTruststoreAlgorithm
```
      The key management algorithm used in the truststore file.
    - securityTruststorePassword
```
String securityTruststorePassword
```
      The password that gains access to the truststore file.
    - securitySecureSocketProtocol
```
String securitySecureSocketProtocol
```
      The secure protocol used when connecting to the remote server's socket.
- Class org.rhq.enterprise.communications.command.client.CommandAndCallback extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_command
```
Command m_command
```
    - m_callback
```
CommandResponseCallback m_callback
```
- Class org.rhq.enterprise.communications.command.client.RemoteInputStream extends InputStream implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_streamId
```
Long m_streamId
```
      Identifies the specific remote stream this object will operate on.
    - m_serverEndpoint
```
String m_serverEndpoint
```
      This identifies the server endpoint that remote "clients" will use to connect to when they want to read in the contents of the stream data.
- Class org.rhq.enterprise.communications.command.client.RemoteIOException extends IOException implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.client.RemoteOutputStream extends OutputStream implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_streamId
```
Long m_streamId
```
      Identifies the specific remote stream this object will operate on.
    - m_serverEndpoint
```
String m_serverEndpoint
```
      This identifies the server endpoint that remote "clients" will use to connect to when they want to read in the contents of the stream data.
- Class org.rhq.enterprise.communications.command.client.RemotePojoInvocationFuture extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_results
```
RemotePojoInvocationCommandResponse m_results
```
      When non-null, is the results of the last pojo invocation.
Package org.rhq.enterprise.communications.command.impl.echo
- Class org.rhq.enterprise.communications.command.impl.echo.EchoCommand extends AbstractCommand implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.impl.echo.EchoCommandResponse extends AbstractCommandResponse implements Serializable
  
  serialVersionUID:
  
  1L
Package org.rhq.enterprise.communications.command.impl.generic
- Class org.rhq.enterprise.communications.command.impl.generic.GenericCommand extends AbstractCommand implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_newCommandType
```
CommandType m_newCommandType
```
      used to force the command to this new type
    - m_newParameterDefinitions
```
ParameterDefinition[] m_newParameterDefinitions
```
      used to force the definitions to these new ones
- Class org.rhq.enterprise.communications.command.impl.generic.GenericCommandResponse extends AbstractCommandResponse implements Serializable
  
  serialVersionUID:
  
  1L
Package org.rhq.enterprise.communications.command.impl.identify
- Class org.rhq.enterprise.communications.command.impl.identify.AgentIdentification extends Identification implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.impl.identify.Identification extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - m_type
```
String m_type
```
    - m_locator
```
String m_locator
```
    - m_timestamp
```
long m_timestamp
```
- Class org.rhq.enterprise.communications.command.impl.identify.IdentifyCommand extends AbstractCommand implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.impl.identify.IdentifyCommandResponse extends AbstractCommandResponse implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.impl.identify.ServerIdentification extends Identification implements Serializable
  
  serialVersionUID:
  
  1L
Package org.rhq.enterprise.communications.command.impl.remotepojo
- Class org.rhq.enterprise.communications.command.impl.remotepojo.RemotePojoInvocationCommand extends AbstractCommand implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.impl.remotepojo.RemotePojoInvocationCommandResponse extends AbstractCommandResponse implements Serializable
  
  serialVersionUID:
  
  1L
Package org.rhq.enterprise.communications.command.impl.start
- Class org.rhq.enterprise.communications.command.impl.start.StartCommand extends AbstractCommand implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.impl.start.StartCommandResponse extends AbstractCommandResponse implements Serializable
  
  serialVersionUID:
  
  1L
Package org.rhq.enterprise.communications.command.impl.stream
- Class org.rhq.enterprise.communications.command.impl.stream.RemoteInputStreamCommand extends AbstractCommand implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.impl.stream.RemoteInputStreamCommandResponse extends AbstractCommandResponse implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.impl.stream.RemoteOutputStreamCommand extends AbstractCommand implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.impl.stream.RemoteOutputStreamCommandResponse extends AbstractCommandResponse implements Serializable
  
  serialVersionUID:
  
  1L
Package org.rhq.enterprise.communications.command.param
- Class org.rhq.enterprise.communications.command.param.DynamicFixedValuesParameterDefinition extends FixedValuesParameterDefinition implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.param.FileUploadRenderingInformation extends ParameterRenderingInformation implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.param.FixedValuesParameterDefinition extends ParameterDefinition implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_allowedValues
```
List<E> m_allowedValues
```
      list of the fixed values this parameter is allowed to have
- Class org.rhq.enterprise.communications.command.param.InvalidParameterDefinitionException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.param.InvalidParameterValueException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.param.MapValueParameterDefinition extends ParameterDefinition implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.param.NoParameterDefinitionsException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.param.OptionListRenderingInformation extends ParameterRenderingInformation implements Serializable
  
  serialVersionUID:
  
  -8125953068553352997L
  - Serialized Fields
    - optionLabelKeys
```
List<E> optionLabelKeys
```
    - optionLabels
```
List<E> optionLabels
```
- Class org.rhq.enterprise.communications.command.param.Parameter extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_definition
```
ParameterDefinition m_definition
```
      The definition that describes the parameter - note it is final/immutable
    - m_value
```
Object m_value
```
      the actual value of the parameter - this value can change during its lifetime
    - m_dirty
```
boolean m_dirty
```
      this will be true when the value has changed from its initial value as set by a call to one of the constructors.
- Class org.rhq.enterprise.communications.command.param.ParameterDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_name
```
String m_name
```
      The name of the parameter - this is the name you use to look up the parameter value via Command.getParameterValue(String).
    - m_type
```
String m_type
```
      The type of the parameter specified "the Java way" (e.g. java.lang.String).
    - m_required
```
boolean m_required
```
      if true, this parameter's value is required to execute a command successfully.
    - m_nullable
```
boolean m_nullable
```
      if true, this parameter's value is allowed to be null.
    - m_hidden
```
boolean m_hidden
```
      if true, this parameter's existence should be hidden from view from a user interface. A user should not know about this parameter if it is hidden.
    - m_description
```
String m_description
```
      a description of the parameter's function
    - m_renderingInfo
```
ParameterRenderingInformation m_renderingInfo
```
      information useful to clients who are trying to render the parameter for reading/editing
- Class org.rhq.enterprise.communications.command.param.ParameterRenderingInformation extends Object implements Serializable
  
  serialVersionUID:
  
  -7640644266857817767L
  - Serialized Fields
    - labelKey
```
String labelKey
```
    - descriptionKey
```
String descriptionKey
```
    - label
```
String label
```
    - description
```
String description
```
    - hidden
```
boolean hidden
```
    - readOnly
```
boolean readOnly
```
    - obfuscated
```
boolean obfuscated
```
- Class org.rhq.enterprise.communications.command.param.ParametersImpl extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_parameters
```
Map<K,V> m_parameters
```
      A map containing all the Parameter objects; keyed on ParameterNameIndex.
    - m_lastIndex
```
int m_lastIndex
```
      The index of the last parameter that was added to the collection.
- Class org.rhq.enterprise.communications.command.param.SortedParameterNameIndexComparator extends Object implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.param.TextFieldRenderingInformation extends ParameterRenderingInformation implements Serializable
  
  serialVersionUID:
  
  -4522547613969935854L
  - Serialized Fields
    - fieldLength
```
int fieldLength
```
    - fieldHeight
```
int fieldHeight
```
- Class org.rhq.enterprise.communications.command.param.UnorderedListRenderingInformation extends ParameterRenderingInformation implements Serializable
  
  serialVersionUID:
  
  1L
Package org.rhq.enterprise.communications.command.server
- Class org.rhq.enterprise.communications.command.server.AuthenticationException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.rhq.enterprise.communications.command.server.CommandProcessorMetrics extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - numberSuccessfulCommands
```
long numberSuccessfulCommands
```
      The total number of incoming commands this command processor has received and successfully processed.
    - numberFailedCommands
```
long numberFailedCommands
```
      The total number of commands that were received but were not successfully processed due to an error.
    - numberDroppedCommands
```
long numberDroppedCommands
```
      The total number of commands that were not permitted to execute due to high concurrency.
    - numberNotProcessedCommands
```
long numberNotProcessedCommands
```
      The total number of commands that were not permitted to execute due to processing suspension.
    - averageExecutionTime
```
long averageExecutionTime
```
      The average time (in milliseconds) that successful commands take to complete.
    - calltimes
```
Map<K,V> calltimes
```
      Call time data for individual command types (or subtypes if remote pojo executions).
    - lock
```
ReadWriteLock lock
```
      The lock that will ensure thread-safety.
- Class org.rhq.enterprise.communications.command.server.CommandProcessorMetrics.Calltime extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - count
```
long count
```
    - failures
```
long failures
```
    - dropped
```
long dropped
```
    - unprocessed
```
long unprocessed
```
    - min
```
long min
```
    - max
```
long max
```
    - avg
```
long avg
```
- Class org.rhq.enterprise.communications.command.server.CommandServiceDirectoryEntry extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_subsystem
```
String m_subsystem
```
    - m_commandType
```
CommandType m_commandType
```
    - m_commandServiceName
```
ObjectName m_commandServiceName
```
- Class org.rhq.enterprise.communications.command.server.CommandServiceId extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - m_id
```
String m_id
```
      The actual ID.
Package org.rhq.enterprise.communications.command.server.discovery
- Class org.rhq.enterprise.communications.command.server.discovery.AutoDiscoveryException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
Package org.rhq.enterprise.communications.util
- Class org.rhq.enterprise.communications.util.NotPermittedException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - sleepBeforeRetry
```
long sleepBeforeRetry
```
- Class org.rhq.enterprise.communications.util.NotProcessedException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - reason
```
String reason
```

Serialized Form

Package org.rhq.enterprise.communications.command

Class org.rhq.enterprise.communications.command.AbstractCommand extends Object implements Serializable

Serialized Fields

m_commandType

m_parameterDefinitions

m_commandParameters

m_commandInResponse

m_config

Class org.rhq.enterprise.communications.command.AbstractCommandResponse extends Object implements Serializable

Serialized Fields

m_successful

m_results

m_exception

m_command

Class org.rhq.enterprise.communications.command.CommandType extends Object implements Serializable

Serialized Fields

m_name

m_version

Package org.rhq.enterprise.communications.command.client

Class org.rhq.enterprise.communications.command.client.ClientCommandSenderConfiguration extends Object implements Serializable

Serialized Fields

queueSize

maxConcurrent

defaultTimeoutMillis

enableQueueThrottling

queueThrottleMaxCommands

queueThrottleBurstPeriodMillis

enableSendThrottling

sendThrottleMaxCommands

sendThrottleQuietPeriodDurationMillis

serverPollingIntervalMillis

dataDirectory

retryInterval

maxRetries

commandSpoolFileName

commandSpoolFileMaxSize

commandSpoolFilePurgePercentage

commandSpoolFileCompressData

commandPreprocessors

securityServerAuthMode

securityKeystoreFile

securityKeystoreType

securityKeystoreAlgorithm

securityKeystorePassword

securityKeystoreKeyPassword

securityKeystoreAlias

securityTruststoreFile

securityTruststoreType

securityTruststoreAlgorithm

securityTruststorePassword

securitySecureSocketProtocol

Class org.rhq.enterprise.communications.command.client.CommandAndCallback extends Object implements Serializable

Serialized Fields

m_command

m_callback

Class org.rhq.enterprise.communications.command.client.RemoteInputStream extends InputStream implements Serializable

Serialized Fields

m_streamId

m_serverEndpoint

Class org.rhq.enterprise.communications.command.client.RemoteIOException extends IOException implements Serializable

Class org.rhq.enterprise.communications.command.client.RemoteOutputStream extends OutputStream implements Serializable

Serialized Fields

m_streamId

m_serverEndpoint

Class org.rhq.enterprise.communications.command.client.RemotePojoInvocationFuture extends Object implements Serializable

Serialized Fields

m_results

Package org.rhq.enterprise.communications.command.impl.echo

Class org.rhq.enterprise.communications.command.impl.echo.EchoCommand extends AbstractCommand implements Serializable

Class org.rhq.enterprise.communications.command.impl.echo.EchoCommandResponse extends AbstractCommandResponse implements Serializable

Package org.rhq.enterprise.communications.command.impl.generic

Class org.rhq.enterprise.communications.command.impl.generic.GenericCommand extends AbstractCommand implements Serializable

Serialized Fields

m_newCommandType

m_newParameterDefinitions

Class org.rhq.enterprise.communications.command.impl.generic.GenericCommandResponse extends AbstractCommandResponse implements Serializable

Package org.rhq.enterprise.communications.command.impl.identify

Class org.rhq.enterprise.communications.command.impl.identify.AgentIdentification extends Identification implements Serializable

Class org.rhq.enterprise.communications.command.impl.identify.Identification extends Object implements Serializable