org.netxms.api.client.users
Interface UserManager


public interface UserManager

Interface for user management.


Field Summary
static int USER_MODIFY_ACCESS_RIGHTS
           
static int USER_MODIFY_AUTH_METHOD
           
static int USER_MODIFY_CERT_MAPPING
           
static int USER_MODIFY_DESCRIPTION
           
static int USER_MODIFY_FLAGS
           
static int USER_MODIFY_FULL_NAME
           
static int USER_MODIFY_LOGIN_NAME
           
static int USER_MODIFY_MEMBERS
           
 
Method Summary
 long createUser(java.lang.String name)
          Create user on server
 long createUserGroup(java.lang.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, java.lang.String newPassword, java.lang.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
Method Detail

syncUserDatabase

void syncUserDatabase()
                      throws java.io.IOException,
                             NetXMSClientException
Synchronize user database

Throws:
java.io.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(java.lang.String name)
                throws java.io.IOException,
                       NetXMSClientException
Create user on server

Parameters:
name - Login name for new user
Returns:
ID assigned to newly created user
Throws:
java.io.IOException - if socket I/O error occurs
NetXMSClientException - if NetXMS server returns an error or operation was timed out

createUserGroup

long createUserGroup(java.lang.String name)
                     throws java.io.IOException,
                            NetXMSClientException
Create user group on server

Parameters:
name - Name for new user group
Returns:
ID assigned to newly created user group
Throws:
java.io.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 java.io.IOException,
                               NetXMSClientException
Delete user or group on server

Parameters:
id - User or group ID
Throws:
java.io.IOException - if socket I/O error occurs
NetXMSClientException - if NetXMS server returns an error or operation was timed out

setUserPassword

void setUserPassword(long id,
                     java.lang.String newPassword,
                     java.lang.String oldPassword)
                     throws java.io.IOException,
                            NetXMSClientException
Set password for user

Parameters:
id - User ID
newPassword - New password
oldPassword - Old password
Throws:
java.io.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 java.io.IOException,
                               NetXMSClientException
Modify user database object

Parameters:
user - User data
Throws:
java.io.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 java.io.IOException,
                               NetXMSClientException
Modify user database object

Parameters:
user - User data
Throws:
java.io.IOException - if socket I/O error occurs
NetXMSClientException - if NetXMS server returns an error or operation was timed out

lockUserDatabase

void lockUserDatabase()
                      throws java.io.IOException,
                             NetXMSClientException
Lock user database

Throws:
java.io.IOException - if socket I/O error occurs
NetXMSClientException - if NetXMS server returns an error or operation was timed out

unlockUserDatabase

void unlockUserDatabase()
                        throws java.io.IOException,
                               NetXMSClientException
Unlock user database

Throws:
java.io.IOException - if socket I/O error occurs
NetXMSClientException - if NetXMS server returns an error or operation was timed out


Copyright © 2011. All Rights Reserved.