com.novell.db.object.bean
Class UserSessionBean

java.lang.Object
  com.novell.sentinel.client.bean.SentinelBean
      com.novell.db.object.bean.UserSessionBean

public class UserSessionBean
extends SentinelBean

An automatically-generated "bean" class for the Sentinel data object type 'user-session'.

The description of the type is:

"A UserSession object contains information about a currently-authenticated user in the Sentinel system."

The Sentinel data object bean classes are designed to be used to transport data to and from the Sentinel server. There exists a supporting infrastructure that handles the serialization/parsing of the data to/from the JSON transport format and which handles the actual HTTP transport.

A more complete description of Sentinel data object beans is found in the description of SentinelBean.

See Also:

SentinelBean, BeanTransporter

Field Summary

static String	IP The "bean name" of the Sentinel data object field 'IP'.
static String	OSUSERNAME The "bean name" of the Sentinel data object field 'OSUsername'.
static String	REL_USER The "bean name" of the Sentinel data object field 'User'.
static String	SESSIONSTART The "bean name" of the Sentinel data object field 'SessionStart'.
static String	SESSIONTYPE The "bean name" of the Sentinel data object field 'SessionType'.
static String	USERNAME The "bean name" of the Sentinel data object field 'Username'.

Constructor Summary

	UserSessionBean() Construct an instance of the bean class.
protected	UserSessionBean(BeanMetaData<? extends SentinelBean> metadata) Constructor for use by derived classes.

Method Summary

void	clearIP() Clear any current value for the 'address' field in the bean.
void	clearOSUsername() Clear any current value for the 'os-name' field in the bean.
void	clearSessionStart() Clear any current value for the 'start' field in the bean.
void	clearSessionType() Clear any current value for the 'session-type' field in the bean.
void	clearUserLink() Clear any current URL value for the 'user' field in the bean.
void	clearUsername() Clear any current value for the 'name' field in the bean.
UserSessionBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends UserSessionBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getIP() Get the value for the 'address' field.
String	getOSUsername() Get the value for the 'os-name' field.
Date	getSessionStart() Get the value for the 'start' field.
String	getSessionType() Get the value for the 'session-type' field.
String	getUserLink() Get the URL for the 'user' field.
String	getUsername() Get the value for the 'name' field.
boolean	isIPClear() Get whether the value for the 'address' field is clear or not.
boolean	isIPNull() Get whether the 'address' field has been set to Null or not.
boolean	isOSUsernameClear() Get whether the value for the 'os-name' field is clear or not.
boolean	isOSUsernameNull() Get whether the 'os-name' field has been set to Null or not.
boolean	isSessionStartClear() Get whether the value for the 'start' field is clear or not.
boolean	isSessionStartNull() Get whether the 'start' field has been set to Null or not.
boolean	isSessionTypeClear() Get whether the value for the 'session-type' field is clear or not.
boolean	isSessionTypeNull() Get whether the 'session-type' field has been set to Null or not.
boolean	isUserLinkClear() Get whether the value for the 'user' URL field is clear or not.
boolean	isUserLinkNull() Get whether the 'user' URL field has been set to Null or not.
boolean	isUsernameClear() Get whether the value for the 'name' field is clear or not.
boolean	isUsernameNull() Get whether the 'name' field has been set to Null or not.
void	setIP(String iP) Set the value for the 'address' field.
void	setIPNull() Set to Null any current value for the 'address' field in the bean.
void	setOSUsername(String oSUsername) Set the value for the 'os-name' field.
void	setOSUsernameNull() Set to Null any current value for the 'os-name' field in the bean.
void	setSessionStart(Date sessionStart) Set the value for the 'start' field.
void	setSessionStartNull() Set to Null any current value for the 'start' field in the bean.
void	setSessionType(String sessionType) Set the value for the 'session-type' field.
void	setSessionTypeNull() Set to Null any current value for the 'session-type' field in the bean.
void	setUserLink(String user) Set a URL value for the 'user' field.
void	setUserLinkNull() Set to Null any current URL value for the 'user' field in the bean.
void	setUsername(String username) Set the value for the 'name' field.
void	setUsernameNull() Set to Null any current value for the 'name' field in the bean.

