|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LocalControlAgentProtocolHandshakeOptions
Dedicated interface to represent LCA protocol handshake parameters.
LocalControlAgentProtocol
Method Summary | |
---|---|
java.lang.Integer |
getApplicationType()
Returns application type handshake property value. This value represents ordinal integer value of correspondent enumeration value from the Configuration Protocol - CfgAppType . |
KeyValueCollection |
getAppParams()
Returns the application AppParams attribute value for the LCA registration request. |
java.lang.Boolean |
getAutoRestart()
Returns application AutoRestart attribute value for the LCA registration request. |
java.lang.Integer |
getCheckTimeInterval()
Returns the application CheckTimeInterval attribute value for the LCA registration request. |
int |
getClientId()
Returns client id for the LCA connection handshake. |
java.lang.String |
getClientName()
Returns the LCA (Management Framework integration interface) client name for connection handshake procedure. |
java.lang.String |
getCmdLine()
Returns the application command line attribute value for the LCA registration request. |
java.lang.String |
getCmdParams()
Returns the application command line parameters attribute value for the LCA registration request. |
java.lang.Integer |
getControlStatus()
Returns initial application status value to be reported on the handshake procedure (connection open). It represents ordinal number of ApplicationStatus enumeration value.Default value is defined as ApplicationStatus.Initializing . |
ApplicationExecutionMode |
getExecutionMode()
Returns initial execution mode value to be reported to LCA on the handshake procedure (connection open). Default value is ApplicationExecutionMode.Primary . |
int |
getProcessId()
Returns the LCA client application PID handshake option value. By default this value is initialized by try to parse result of java.lang.management.ManagementFactory.getRuntimeMXBean().getName() . |
java.lang.Integer |
getShutdownTimeout()
Returns the application shutdown timeout attribute value for the LCA registration request. |
java.lang.Integer |
getStartupTimeout()
Returns the application startup timeout attribute value for the LCA registration request. |
java.lang.String |
getVersion()
Returns the application version attribute value for the LCA registration request. |
java.lang.String |
getWorkdir()
Returns the application working directory attribute value for the LCA registration request. |
void |
setApplicationType(java.lang.Integer applicationType)
Sets application type optional handshake property value. This value represents ordinal integer value of correspondent enumeration value from the Configuration Protocol - CfgAppType . |
void |
setAppParams(KeyValueCollection appParams)
Sets the application AppParams attribute value for the LCA registration request. |
void |
setAutoRestart(java.lang.Boolean isAutoRestart)
Sets the application AutoRestart attribute value for the LCA registration request. |
void |
setCheckTimeInterval(java.lang.Integer checkTimeInterval)
Sets the application CheckTimeInterval attribute value for the LCA registration request. |
void |
setClientId(int clientId)
Sets client id for the LCA connection handshake. |
void |
setClientName(java.lang.String clientName)
Sets the LCA (Management Framework integration interface) client name for connection handshake procedure. |
void |
setCmdLine(java.lang.String cmdLine)
Sets the application command line attribute value for the LCA registration request. |
void |
setCmdParams(java.lang.String cmdParams)
Sets the application command line parameters attribute value for the LCA registration request. |
void |
setControlStatus(java.lang.Integer appStatus)
Sets initial application status value to be reported on the handshake procedure (connection open). It represents ordinal number of ApplicationStatus enumeration value.Default value is defined as ApplicationStatus.Initializing . |
void |
setExecutionMode(ApplicationExecutionMode execMode)
Sets initial execution mode value to be reported to LCA on the handshake procedure (connection open). Default value is ApplicationExecutionMode.Primary . |
void |
setProcessId(int processId)
Sets the LCA client application system process ID to be passed to local LCA for process status control. By default this value is initialized by try to parse result of java.lang.management.ManagementFactory.getRuntimeMXBean().getName() . |
void |
setShutdownTimeout(java.lang.Integer shutdownTimeout)
Sets the application shutdown timeout attribute value for the LCA registration request. |
void |
setStartupTimeout(java.lang.Integer startupTimeout)
Sets the application startup timeout attribute value for the LCA registration request. |
void |
setVersion(java.lang.String version)
Sets the application version attribute value for the LCA registration request. |
void |
setWorkdir(java.lang.String workdir)
Sets the application working directory attribute value for the LCA registration request. |
Method Detail |
---|
void setClientName(java.lang.String clientName)
clientName
- client namejava.lang.String getClientName()
setClientName(String)
void setApplicationType(java.lang.Integer applicationType)
CfgAppType
.
applicationType
- type of the client applicationCfgAppType
java.lang.Integer getApplicationType()
CfgAppType
.
setApplicationType(Integer)
,
CfgAppType
void setClientId(int clientId)
clientId
- client idint getClientId()
setClientId(int)
void setProcessId(int processId)
java.lang.management.ManagementFactory.getRuntimeMXBean().getName()
.
In case of Sun JVM this value looks like "<jvm-pid>@<hostname>".
This method can be used if the PID is not properly extracted from the JVM
for some reason or there is a need to override its value.
processId
- LCA client application PIDManagementFactory.getRuntimeMXBean()
,
RuntimeMXBean.getName()
int getProcessId()
java.lang.management.ManagementFactory.getRuntimeMXBean().getName()
.
In case of Sun JVM this value looks like "<jvm-pid>@<hostname>".
setProcessId(int)
void setExecutionMode(ApplicationExecutionMode execMode)
ApplicationExecutionMode.Primary
.
execMode
- initial execution mode valueApplicationExecutionMode
ApplicationExecutionMode getExecutionMode()
ApplicationExecutionMode.Primary
.
setExecutionMode(ApplicationExecutionMode)
,
ApplicationExecutionMode
void setControlStatus(java.lang.Integer appStatus)
ApplicationStatus
enumeration value.ApplicationStatus.Initializing
.
appStatus
- initial application statusApplicationStatus
java.lang.Integer getControlStatus()
ApplicationStatus
enumeration value.ApplicationStatus.Initializing
.
setControlStatus(Integer)
void setAutoRestart(java.lang.Boolean isAutoRestart)
isAutoRestart
- the auto-restart attribute value, or null (default value) to do not send this attribute.java.lang.Boolean getAutoRestart()
void setWorkdir(java.lang.String workdir)
workdir
- the application working directory attribute value.java.lang.String getWorkdir()
void setCmdLine(java.lang.String cmdLine)
cmdLine
- the application command line attribute value.java.lang.String getCmdLine()
void setCmdParams(java.lang.String cmdParams)
cmdParams
- the application command line parameters attribute value.java.lang.String getCmdParams()
void setVersion(java.lang.String version)
version
- the application version attribute value.java.lang.String getVersion()
void setAppParams(KeyValueCollection appParams)
appParams
- the application AppParams attribute value.KeyValueCollection getAppParams()
void setCheckTimeInterval(java.lang.Integer checkTimeInterval)
checkTimeInterval
- the application CheckTimeInterval attribute value.java.lang.Integer getCheckTimeInterval()
void setStartupTimeout(java.lang.Integer startupTimeout)
startupTimeout
- the application startup timeout attribute value.java.lang.Integer getStartupTimeout()
void setShutdownTimeout(java.lang.Integer shutdownTimeout)
shutdownTimeout
- the application shutdown timeout attribute value.java.lang.Integer getShutdownTimeout()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |