com.toolsverse.util.collector

Class AppInfo

Object

com.toolsverse.util.collector.AppInfo

All Implemented Interfaces:

Serializable

public class AppInfo
extends Object
implements Serializable

This class contains basic information about execution environment, such as host name, ip address, "home" folder, etc.

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCAL_HOST default LOCAL HOST.
static String	LOCAL_IP4 default LOCAL IP4.
static String	LOCAL_IP6 default LOCAL IP6.

Constructor Summary

Constructors

Constructor and Description
AppInfo() Instantiates a new AppInfo.

Method Summary

Modifier and Type	Method and Description
String	getAppHome() Gets the app home folder.
String	getAppRoot() Gets the app root folder.
String	getClientAddr() Gets the client address.
String	getClientHost() Gets the client host name.
static String	getEncodedFileName(String name) Gets the encoded file name.
static String	getEncodedName(String name) Gets the encoded name.
String	getUniqueId() Gets the unique id.
String	getUniqueName() Gets the unique name.
static boolean	isEncodedName(String value) Checks if given name is encoded.
void	setAppHome(String value) Sets the app home folder.
void	setAppRoot(String value) Sets the app root folder.
void	setClientAddr(String value) Sets the client address.
void	setClientHost(String value) Sets the client host name.
void	setUniqueId(String value) Sets the unique id.

Methods inherited from class Object

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

Field Detail

LOCAL_IP4

public static final String LOCAL_IP4

default LOCAL IP4.

See Also:

Constant Field Values

LOCAL_IP6

public static final String LOCAL_IP6

default LOCAL IP6.

See Also:

Constant Field Values

LOCAL_HOST

public static final String LOCAL_HOST

default LOCAL HOST.

See Also:

Constant Field Values

Constructor Detail

AppInfo

public AppInfo()

Instantiates a new AppInfo.

Method Detail

getEncodedFileName

public static final String getEncodedFileName(String name)

Gets the encoded file name.

Parameters:

name - the name

Returns:

the encoded file name

getEncodedName

public static final String getEncodedName(String name)

Gets the encoded name.

Parameters:

name - the name

Returns:

the encoded name

isEncodedName

public static final boolean isEncodedName(String value)

Checks if given name is encoded.

Parameters:

value - the value

Returns:

true, if given name is encoded

getAppHome

public String getAppHome()

Gets the app home folder.

Returns:

the app home folder

getAppRoot

public String getAppRoot()

Gets the app root folder.

Returns:

the app root folder

getClientAddr

public String getClientAddr()

Gets the client address. When app works in the client-server mode this is an ip address of the client's machine. In client or web modes it is a local machine ip address.

Returns:

the client address

getClientHost

public String getClientHost()

Gets the client host name. When app works in the client-server mode this is an host name of the client's machine. In client or web modes it is a local machine host name.

Returns:

the client host name

getUniqueId

public String getUniqueId()

Gets the unique id. In the client-server or web modes this is a user id.

Returns:

the unique id

getUniqueName

public String getUniqueName()

Gets the unique name. If unique id is set returns base64 encoded unique id, otherwise base64 encoded client's host name. The unique name is used to create user's specific home folders. For example if user 'abc' logged in into the app it's home folder will be getAppHome() + "/" + getUniqueName().

Returns:

the unique name

setAppHome

public void setAppHome(String value)

Sets the app home folder.

Parameters:

value - the new app home folder

setAppRoot

public void setAppRoot(String value)

Sets the app root folder.

Parameters:

value - the new app root

setClientAddr

public void setClientAddr(String value)

Sets the client address.

Parameters:

value - the new client address

setClientHost

public void setClientHost(String value)

Sets the client host name.

Parameters:

value - the new client host name

setUniqueId

public void setUniqueId(String value)

Sets the unique id. In the client-server or web modes this is a user id.

Parameters:

value - the new unique id