com.esri.arcgis.server
Interface IPermissionsAdmin2

All Superinterfaces:

IPermissionsAdmin, Serializable

All Known Implementing Classes:

IPermissionsAdmin2Proxy, ServerObjectAdmin

public interface IPermissionsAdmin2
extends IPermissionsAdmin, Serializable

Provides administrative access to the Permissions Store.

Description

IPermissionsAdmin2 provides methods to Allow and Deny operations on ArcGIS for Server resources and to retrieve all principals with access to resources. Additionally, it provides a method to remove all permissions on all resources for a particular principal.

The IPermissionsAdmin2 interface can be obtained by a query interface with the IServerObjectAdmin interface.

Remarks

The following administration functionality of the ArcGIS Server is exposed by the methods of IPermissionsAdmin2:

Administer role-based ArcGIS Server security:

• Allow permissions on a resource.
• Deny permissions on a resource.
• Clean all allow/deny rules from all resources associated with a specific principal.

Get information about the ArcGIS Security mode:

• Get all principals that have any Allow/Deny rules on any resource.

When To Use

Use the IPermissionsAdmin2 interface when your application needs to clear all permissions on all resources for a specific principal.

If your application is connecting to the server only to retrieve information about the current state of permissions on ArcGIS for Server GIS resources, use the IPermissionsManager interface instead.

Product Availability

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

Method Summary

void	cleanPermissions(String principal) Removes all permissions for a particular principal.

Methods inherited from interface com.esri.arcgis.server.IPermissionsAdmin

allowPermission, denyPermission, getAllPrincipals

Method Detail

cleanPermissions

void cleanPermissions(String principal)
                      throws IOException,
                             AutomationException

Removes all permissions for a particular principal.

Remarks

Use the CleanPermissions method to delete all allow/deny rules from all resources associated with the specified principal.

Product Availability

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

Parameters:

principal - The principal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.