com.esri.arcgis.server
Interface IUserStore

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IUserStoreProxy

public interface IUserStore
extends java.io.Serializable

COM Interface 'IUserStore'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriServer.olb'

Description: 'An interface to access the user repository.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID85d81926_f224_480f_a0aa_576d87ee0363
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addUser(IUser pUser) Add a new user to the user store.
void	deleteUser(java.lang.String userName) Deletes a user account from the user store.
boolean	getAllUsers(java.lang.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(java.lang.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(java.lang.String userName, java.lang.String password) Validates the credentials of the user against the user store.

Field Detail

IID85d81926_f224_480f_a0aa_576d87ee0363

static final int IID85d81926_f224_480f_a0aa_576d87ee0363

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

testConnection

void testConnection(IPropertySet pProps)
                    throws java.io.IOException,
                           AutomationException

Tests the connection to the user store.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

void initialize(IPropertySet pProps)
                throws java.io.IOException,
                       AutomationException

Connects to a user store.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReadOnly

boolean isReadOnly()
                   throws java.io.IOException,
                          AutomationException

Tests the connection to the user store.

Returns:

The isReadOnly

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addUser

void addUser(IUser pUser)
             throws java.io.IOException,
                    AutomationException

Add a new user to the user store.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateUser

void updateUser(IUser pUser)
                throws java.io.IOException,
                       AutomationException

Updates a user account in the user store.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteUser

void deleteUser(java.lang.String userName)
                throws java.io.IOException,
                       AutomationException

Deletes a user account from the user store.

Parameters:

userName - The userName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUser

IUser getUser(java.lang.String userName)
              throws java.io.IOException,
                     AutomationException

Returns a user account from the user store.

Parameters:

userName - The userName (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalUsers

int getTotalUsers()
                  throws java.io.IOException,
                         AutomationException

Returns the total number of users in the user store.

Returns:

The totalUsers

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllUsers

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllUsersPaged

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validateUser

boolean validateUser(java.lang.String userName,
                     java.lang.String password)
                     throws java.io.IOException,
                            AutomationException

Validates the credentials of the user against the user store.

Parameters:

userName - The userName (in)

password - The password (in)

Returns:

The isValid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.