Methods inherited from class com.novell.sentinel.client.bean.SentinelBean

clearField, cloneBean, equals, fields, getBeanName, getBeanValue, getField, getFieldNoNull, getLink, getMetaData, isFieldClear, isFieldNull, isLinkClear, setField, setFieldNull, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SESSIONTYPE

public static final String SESSIONTYPE

The "bean name" of the Sentinel data object field 'SessionType'. The value is ""session-type"".

The description of the 'session-type' field is:

"The type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection."

See Also:

Constant Field Values

IP

public static final String IP

The "bean name" of the Sentinel data object field 'IP'. The value is ""address"".

The description of the 'address' field is:

"The IP address of the client system from which the user authenticated."

See Also:

Constant Field Values

USERNAME

public static final String USERNAME

The "bean name" of the Sentinel data object field 'Username'. The value is ""name"".

The description of the 'name' field is:

"The username of the account that is authenticated to the Sentinel system."

See Also:

Constant Field Values

REL_USER

public static final String REL_USER

The "bean name" of the Sentinel data object field 'User'. The value is ""user"".

The description of the 'user' field is:

"The URL of the Sentinel User object associated with the session object."

See Also:

Constant Field Values

OSUSERNAME

public static final String OSUSERNAME

The "bean name" of the Sentinel data object field 'OSUsername'. The value is ""os-name"".

The description of the 'os-name' field is:

"The username of the associated account on the client operation system. May not be present."

See Also:

Constant Field Values

SESSIONSTART

public static final String SESSIONSTART

The "bean name" of the Sentinel data object field 'SessionStart'. The value is ""start"".

The description of the 'start' field is:

"The starting date and time of the user session."

See Also:

Constant Field Values

Constructor Detail

UserSessionBean

public UserSessionBean()

Construct an instance of the bean class.

UserSessionBean

protected UserSessionBean(BeanMetaData<? extends SentinelBean> metadata)

Constructor for use by derived classes.

Parameters:

metadata - The metadata instance for the derived bean class. Normally this constructor will only be called by generated code.

Method Detail

getSessionType

public String getSessionType()

Get the value for the 'session-type' field. The description of the 'session-type' field is:

"The type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

SESSIONTYPE

isSessionTypeNull

public boolean isSessionTypeNull()

Get whether the 'session-type' field has been set to Null or not. The description of the 'session-type' field is:

"The type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setSessionTypeNull(), SESSIONTYPE

isSessionTypeClear

public boolean isSessionTypeClear()

Get whether the value for the 'session-type' field is clear or not. The description of the 'session-type' field is:

"The type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearSessionType(), SESSIONTYPE

setSessionType

public void setSessionType(String sessionType)

Set the value for the 'session-type' field. The description of the 'session-type' field is:

"The type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection."

Parameters:

sessionType - Value to set

See Also:

SESSIONTYPE

clearSessionType

public void clearSessionType()

Clear any current value for the 'session-type' field in the bean. The description of the 'session-type' field is:

"The type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection."

Using this method will not clear the server value when the bean is PUT to the server. Use the setSessionTypeNull() method to clear the server's value.

See the description of cleared values.

See Also:

SESSIONTYPE

setSessionTypeNull

public void setSessionTypeNull()

Set to Null any current value for the 'session-type' field in the bean. The description of the 'session-type' field is:

"The type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection."

Using this method will clear the server value when the bean is PUT to the server. Use the clearSessionType() method to avoid clearing the server's value.

See the description of Null values.

See Also:

SESSIONTYPE

getSessionStart

public Date getSessionStart()

Get the value for the 'start' field. The description of the 'start' field is:

