Package com.alachisoft.ncache.runtime.caching

Class ClientInfo

java.lang.Object

com.alachisoft.ncache.runtime.caching.ClientInfo

All Implemented Interfaces:

java.lang.Cloneable

public class ClientInfo
extends java.lang.Object
implements java.lang.Cloneable

This class provides detailed information about cache client.

Constructor Summary

Constructors

Constructor	Description
ClientInfo()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()	Clones the object and returns the newly created clone of the object.
java.lang.String	getAppName()	Gets the client application name.
java.lang.String	getClientID()	Gets the client unique id of the cache client.
int	getClientVersion()	Gets the version of the NCahce client.
int	getCores()	Gets the available cores of the cache client.
java.net.InetAddress	getIPAddress()	Gets the IPAddress of the cache client.
java.lang.String	getMacAddress()	Gets the MacAddress of the cache client.
java.lang.String	getMachineName()	Gets the name of the machine the client is running on.
int	getProcessID()	Gets the Process ID of the cache client.
ConnectivityStatus	getStatus()	Gets the enum that specifies whether client is connected to cache or not.
void	setAppName(java.lang.String value)	Sets the client application name.
void	setClientID(java.lang.String value)	Sets the client unique id of the cache client.
void	setClientVersion(int value)	Sets the version of the NCache client.
void	setCores(int value)	Sets the available cores of the cache client.
void	setIPAddress(java.net.InetAddress value)	Sets the IPAddress of the cache client.
void	setMacAddress(java.lang.String value)	Sets the MacAddress of the cache client.
void	setMachineName(java.lang.String value)	Sets the name of the machine the client is running on.
void	setProcessID(int value)	Sets the Process ID of the cache client.
void	setStatus(ConnectivityStatus value)	Sets the enum that specifies whether client is connected to cache or not.
java.lang.String	toString()	Converts Client Info to string , contains client id , Application name ,Process id , machine name and address.
static ClientInfo	tryParseLegacyClientID(java.lang.String clientId)	Parses the Client id and get information about the client id in the form of ClientInfo.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientInfo

public ClientInfo()

Method Detail

tryParseLegacyClientID

public static ClientInfo tryParseLegacyClientID(java.lang.String clientId)

Parses the Client id and get information about the client id in the form of ClientInfo.

Parameters:

clientId - Client id of the client.

Returns:

ClientInfo instance.

getAppName

public java.lang.String getAppName()

Gets the client application name.

Returns:

The client application name.

setAppName

public void setAppName(java.lang.String value)

Sets the client application name.

Parameters:

value - The client application name.

getClientID

public java.lang.String getClientID()

Gets the client unique id of the cache client.

Returns:

The client unique id of the cache client.

setClientID

public void setClientID(java.lang.String value)

Sets the client unique id of the cache client.

Parameters:

value - The client unique id of the cache client.

getIPAddress

public java.net.InetAddress getIPAddress()

Gets the IPAddress of the cache client.

Returns:

The IPAddress of the cache client.

setIPAddress

public void setIPAddress(java.net.InetAddress value)

Sets the IPAddress of the cache client.

Parameters:

value - The IPAddress of the cache client.

getMacAddress

public java.lang.String getMacAddress()

Gets the MacAddress of the cache client.

Returns:

The MacAddress of the cache client.

setMacAddress

public void setMacAddress(java.lang.String value)

Sets the MacAddress of the cache client.

Parameters:

value - The MacAddress of the cache client.

getCores

public int getCores()

Gets the available cores of the cache client.

Returns:

The available cores of the cache client.

setCores

public void setCores(int value)

Sets the available cores of the cache client.

Parameters:

value - The available cores of the cache client.

getProcessID

public int getProcessID()

Gets the Process ID of the cache client.

Returns:

The Process ID of the cache client.

setProcessID

public void setProcessID(int value)

Sets the Process ID of the cache client.

Parameters:

value - The Process ID of the cache client.

getMachineName

public java.lang.String getMachineName()

Gets the name of the machine the client is running on.

Returns:

The name of the machine the client is running on.

setMachineName

public void setMachineName(java.lang.String value)

Sets the name of the machine the client is running on.

Parameters:

value - The name of the machine the client is running on.

getStatus

public ConnectivityStatus getStatus()

Gets the enum that specifies whether client is connected to cache or not.

Returns:

The ConnectivityStatus of the client.

setStatus

public void setStatus(ConnectivityStatus value)

Sets the enum that specifies whether client is connected to cache or not.

Parameters:

value - The ConnectivityStatus of the client.

getClientVersion

public int getClientVersion()

Gets the version of the NCahce client.

Returns:

Version of NCache client.

setClientVersion

public void setClientVersion(int value)

Sets the version of the NCache client.

Parameters:

value - Version of NCache client.

toString

public java.lang.String toString()

Converts Client Info to string , contains client id , Application name ,Process id , machine name and address.

Overrides:

toString in class java.lang.Object

Returns:

Client info in form of a string.

clone

public java.lang.Object clone()

Clones the object and returns the newly created clone of the object.

Overrides:

clone in class java.lang.Object

Returns:

The newly cloned ClientInfo object.