com.esri.arcgis.server
Interface IUserStore

All Superinterfaces:

Serializable

public interface IUserStore
extends Serializable

An interface to access the user repository.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	addUser(IUser pUser) Add a new user to the user store.
void	deleteUser(String userName) Deletes a user account from the user store.
boolean	getAllUsers(String filter, int maxCount, IUser[][] users) Returns a maxCount of users from the user store that match a particular filter.
boolean	getAllUsersPaged(int startIndex, int pageSize, IUser[][] users) Returns a pageSize of users from the user store from the startIndex.
int	getTotalUsers() Returns the total number of users in the user store.
IUser	getUser(String userName) Returns a user account from the user store.
void	initialize(IPropertySet pProps) Connects to a user store.
boolean	isReadOnly() Tests the connection to the user store.
void	testConnection(IPropertySet pProps) Tests the connection to the user store.
void	updateUser(IUser pUser) Updates a user account in the user store.
boolean	validateUser(String userName, String password) Validates the credentials of the user against the user store.

Method Detail

testConnection

void testConnection(IPropertySet pProps)
                    throws IOException,
                           AutomationException

Tests the connection to the user store.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

void initialize(IPropertySet pProps)
                throws IOException,
                       AutomationException

Connects to a user store.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReadOnly

boolean isReadOnly()
                   throws IOException,
                          AutomationException

Tests the connection to the user store.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The isReadOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addUser

void addUser(IUser pUser)
             throws IOException,
                    AutomationException

Add a new user to the user store.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pUser - A reference to a com.esri.arcgis.server.IUser (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateUser

void updateUser(IUser pUser)
                throws IOException,
                       AutomationException

Updates a user account in the user store.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pUser - A reference to a com.esri.arcgis.server.IUser (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteUser

void deleteUser(String userName)
                throws IOException,
                       AutomationException

Deletes a user account from the user store.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

userName - The userName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUser

IUser getUser(String userName)
              throws IOException,
                     AutomationException

Returns a user account from the user store.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

userName - The userName (in)

Returns:

A reference to a com.esri.arcgis.server.IUser

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalUsers

int getTotalUsers()
                  throws IOException,
                         AutomationException

Returns the total number of users in the user store.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The totalUsers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllUsers

boolean getAllUsers(String filter,
                    int maxCount,
                    IUser[][] users)
                    throws IOException,
                           AutomationException

Returns a maxCount of users from the user store that match a particular filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

filter - The filter (in)

maxCount - The maxCount (in)

users - A reference to a com.esri.arcgis.server.IUser array (out: use single element array)

Returns:

The hasMore

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllUsersPaged

boolean getAllUsersPaged(int startIndex,
                         int pageSize,
                         IUser[][] users)
                         throws IOException,
                                AutomationException

Returns a pageSize of users from the user store from the startIndex.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

startIndex - The startIndex (in)

pageSize - The pageSize (in)

users - A reference to a com.esri.arcgis.server.IUser array (out: use single element array)

Returns:

The hasMore

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validateUser

boolean validateUser(String userName,
                     String password)
                     throws IOException,
                            AutomationException

Validates the credentials of the user against the user store.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

userName - The userName (in)

password - The password (in)

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.