Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol
Interface LocalControlAgentProtocolHandshakeOptions

All Known Implementing Classes:
LocalControlAgentProtocol

public interface LocalControlAgentProtocolHandshakeOptions

Dedicated interface to represent LCA protocol handshake parameters.

See Also:
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

setClientName

void setClientName(java.lang.String clientName)
Sets the LCA (Management Framework integration interface) client name for connection handshake procedure. Usually it represents own application name.

Parameters:
clientName - client name

getClientName

java.lang.String getClientName()
Returns the LCA (Management Framework integration interface) client name for connection handshake procedure. Usually it represents own application name.

Returns:
client name
See Also:
setClientName(String)

setApplicationType

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.

Parameters:
applicationType - type of the client application
See Also:
CfgAppType

getApplicationType

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.

Returns:
application type or null
See Also:
setApplicationType(Integer), CfgAppType

setClientId

void setClientId(int clientId)
Sets client id for the LCA connection handshake. Usually it represents DBID of this client application.

Parameters:
clientId - client id

getClientId

int getClientId()
Returns client id for the LCA connection handshake. Usually it represents DBID of this client application.

Returns:
client id
See Also:
setClientId(int)

setProcessId

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(). 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.

Parameters:
processId - LCA client application PID
See Also:
ManagementFactory.getRuntimeMXBean(), RuntimeMXBean.getName()

getProcessId

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(). In case of Sun JVM this value looks like "<jvm-pid>@<hostname>".

Returns:
LCA client application PID
See Also:
setProcessId(int)

setExecutionMode

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.

Parameters:
execMode - initial execution mode value
See Also:
ApplicationExecutionMode

getExecutionMode

ApplicationExecutionMode getExecutionMode()
Returns initial execution mode value to be reported to LCA on the handshake procedure (connection open).
Default value is ApplicationExecutionMode.Primary.

Returns:
initial execution mode value
See Also:
setExecutionMode(ApplicationExecutionMode), ApplicationExecutionMode

setControlStatus

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.

Parameters:
appStatus - initial application status
See Also:
ApplicationStatus

getControlStatus

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.

Returns:
initial application status
See Also:
setControlStatus(Integer)

setAutoRestart

void setAutoRestart(java.lang.Boolean isAutoRestart)
Sets the application AutoRestart attribute value for the LCA registration request.

Parameters:
isAutoRestart - the auto-restart attribute value, or null (default value) to do not send this attribute.

getAutoRestart

java.lang.Boolean getAutoRestart()
Returns application AutoRestart attribute value for the LCA registration request.

Returns:
the auto-restart attribute value.

setWorkdir

void setWorkdir(java.lang.String workdir)
Sets the application working directory attribute value for the LCA registration request.

Parameters:
workdir - the application working directory attribute value.

getWorkdir

java.lang.String getWorkdir()
Returns the application working directory attribute value for the LCA registration request.

Returns:
the application working directory attribute value.

setCmdLine

void setCmdLine(java.lang.String cmdLine)
Sets the application command line attribute value for the LCA registration request.

Parameters:
cmdLine - the application command line attribute value.

getCmdLine

java.lang.String getCmdLine()
Returns the application command line attribute value for the LCA registration request.

Returns:
the application command line attribute value.

setCmdParams

void setCmdParams(java.lang.String cmdParams)
Sets the application command line parameters attribute value for the LCA registration request.

Parameters:
cmdParams - the application command line parameters attribute value.

getCmdParams

java.lang.String getCmdParams()
Returns the application command line parameters attribute value for the LCA registration request.

Returns:
the application command line parameters attribute value.

setVersion

void setVersion(java.lang.String version)
Sets the application version attribute value for the LCA registration request.

Parameters:
version - the application version attribute value.

getVersion

java.lang.String getVersion()
Returns the application version attribute value for the LCA registration request.

Returns:
the application version attribute value.

setAppParams

void setAppParams(KeyValueCollection appParams)
Sets the application AppParams attribute value for the LCA registration request.

Parameters:
appParams - the application AppParams attribute value.

getAppParams

KeyValueCollection getAppParams()
Returns the application AppParams attribute value for the LCA registration request.

Returns:
the application AppParams attribute value.

setCheckTimeInterval

void setCheckTimeInterval(java.lang.Integer checkTimeInterval)
Sets the application CheckTimeInterval attribute value for the LCA registration request.

Parameters:
checkTimeInterval - the application CheckTimeInterval attribute value.

getCheckTimeInterval

java.lang.Integer getCheckTimeInterval()
Returns the application CheckTimeInterval attribute value for the LCA registration request.

Returns:
the application CheckTimeInterval attribute value.

setStartupTimeout

void setStartupTimeout(java.lang.Integer startupTimeout)
Sets the application startup timeout attribute value for the LCA registration request.

Parameters:
startupTimeout - the application startup timeout attribute value.

getStartupTimeout

java.lang.Integer getStartupTimeout()
Returns the application startup timeout attribute value for the LCA registration request.

Returns:
the application startup timeout attribute value.

setShutdownTimeout

void setShutdownTimeout(java.lang.Integer shutdownTimeout)
Sets the application shutdown timeout attribute value for the LCA registration request.

Parameters:
shutdownTimeout - the application shutdown timeout attribute value.

getShutdownTimeout

java.lang.Integer getShutdownTimeout()
Returns the application shutdown timeout attribute value for the LCA registration request.

Returns:
the application shutdown timeout attribute value.

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.