"The starting date and time of the user session."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

SESSIONSTART

isSessionStartNull

public boolean isSessionStartNull()

Get whether the 'start' field has been set to Null or not. The description of the 'start' field is:

"The starting date and time of the user session."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setSessionStartNull(), SESSIONSTART

isSessionStartClear

public boolean isSessionStartClear()

Get whether the value for the 'start' field is clear or not. The description of the 'start' field is:

"The starting date and time of the user session."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearSessionStart(), SESSIONSTART

setSessionStart

public void setSessionStart(Date sessionStart)

Set the value for the 'start' field. The description of the 'start' field is:

"The starting date and time of the user session."

Parameters:

sessionStart - Value to set

See Also:

SESSIONSTART

clearSessionStart

public void clearSessionStart()

Clear any current value for the 'start' field in the bean. The description of the 'start' field is:

"The starting date and time of the user session."

Using this method will not clear the server value when the bean is PUT to the server. Use the setSessionStartNull() method to clear the server's value.

See the description of cleared values.

See Also:

SESSIONSTART

setSessionStartNull

public void setSessionStartNull()

Set to Null any current value for the 'start' field in the bean. The description of the 'start' field is:

"The starting date and time of the user session."

Using this method will clear the server value when the bean is PUT to the server. Use the clearSessionStart() method to avoid clearing the server's value.

See the description of Null values.

See Also:

SESSIONSTART

getIP

public String getIP()

Get the value for the 'address' field. The description of the 'address' field is:

"The IP address of the client system from which the user authenticated."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

IP

isIPNull

public boolean isIPNull()

Get whether the 'address' field has been set to Null or not. The description of the 'address' field is:

"The IP address of the client system from which the user authenticated."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setIPNull(), IP

isIPClear

public boolean isIPClear()

Get whether the value for the 'address' field is clear or not. The description of the 'address' field is:

"The IP address of the client system from which the user authenticated."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearIP(), IP

setIP

public void setIP(String iP)

Set the value for the 'address' field. The description of the 'address' field is:

"The IP address of the client system from which the user authenticated."

Parameters:

iP - Value to set

See Also:

IP

clearIP

public void clearIP()

Clear any current value for the 'address' field in the bean. The description of the 'address' field is:

"The IP address of the client system from which the user authenticated."

Using this method will not clear the server value when the bean is PUT to the server. Use the setIPNull() method to clear the server's value.

See the description of cleared values.

See Also:

IP

setIPNull

public void setIPNull()

Set to Null any current value for the 'address' field in the bean. The description of the 'address' field is:

"The IP address of the client system from which the user authenticated."

Using this method will clear the server value when the bean is PUT to the server. Use the clearIP() method to avoid clearing the server's value.

See the description of Null values.

See Also:

IP

getUsername

public String getUsername()

Get the value for the 'name' field. The description of the 'name' field is:

"The username of the account that is authenticated to the Sentinel system."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

USERNAME

isUsernameNull

public boolean isUsernameNull()

Get whether the 'name' field has been set to Null or not. The description of the 'name' field is:

"The username of the account that is authenticated to the Sentinel system."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setUsernameNull(), USERNAME

isUsernameClear

public boolean isUsernameClear()

Get whether the value for the 'name' field is clear or not. The description of the 'name' field is:

"The username of the account that is authenticated to the Sentinel system."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearUsername(), USERNAME

setUsername

public void setUsername(String username)

Set the value for the 'name' field. The description of the 'name' field is:

"The username of the account that is authenticated to the Sentinel system."

Parameters:

username - Value to set

See Also:

USERNAME

clearUsername

public void clearUsername()

Clear any current value for the 'name' field in the bean. The description of the 'name' field is:

"The username of the account that is authenticated to the Sentinel system."

Using this method will not clear the server value when the bean is PUT to the server. Use the setUsernameNull() method to clear the server's value.

See the description of cleared values.

See Also:

USERNAME

setUsernameNull

