org.netxms.api.client.users

Interface UserManager

public interface UserManager

Interface for user management.

Field Summary

Fields

Modifier and Type	Field and Description
static int	USER_MODIFY_ACCESS_RIGHTS
static int	USER_MODIFY_AUTH_METHOD
static int	USER_MODIFY_CERT_MAPPING
static int	USER_MODIFY_CUSTOM_ATTRIBUTES
static int	USER_MODIFY_DESCRIPTION
static int	USER_MODIFY_FLAGS
static int	USER_MODIFY_FULL_NAME
static int	USER_MODIFY_GROUP_MEMBERSHIP
static int	USER_MODIFY_LOGIN_NAME
static int	USER_MODIFY_MEMBERS
static int	USER_MODIFY_PASSWD_LENGTH
static int	USER_MODIFY_TEMP_DISABLE
static int	USER_MODIFY_XMPP_ID

Method Summary

Methods

Modifier and Type	Method and Description
long	createUser(String name) Create user on server
long	createUserGroup(String name) Create user group on server
void	deleteUserDBObject(long id) Delete user or group on server
AbstractUserObject	findUserDBObjectById(long id) Find user by ID
AbstractUserObject[]	getUserDatabaseObjects() Get list of all user database objects
void	lockUserDatabase() Lock user database
void	modifyUserDBObject(AbstractUserObject object) Modify user database object
void	modifyUserDBObject(AbstractUserObject object, int fields) Modify user database object
void	setUserPassword(long id, String newPassword, String oldPassword) Set password for user
void	syncUserDatabase() Synchronize user database
void	unlockUserDatabase() Unlock user database

Field Detail

USER_MODIFY_LOGIN_NAME

static final int USER_MODIFY_LOGIN_NAME

See Also:

Constant Field Values

USER_MODIFY_DESCRIPTION

static final int USER_MODIFY_DESCRIPTION

See Also:

Constant Field Values

USER_MODIFY_FULL_NAME

static final int USER_MODIFY_FULL_NAME

See Also:

Constant Field Values

USER_MODIFY_FLAGS

static final int USER_MODIFY_FLAGS

See Also:

Constant Field Values

USER_MODIFY_ACCESS_RIGHTS

static final int USER_MODIFY_ACCESS_RIGHTS

See Also:

Constant Field Values

USER_MODIFY_MEMBERS

static final int USER_MODIFY_MEMBERS

See Also:

Constant Field Values

USER_MODIFY_CERT_MAPPING

static final int USER_MODIFY_CERT_MAPPING

See Also:

Constant Field Values

USER_MODIFY_AUTH_METHOD

static final int USER_MODIFY_AUTH_METHOD

See Also:

Constant Field Values

USER_MODIFY_PASSWD_LENGTH

static final int USER_MODIFY_PASSWD_LENGTH

See Also:

Constant Field Values

USER_MODIFY_TEMP_DISABLE

static final int USER_MODIFY_TEMP_DISABLE

See Also:

Constant Field Values

USER_MODIFY_CUSTOM_ATTRIBUTES

static final int USER_MODIFY_CUSTOM_ATTRIBUTES

See Also:

Constant Field Values

USER_MODIFY_XMPP_ID

static final int USER_MODIFY_XMPP_ID

See Also:

Constant Field Values

USER_MODIFY_GROUP_MEMBERSHIP

static final int USER_MODIFY_GROUP_MEMBERSHIP

See Also:

Constant Field Values

Method Detail

syncUserDatabase

void syncUserDatabase()
                      throws IOException,
                             NetXMSClientException

Synchronize user database

Throws:

IOException - if socket I/O error occurs

NXCException - if NetXMS server returns an error or operation was timed out

NetXMSClientException

findUserDBObjectById

AbstractUserObject findUserDBObjectById(long id)

Find user by ID

Returns:

User object with given ID or null if such user does not exist

getUserDatabaseObjects

AbstractUserObject[] getUserDatabaseObjects()

Get list of all user database objects

Returns:

List of all user database objects

createUser

long createUser(String name)
                throws IOException,
                       NetXMSClientException

Create user on server

Parameters:

name - Login name for new user

Returns:

ID assigned to newly created user

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

createUserGroup

long createUserGroup(String name)
                     throws IOException,
                            NetXMSClientException

Create user group on server

Parameters:

name - Name for new user group

Returns:

ID assigned to newly created user group

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

deleteUserDBObject

void deleteUserDBObject(long id)
                        throws IOException,
                               NetXMSClientException

Delete user or group on server

Parameters:

id - User or group ID

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

setUserPassword

void setUserPassword(long id,
                   String newPassword,
                   String oldPassword)
                     throws IOException,
                            NetXMSClientException

Set password for user

Parameters:

id - User ID

newPassword - New password

oldPassword - Old password

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

modifyUserDBObject

void modifyUserDBObject(AbstractUserObject object,
                      int fields)
                        throws IOException,
                               NetXMSClientException

Modify user database object

Parameters:

user - User data

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

modifyUserDBObject

void modifyUserDBObject(AbstractUserObject object)
                        throws IOException,
                               NetXMSClientException

Modify user database object

Parameters:

user - User data

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

lockUserDatabase

void lockUserDatabase()
                      throws IOException,
                             NetXMSClientException

Lock user database

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

unlockUserDatabase

void unlockUserDatabase()
                        throws IOException,
                               NetXMSClientException

Unlock user database

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out