com.liferay.lcs.messaging

Class HandshakeMessage

java.lang.Object

com.liferay.lcs.messaging.Message

com.liferay.lcs.messaging.HandshakeMessage

All Implemented Interfaces:

java.io.Serializable

public class HandshakeMessage
extends Message

Represents a Liferay Cloud Services Protocol handshake message. This message is always sent from the LCS system to the LCS client. A successful handshake results in a virtual session that lasts as long as the LCS system receives heartbeat messages from the client.

Since:

LCS 0.1

See Also:

Serialized Form

Field Summary

Fields inherited from class com.liferay.lcs.messaging.Message

PROTOCOL_VERSION_1_0, PROTOCOL_VERSION_1_1, PROTOCOL_VERSION_1_2, PROTOCOL_VERSION_1_3, PROTOCOL_VERSION_1_4, PROTOCOL_VERSION_1_5, PROTOCOL_VERSION_1_6, PROTOCOL_VERSION_1_7, PROTOCOL_VERSION_1_8, PROTOCOL_VERSION_CURRENT

Constructor Summary

Constructors

Constructor and Description
HandshakeMessage()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.Integer,java.lang.String>	getCompanyIdsWebIds()
int	getHashCode()
long	getHeartbeatInterval()
long	getLCSClusterEntryTokenId()
java.lang.String	getLCSClusterNodeName()
int	getLCSPortletBuildNumber()
java.lang.String	getLCSPortletVersion()
int	getPatchingToolVersion()
int	getPortalBuildNumber()
java.lang.String	getPortalEdition()
int	getProcessorCoresTotal()
java.util.List<java.util.Map<java.lang.String,java.lang.Long>>	getUptimes()
boolean	isClusterExecutorEnabled()
boolean	isDeregister()
boolean	isMetricsLCSServiceEnabled() Deprecated. As of Judson (7.1.x), will be removed in next version
boolean	isMonitoringEnabled()
boolean	isPatchesLCSServiceEnabled() Deprecated. As of Judson (7.1.x), will be removed in next version
boolean	isPatchingToolEnabled()
boolean	isPortalPropertiesLCSServiceEnabled() Deprecated. As of Judson (7.1.x), will be removed in next version
boolean	isServerManuallyShutdown()
boolean	isSignOff()
void	setClusterExecutorEnabled(boolean clusterExecutorEnabled)
void	setCompanyIdsWebIds(java.util.Map<java.lang.Integer,java.lang.String> companyIdsWebIds)
void	setDeregister(boolean deregister)
void	setHashCode(int hashCode)
void	setHeartbeatInterval(long heartbeatInterval)
void	setLCSClusterEntryTokenId(long lcsClusterEntryTokenId)
void	setLCSClusterNodeName(java.lang.String lcsClusterNodeName)
void	setLCSPortletBuildNumber(int lcsPortletBuildNumber)
void	setLCSPortletVersion(java.lang.String lcsPortletVersion)
void	setMetricsLCSServiceEnabled(boolean metricsLCSServiceEnabled) Deprecated. As of Judson (7.1.x), will be removed in next version
void	setMonitoringEnabled(boolean monitoringEnabled)
void	setPatchesLCSServiceEnabled(boolean patchesLCSServiceEnabled) Deprecated. As of Judson (7.1.x), will be removed in next version
void	setPatchingToolEnabled(boolean patchingToolEnabled)
void	setPatchingToolVersion(int patchingToolVersion)
void	setPortalBuildNumber(int portalBuildNumber)
void	setPortalEdition(java.lang.String portalEdition)
void	setPortalPropertiesLCSServiceEnabled(boolean portalPropertiesLCSServiceEnabled) Deprecated. As of Judson (7.1.x), will be removed in next version
void	setProcessorCoresTotal(int processorCoresTotal)
void	setServerManuallyShutdown(boolean serverManuallyShutdown)
void	setSignOff(boolean signOff)
void	setUptimes(java.util.List<java.util.Map<java.lang.String,java.lang.Long>> uptimes)
java.lang.String	toString()

Methods inherited from class com.liferay.lcs.messaging.Message

createMessage, createMessage, getCreateTime, getDeliveryTag, getErrorCode, getErrorMessage, getKey, getProtocolVersion, getQueueName, getSignatureString, getTransportMetadata, setCreateTime, setDeliveryTag, setErrorCode, setErrorMessage, setKey, setProtocolVersion, setQueueName, setTransportMetadata, toJSON

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HandshakeMessage

