org.netxms.client
Class NXCUserDBObject

java.lang.Object
  org.netxms.client.NXCUserDBObject

Direct Known Subclasses:

NXCUser, NXCUserGroup

public abstract class NXCUserDBObject
extends java.lang.Object

Field Summary

static int	CANNOT_CHANGE_PASSWORD
static int	CHANGE_PASSWORD
protected java.util.Map<java.lang.String,java.lang.String>	customAttributes
static int	DELETED
protected java.lang.String	description
static int	DISABLED
protected int	flags
protected java.util.UUID	guid
protected long	id
static int	MODIFIED
protected java.lang.String	name
static int	OBJECT_ACCESS_ACK_ALARMS
static int	OBJECT_ACCESS_ACL
static int	OBJECT_ACCESS_CONTROL
static int	OBJECT_ACCESS_CREATE
static int	OBJECT_ACCESS_DELETE
static int	OBJECT_ACCESS_MODIFY
static int	OBJECT_ACCESS_PUSH_DATA
static int	OBJECT_ACCESS_READ
static int	OBJECT_ACCESS_READ_ALARMS
static int	OBJECT_ACCESS_SEND_EVENTS
static int	OBJECT_ACCESS_TERM_ALARMS
static int	SYSTEM_ACCESS_CONFIGURE_TRAPS
static int	SYSTEM_ACCESS_DELETE_ALARMS
static int	SYSTEM_ACCESS_EDIT_EVENT_DB
static int	SYSTEM_ACCESS_EPP
static int	SYSTEM_ACCESS_MANAGE_ACTIONS
static int	SYSTEM_ACCESS_MANAGE_AGENT_CFG
static int	SYSTEM_ACCESS_MANAGE_MAPS
static int	SYSTEM_ACCESS_MANAGE_PACKAGES
static int	SYSTEM_ACCESS_MANAGE_SCRIPTS
static int	SYSTEM_ACCESS_MANAGE_SESSIONS
static int	SYSTEM_ACCESS_MANAGE_SITUATIONS
static int	SYSTEM_ACCESS_MANAGE_TOOLS
static int	SYSTEM_ACCESS_MANAGE_USERS
static int	SYSTEM_ACCESS_READ_FILES
static int	SYSTEM_ACCESS_REGISTER_AGENTS
static int	SYSTEM_ACCESS_SEND_SMS
static int	SYSTEM_ACCESS_SERVER_CONFIG
static int	SYSTEM_ACCESS_VIEW_EVENT_DB
static int	SYSTEM_ACCESS_VIEW_TRAP_LOG
protected int	systemRights

Constructor Summary

protected	NXCUserDBObject(NXCPMessage msg) Create object from NXCP message
	NXCUserDBObject(NXCUserDBObject src) Copy constructor
	NXCUserDBObject(java.lang.String name) Default constructor

Method Summary

java.lang.Object	clone()
void	fillMessage(NXCPMessage msg) Fill NXCP message with object data
java.lang.String	getCustomAttribute(java.lang.String name) Get custom attribute
java.lang.String	getDescription()
int	getFlags()
java.util.UUID	getGuid()
long	getId()
java.lang.String	getName()
int	getSystemRights()
boolean	isDeleted()
boolean	isDisabled() Check if object is disabled
boolean	isPasswordChangeForbidden() Check if password change is forbidden
boolean	isPasswordChangeNeeded() Check if password should be changed at next logon
void	setCustomAttribute(java.lang.String name, java.lang.String value) Set custom attribute's value
void	setDescription(java.lang.String description)
void	setFlags(int flags)
void	setId(long id)
void	setName(java.lang.String name)
void	setSystemRights(int systemRights)

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_ACCESS_MANAGE_USERS

public static final int SYSTEM_ACCESS_MANAGE_USERS

See Also:

Constant Field Values

SYSTEM_ACCESS_SERVER_CONFIG

public static final int SYSTEM_ACCESS_SERVER_CONFIG

See Also:

Constant Field Values

SYSTEM_ACCESS_CONFIGURE_TRAPS

public static final int SYSTEM_ACCESS_CONFIGURE_TRAPS

See Also:

Constant Field Values

SYSTEM_ACCESS_MANAGE_SESSIONS

public static final int SYSTEM_ACCESS_MANAGE_SESSIONS

See Also:

Constant Field Values

SYSTEM_ACCESS_VIEW_EVENT_DB

public static final int SYSTEM_ACCESS_VIEW_EVENT_DB

See Also:

Constant Field Values

SYSTEM_ACCESS_EDIT_EVENT_DB

public static final int SYSTEM_ACCESS_EDIT_EVENT_DB

See Also:

Constant Field Values

SYSTEM_ACCESS_EPP

public static final int SYSTEM_ACCESS_EPP

See Also:

Constant Field Values

SYSTEM_ACCESS_MANAGE_ACTIONS

public static final int SYSTEM_ACCESS_MANAGE_ACTIONS

See Also:

Constant Field Values

SYSTEM_ACCESS_DELETE_ALARMS

public static final int SYSTEM_ACCESS_DELETE_ALARMS

See Also:

Constant Field Values

SYSTEM_ACCESS_MANAGE_PACKAGES

public static final int SYSTEM_ACCESS_MANAGE_PACKAGES

See Also:

Constant Field Values

SYSTEM_ACCESS_MANAGE_TOOLS

public static final int SYSTEM_ACCESS_MANAGE_TOOLS

See Also:

Constant Field Values

SYSTEM_ACCESS_MANAGE_SCRIPTS

