com.esri.arcgis.server
Interface IRoleStore

All Superinterfaces:

Serializable

public interface IRoleStore
extends Serializable

An interface to access the role repository.

Product Availability

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

Method Summary

void	addRole(IRole pRole) Add a new role to the role store.
void	addUsersToRole(String rolename, String[] usernames) Adds users to a role.
void	assignRoles(String userName, String[] rolenames) Assigns roles to a user.
void	deleteRole(String rolename) Deletes a role from role store.
boolean	getAllRoles(String filter, int maxCount, IRole[][] roles) Returns a maxCount of roles from the role store that match a particular filter.
boolean	getAllRolesPaged(int startIndex, int pageSize, IRole[][] roles) Returns a pageSize of roles from the role store from the startIndex.
IRole	getRole(String rolename) Returns a role from the role store.
boolean	getRolesForUser(String userName, String filter, int maxCount, String[][] rolenames) Returns roles assigned to a user that match a filter upto a maxCount number.
int	getTotalRoles() Returns the total number of roles in the role store.
boolean	getUsersWithinRole(String rolename, String filter, int maxCount, String[][] usernames) Returns users within a role that match a filter upto a maxCount number.
void	initialize(IPropertySet pProps) Connects to a role store.
boolean	isReadOnly() Tests the connection to the role store.
void	removeRoles(String userName, String[] rolenames) Removes roles assigned to a user.
void	removeUsersFromRole(String rolename, String[] usernames) Removes users from a role.
void	testConnection(IPropertySet pProps) Tests the connection to the role store.
void	updateRole(IRole pRole) Update an existing role in the role store.

Method Detail

testConnection

void testConnection(IPropertySet pProps)
                    throws IOException,
                           AutomationException

Tests the connection to the role 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 role 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 role 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.

addRole

void addRole(IRole pRole)
             throws IOException,
                    AutomationException

Add a new role to the role store.

Product Availability

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

Parameters:

pRole - A reference to a com.esri.arcgis.server.IRole (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateRole

void updateRole(IRole pRole)
                throws IOException,
                       AutomationException

Update an existing role in the role store.

Product Availability

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

Parameters:

pRole - A reference to a com.esri.arcgis.server.IRole (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteRole

void deleteRole(String rolename)
                throws IOException,
                       AutomationException

Deletes a role from role store.

Product Availability

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

Parameters:

rolename - The rolename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRole

IRole getRole(String rolename)
              throws IOException,
                     AutomationException

Returns a role from the role store.

Product Availability

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

Parameters:

rolename - The rolename (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalRoles

int getTotalRoles()
                  throws IOException,
                         AutomationException

Returns the total number of roles in the role store.

Product Availability

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

Returns:

The totalRoles

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllRoles

boolean getAllRoles(String filter,
                    int maxCount,
                    IRole[][] roles)
                    throws IOException,
                           AutomationException

Returns a maxCount of roles from the role 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)

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

Returns:

The hasMore

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllRolesPaged

boolean getAllRolesPaged(int startIndex,
                         int pageSize,
                         IRole[][] roles)
                         throws IOException,
                                AutomationException

Returns a pageSize of roles from the role store from the startIndex.

Product Availability

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

Parameters:

startIndex - The startIndex (in)

pageSize - The pageSize (in)

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

Returns:

The hasMore

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assignRoles

void assignRoles(String userName,
                 String[] rolenames)
                 throws IOException,
                        AutomationException

Assigns roles to a user.

Product Availability

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

Parameters:

userName - The userName (in)

rolenames - The rolenames (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeRoles

void removeRoles(String userName,
                 String[] rolenames)
                 throws IOException,
                        AutomationException

Removes roles assigned to a user.

Product Availability

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

Parameters:

userName - The userName (in)

rolenames - The rolenames (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRolesForUser

boolean getRolesForUser(String userName,
                        String filter,
                        int maxCount,
                        String[][] rolenames)
                        throws IOException,
                               AutomationException

Returns roles assigned to a user that match a filter upto a maxCount number.

Product Availability

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

Parameters:

userName - The userName (in)

filter - The filter (in)

maxCount - The maxCount (in)

rolenames - The rolenames (out: use single element array)

Returns:

The hasMore

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUsersWithinRole

boolean getUsersWithinRole(String rolename,
                           String filter,
                           int maxCount,
                           String[][] usernames)
                           throws IOException,
                                  AutomationException

Returns users within a role that match a filter upto a maxCount number.

Product Availability

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

Parameters:

rolename - The rolename (in)

filter - The filter (in)

maxCount - The maxCount (in)

usernames - The usernames (out: use single element array)

Returns:

The hasMore

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addUsersToRole

void addUsersToRole(String rolename,
                    String[] usernames)
                    throws IOException,
                           AutomationException

Adds users to a role.

Product Availability

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

Parameters:

rolename - The rolename (in)

usernames - The usernames (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeUsersFromRole

void removeUsersFromRole(String rolename,
                         String[] usernames)
                         throws IOException,
                                AutomationException

Removes users from a role.

Product Availability

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

Parameters:

rolename - The rolename (in)

usernames - The usernames (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.