public void setUsernameNull()

Set to Null any current value for the 'name' field in the bean. The description of the 'name' field is:

"The username of the account that is authenticated to the Sentinel system."

Using this method will clear the server value when the bean is PUT to the server. Use the clearUsername() method to avoid clearing the server's value.

See the description of Null values.

See Also:

USERNAME

getOSUsername

public String getOSUsername()

Get the value for the 'os-name' field. The description of the 'os-name' field is:

"The username of the associated account on the client operation system. May not be present."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

OSUSERNAME

isOSUsernameNull

public boolean isOSUsernameNull()

Get whether the 'os-name' field has been set to Null or not. The description of the 'os-name' field is:

"The username of the associated account on the client operation system. May not be present."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setOSUsernameNull(), OSUSERNAME

isOSUsernameClear

public boolean isOSUsernameClear()

Get whether the value for the 'os-name' field is clear or not. The description of the 'os-name' field is:

"The username of the associated account on the client operation system. May not be present."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearOSUsername(), OSUSERNAME

setOSUsername

public void setOSUsername(String oSUsername)

Set the value for the 'os-name' field. The description of the 'os-name' field is:

"The username of the associated account on the client operation system. May not be present."

Parameters:

oSUsername - Value to set

See Also:

OSUSERNAME

clearOSUsername

public void clearOSUsername()

Clear any current value for the 'os-name' field in the bean. The description of the 'os-name' field is:

"The username of the associated account on the client operation system. May not be present."

Using this method will not clear the server value when the bean is PUT to the server. Use the setOSUsernameNull() method to clear the server's value.

See the description of cleared values.

See Also:

OSUSERNAME

setOSUsernameNull

public void setOSUsernameNull()

Set to Null any current value for the 'os-name' field in the bean. The description of the 'os-name' field is:

"The username of the associated account on the client operation system. May not be present."

Using this method will clear the server value when the bean is PUT to the server. Use the clearOSUsername() method to avoid clearing the server's value.

See the description of Null values.

See Also:

OSUSERNAME

getUserLink

public String getUserLink()

Get the URL for the 'user' field. The description of the 'user' field is:

"The URL of the Sentinel User object associated with the session object."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

REL_USER

isUserLinkNull

public boolean isUserLinkNull()

Get whether the 'user' URL field has been set to Null or not. The description of the 'user' field is:

"The URL of the Sentinel User object associated with the session object."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setUserLinkNull(), REL_USER

isUserLinkClear

public boolean isUserLinkClear()

Get whether the value for the 'user' URL field is clear or not. The description of the 'user' field is:

"The URL of the Sentinel User object associated with the session object."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearUserLink(), REL_USER

setUserLink

public void setUserLink(String user)

Set a URL value for the 'user' field. The description of the 'user' field is:

"The URL of the Sentinel User object associated with the session object."

Parameters:

user - Value to set

See Also:

REL_USER

clearUserLink

public void clearUserLink()

Clear any current URL value for the 'user' field in the bean. The description of the 'user' field is:

"The URL of the Sentinel User object associated with the session object."

Using this method will not clear the server value when the bean is PUT to the server. Use the setUserLinkNull() method to clear the server's value.

See the description of cleared values.

See Also:

REL_USER

setUserLinkNull

public void setUserLinkNull()

Set to Null any current URL value for the 'user' field in the bean. The description of the 'user' field is:

"The URL of the Sentinel User object associated with the session object."

Using this method will clear the server value when the bean is PUT to the server. Use the clearUserLink() method to avoid clearing the server's value.

See the description of Null values.

See Also:

REL_USER

getBeanMetaData

public static BeanMetaData<? extends UserSessionBean> getBeanMetaData()

Get the metadata class instance for this type.

The metadata is used primarily as a parameter to a BeanTransporter implementation''s constructor.

clone

public UserSessionBean clone()

Create a duplicate of this bean instance, including all field values.

Overrides:

clone in class Object