public static final int SYSTEM_ACCESS_MANAGE_SCRIPTS

See Also:

Constant Field Values

SYSTEM_ACCESS_VIEW_TRAP_LOG

public static final int SYSTEM_ACCESS_VIEW_TRAP_LOG

See Also:

Constant Field Values

SYSTEM_ACCESS_MANAGE_AGENT_CFG

public static final int SYSTEM_ACCESS_MANAGE_AGENT_CFG

See Also:

Constant Field Values

SYSTEM_ACCESS_MANAGE_SITUATIONS

public static final int SYSTEM_ACCESS_MANAGE_SITUATIONS

See Also:

Constant Field Values

SYSTEM_ACCESS_SEND_SMS

public static final int SYSTEM_ACCESS_SEND_SMS

See Also:

Constant Field Values

SYSTEM_ACCESS_MANAGE_MAPS

public static final int SYSTEM_ACCESS_MANAGE_MAPS

See Also:

Constant Field Values

SYSTEM_ACCESS_REGISTER_AGENTS

public static final int SYSTEM_ACCESS_REGISTER_AGENTS

See Also:

Constant Field Values

SYSTEM_ACCESS_READ_FILES

public static final int SYSTEM_ACCESS_READ_FILES

See Also:

Constant Field Values

OBJECT_ACCESS_READ

public static final int OBJECT_ACCESS_READ

See Also:

Constant Field Values

OBJECT_ACCESS_MODIFY

public static final int OBJECT_ACCESS_MODIFY

See Also:

Constant Field Values

OBJECT_ACCESS_CREATE

public static final int OBJECT_ACCESS_CREATE

See Also:

Constant Field Values

OBJECT_ACCESS_DELETE

public static final int OBJECT_ACCESS_DELETE

See Also:

Constant Field Values

OBJECT_ACCESS_READ_ALARMS

public static final int OBJECT_ACCESS_READ_ALARMS

See Also:

Constant Field Values

OBJECT_ACCESS_ACL

public static final int OBJECT_ACCESS_ACL

See Also:

Constant Field Values

OBJECT_ACCESS_ACK_ALARMS

public static final int OBJECT_ACCESS_ACK_ALARMS

See Also:

Constant Field Values

OBJECT_ACCESS_SEND_EVENTS

public static final int OBJECT_ACCESS_SEND_EVENTS

See Also:

Constant Field Values

OBJECT_ACCESS_CONTROL

public static final int OBJECT_ACCESS_CONTROL

See Also:

Constant Field Values

OBJECT_ACCESS_TERM_ALARMS

public static final int OBJECT_ACCESS_TERM_ALARMS

See Also:

Constant Field Values

OBJECT_ACCESS_PUSH_DATA

public static final int OBJECT_ACCESS_PUSH_DATA

See Also:

Constant Field Values

MODIFIED

public static final int MODIFIED

See Also:

Constant Field Values

DELETED

public static final int DELETED

See Also:

Constant Field Values

DISABLED

public static final int DISABLED

See Also:

Constant Field Values

CHANGE_PASSWORD

public static final int CHANGE_PASSWORD

See Also:

Constant Field Values

CANNOT_CHANGE_PASSWORD

public static final int CANNOT_CHANGE_PASSWORD

See Also:

Constant Field Values

id

protected long id

name

protected java.lang.String name

guid

protected java.util.UUID guid

systemRights

protected int systemRights

flags

protected int flags

description

protected java.lang.String description

customAttributes

protected java.util.Map<java.lang.String,java.lang.String> customAttributes

Constructor Detail

NXCUserDBObject

public NXCUserDBObject(java.lang.String name)

Default constructor

NXCUserDBObject

public NXCUserDBObject(NXCUserDBObject src)

Copy constructor

NXCUserDBObject

protected NXCUserDBObject(NXCPMessage msg)

Create object from NXCP message

Parameters:

msg - Message containing object's data

Method Detail

fillMessage

public void fillMessage(NXCPMessage msg)

Fill NXCP message with object data

isDeleted

public boolean isDeleted()

Returns:

true if user is marked as deleted

getId

public long getId()

Returns:

the id

setId

public void setId(long id)

Parameters:

id - the id to set

getName

public java.lang.String getName()

Returns:

the name

setName

public void setName(java.lang.String name)

Parameters:

name - the name to set

getGuid

public java.util.UUID getGuid()

Returns:

the guid

getSystemRights

public int getSystemRights()

Returns:

the systemRights

setSystemRights

public void setSystemRights(int systemRights)

Parameters:

systemRights - the systemRights to set

getFlags

public int getFlags()

Returns:

the flags

setFlags

public void setFlags(int flags)

Parameters:

flags - the flags to set

getDescription

public java.lang.String getDescription()

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description to set

getCustomAttribute

public java.lang.String getCustomAttribute(java.lang.String name)

Get custom attribute

Parameters:

name - Name of the attribute

setCustomAttribute

public void setCustomAttribute(java.lang.String name,
                               java.lang.String value)

Set custom attribute's value

Parameters:

name - Name of the attribute

value - New value for attribute

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

isDisabled

public boolean isDisabled()

Check if object is disabled

Returns:

true if object is disabled

isPasswordChangeNeeded

public boolean isPasswordChangeNeeded()

Check if password should be changed at next logon

Returns:

true if password should be changed at next logon

isPasswordChangeForbidden

public boolean isPasswordChangeForbidden()

Check if password change is forbidden

Returns:

true if password change is forbidden