public HandshakeMessage()

Method Detail

getCompanyIdsWebIds

public java.util.Map<java.lang.Integer,java.lang.String> getCompanyIdsWebIds()

getHashCode

public int getHashCode()

getHeartbeatInterval

public long getHeartbeatInterval()

getLCSClusterEntryTokenId

public long getLCSClusterEntryTokenId()

getLCSClusterNodeName

public java.lang.String getLCSClusterNodeName()

getLCSPortletBuildNumber

public int getLCSPortletBuildNumber()

getLCSPortletVersion

public java.lang.String getLCSPortletVersion()

getPatchingToolVersion

public int getPatchingToolVersion()

getPortalBuildNumber

public int getPortalBuildNumber()

getPortalEdition

public java.lang.String getPortalEdition()

getProcessorCoresTotal

public int getProcessorCoresTotal()

getUptimes

public java.util.List<java.util.Map<java.lang.String,java.lang.Long>> getUptimes()

isClusterExecutorEnabled

public boolean isClusterExecutorEnabled()

isDeregister

public boolean isDeregister()

isMetricsLCSServiceEnabled

@Deprecated
public boolean isMetricsLCSServiceEnabled()

Deprecated. As of Judson (7.1.x), will be removed in next version

isMonitoringEnabled

public boolean isMonitoringEnabled()

isPatchesLCSServiceEnabled

@Deprecated
public boolean isPatchesLCSServiceEnabled()

Deprecated. As of Judson (7.1.x), will be removed in next version

isPatchingToolEnabled

public boolean isPatchingToolEnabled()

isPortalPropertiesLCSServiceEnabled

@Deprecated
public boolean isPortalPropertiesLCSServiceEnabled()

Deprecated. As of Judson (7.1.x), will be removed in next version

isServerManuallyShutdown

public boolean isServerManuallyShutdown()

isSignOff

public boolean isSignOff()

setClusterExecutorEnabled

public void setClusterExecutorEnabled(boolean clusterExecutorEnabled)

setCompanyIdsWebIds

public void setCompanyIdsWebIds(java.util.Map<java.lang.Integer,java.lang.String> companyIdsWebIds)

setDeregister

public void setDeregister(boolean deregister)

setHashCode

public void setHashCode(int hashCode)

setHeartbeatInterval

public void setHeartbeatInterval(long heartbeatInterval)

setLCSClusterEntryTokenId

public void setLCSClusterEntryTokenId(long lcsClusterEntryTokenId)

setLCSClusterNodeName

public void setLCSClusterNodeName(java.lang.String lcsClusterNodeName)

setLCSPortletBuildNumber

public void setLCSPortletBuildNumber(int lcsPortletBuildNumber)

setLCSPortletVersion

public void setLCSPortletVersion(java.lang.String lcsPortletVersion)

setMetricsLCSServiceEnabled

@Deprecated
public void setMetricsLCSServiceEnabled(boolean metricsLCSServiceEnabled)

Deprecated. As of Judson (7.1.x), will be removed in next version

setMonitoringEnabled

public void setMonitoringEnabled(boolean monitoringEnabled)

setPatchesLCSServiceEnabled

@Deprecated
public void setPatchesLCSServiceEnabled(boolean patchesLCSServiceEnabled)

Deprecated. As of Judson (7.1.x), will be removed in next version

setPatchingToolEnabled

public void setPatchingToolEnabled(boolean patchingToolEnabled)

setPatchingToolVersion

public void setPatchingToolVersion(int patchingToolVersion)

setPortalBuildNumber

public void setPortalBuildNumber(int portalBuildNumber)

setPortalEdition

public void setPortalEdition(java.lang.String portalEdition)

setPortalPropertiesLCSServiceEnabled

@Deprecated
public void setPortalPropertiesLCSServiceEnabled(boolean portalPropertiesLCSServiceEnabled)

Deprecated. As of Judson (7.1.x), will be removed in next version

setProcessorCoresTotal

public void setProcessorCoresTotal(int processorCoresTotal)

setServerManuallyShutdown

public void setServerManuallyShutdown(boolean serverManuallyShutdown)

setSignOff

public void setSignOff(boolean signOff)

setUptimes

public void setUptimes(java.util.List<java.util.Map<java.lang.String,java.lang.Long>> uptimes)

toString

public java.lang.String toString()

Overrides:

toString in class Message