com.webmethods.portal.service.access

Interface IAclManager

public interface IAclManager

Interface which describes all permissions management operations on abstract set of resources

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IAclManager.AcePropertyDescriptor
static class	IAclManager.ResultColumnMetadata Describes metadata for search result columns

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLUMN_CREATED_BY
static String	COLUMN_CREATED_DATE
static String	COLUMN_INFO_ICON
static String	COLUMN_INFO_LINK
static String	COLUMN_INFO_NAME
static String	COLUMN_LAST_MODIFIED_BY
static String	COLUMN_LAST_MODIFIED_DATE
static String	COLUMN_RESOURCE_ICON
static String	COLUMN_RESOURCE_LINK
static String	COLUMN_RESOURCE_NAME
static String	TYPE_MWS_APPLICATIONS
static String	TYPE_MWS_OBJECT
static String	TYPE_MWS_SECURITYREALM
static String	TYPE_MWS_WORKSPACE
static String	TYPE_MWS_XTYPE
static String	TYPE_TASK

Method Summary

Modifier and Type	Method and Description
void	applyAceToResource(String resourceID, Ace ace, boolean recursive) Sets provided Ace on the resource
void	applyAuthSchemeToResource(String resourceID, String authSchemeID, boolean recursive) Sets authentication scheme on resource object
void	applyOwnerToResource(String resourceID, String principalID) Sets owner on resource object
void	applySecurityRealmToResource(String resourceID, String securityRealmID, boolean recursive) Sets a secrurity realm on resource object.
void	deleteAceFromResource(String resourceID, String principalID, boolean recursive) Removes given principal ACE from resource
String	getAceDisplayName(List<String> resourceIDs, Ace ace) Acl manager may provide a custom display name for a given ace
List<IAclManager.AcePropertyDescriptor>	getAcePropertyDescriptors(List<String> resourceIDs) Returns metadata about ace structure for given set of resources
List<String>	getAcePropertyNames(List<String> resourceIDs) Returns list of valid ACE names defined for this resource type and given set of resources
AceSet	getAceSetForResource(String resourceID)
IAclResource	getAclResource(String resourceID) Returns a single acl resource by its ID
String	getName() Returns a friendly (localized) display name for this manager implementation
String	getPermissionsEditViewName() Returns .view file name which should be used to edit permissions for this resource type.
String	getRefineSearchViewName() Returns .view file name that is used for refine search fields.
String	getResourceAuthScheme(String resourceID) Retrieves an auth scheme assigned to resource object
String	getResourceOwner(String resourceID) Returns owner for the resource
String	getResourceSecurityRealm(String resourceID) Retrieves a security realm assigned to an object
String	getResourceType() Returns identifier of resource type managed by this manager implementation
Map<String,IAclManager.ResultColumnMetadata>	getResultColumnMetadata() Returns metadata about search result set
boolean	isCanSetPermissions(String resourceID) Returns true if current user can set permissions on a given resource
boolean	isCanSetRecursive() Returns true if supports setting recursive permissions on a resource
boolean	isSupportAuthScheme() If given acl manager supports authentication scheme for resource
boolean	isSupportSearch() Whether this acl manager support searching for resources
boolean	isSupportSecurityRealm() If given acl manager supports security realms on resource object
boolean	isSupportSetOwner() If given acl manager supports owner setting for resource
void	release() Releases any resources associated with this acl manager
List<IAclResource>	searchResources(Map<String,Object> refineFields, int maxResults) Searches and returns list of resources of given type matching specified query
void	setResourceType(String resourceType)
void	setUserID(String userID)

Field Detail

TYPE_TASK

static final String TYPE_TASK

See Also:

Constant Field Values

TYPE_MWS_APPLICATIONS

static final String TYPE_MWS_APPLICATIONS

See Also:

Constant Field Values

TYPE_MWS_OBJECT

static final String TYPE_MWS_OBJECT

See Also:

Constant Field Values

TYPE_MWS_SECURITYREALM

static final String TYPE_MWS_SECURITYREALM

See Also:

Constant Field Values

TYPE_MWS_WORKSPACE

static final String TYPE_MWS_WORKSPACE

See Also:

Constant Field Values

TYPE_MWS_XTYPE

static final String TYPE_MWS_XTYPE

See Also:

Constant Field Values

COLUMN_RESOURCE_ICON

static final String COLUMN_RESOURCE_ICON

See Also:

Constant Field Values

COLUMN_RESOURCE_NAME

static final String COLUMN_RESOURCE_NAME

See Also:

Constant Field Values

COLUMN_RESOURCE_LINK

static final String COLUMN_RESOURCE_LINK

See Also:

Constant Field Values

COLUMN_INFO_ICON

static final String COLUMN_INFO_ICON

See Also:

Constant Field Values

COLUMN_INFO_NAME

static final String COLUMN_INFO_NAME

See Also:

Constant Field Values

COLUMN_INFO_LINK

static final String COLUMN_INFO_LINK

See Also:

Constant Field Values

COLUMN_CREATED_DATE

static final String COLUMN_CREATED_DATE

See Also:

Constant Field Values

COLUMN_CREATED_BY

static final String COLUMN_CREATED_BY

See Also:

Constant Field Values

COLUMN_LAST_MODIFIED_DATE

static final String COLUMN_LAST_MODIFIED_DATE

See Also:

Constant Field Values

COLUMN_LAST_MODIFIED_BY

static final String COLUMN_LAST_MODIFIED_BY

See Also:

Constant Field Values

Method Detail

isSupportSearch

boolean isSupportSearch()

Whether this acl manager support searching for resources

getResourceType

String getResourceType()

Returns identifier of resource type managed by this manager implementation

getName

String getName()
        throws Exception

Returns a friendly (localized) display name for this manager implementation

Throws:

Exception

getRefineSearchViewName

String getRefineSearchViewName()

Returns .view file name that is used for refine search fields. If null is returned then default refine fields view will be used

getPermissionsEditViewName

String getPermissionsEditViewName()

Returns .view file name which should be used to edit permissions for this resource type. If null is returned then default edit permissions view will be used

getResultColumnMetadata

Map<String,IAclManager.ResultColumnMetadata> getResultColumnMetadata()

Returns metadata about search result set

getAcePropertyNames

List<String> getAcePropertyNames(List<String> resourceIDs)
                          throws Exception

Returns list of valid ACE names defined for this resource type and given set of resources

Throws:

Exception

getAceDisplayName

String getAceDisplayName(List<String> resourceIDs,
                         Ace ace)
                  throws Exception

Acl manager may provide a custom display name for a given ace

Throws:

Exception

getAcePropertyDescriptors

List<IAclManager.AcePropertyDescriptor> getAcePropertyDescriptors(List<String> resourceIDs)
                                                           throws Exception

Returns metadata about ace structure for given set of resources

Throws:

Exception

searchResources

List<IAclResource> searchResources(Map<String,Object> refineFields,
                                   int maxResults)
                            throws Exception

Searches and returns list of resources of given type matching specified query

Throws:

Exception

getAclResource

IAclResource getAclResource(String resourceID)
                     throws Exception

Returns a single acl resource by its ID

Parameters:

resourceID -

Throws:

Exception

deleteAceFromResource

void deleteAceFromResource(String resourceID,
                           String principalID,
                           boolean recursive)
                    throws Exception

Removes given principal ACE from resource

Throws:

Exception

applyAceToResource

void applyAceToResource(String resourceID,
                        Ace ace,
                        boolean recursive)
                 throws Exception

Sets provided Ace on the resource

Throws:

Exception

getAceSetForResource

AceSet getAceSetForResource(String resourceID)
                     throws Exception

Throws:

Exception

isSupportAuthScheme

boolean isSupportAuthScheme()

If given acl manager supports authentication scheme for resource

isSupportSetOwner

boolean isSupportSetOwner()

If given acl manager supports owner setting for resource

applyOwnerToResource

void applyOwnerToResource(String resourceID,
                          String principalID)
                   throws Exception

Sets owner on resource object

Throws:

Exception

getResourceOwner

String getResourceOwner(String resourceID)
                 throws Exception

Returns owner for the resource

Throws:

Exception

applyAuthSchemeToResource

void applyAuthSchemeToResource(String resourceID,
                               String authSchemeID,
                               boolean recursive)
                        throws Exception

Sets authentication scheme on resource object

Throws:

Exception

getResourceAuthScheme

String getResourceAuthScheme(String resourceID)
                      throws Exception

Retrieves an auth scheme assigned to resource object

Throws:

Exception

isSupportSecurityRealm

boolean isSupportSecurityRealm()

If given acl manager supports security realms on resource object

applySecurityRealmToResource

void applySecurityRealmToResource(String resourceID,
                                  String securityRealmID,
                                  boolean recursive)
                           throws Exception

Sets a secrurity realm on resource object.

Throws:

Exception

getResourceSecurityRealm

String getResourceSecurityRealm(String resourceID)
                         throws Exception

Retrieves a security realm assigned to an object

Throws:

Exception

isCanSetPermissions

boolean isCanSetPermissions(String resourceID)
                     throws Exception

Returns true if current user can set permissions on a given resource

Throws:

Exception

isCanSetRecursive

boolean isCanSetRecursive()

Returns true if supports setting recursive permissions on a resource

release

void release()

Releases any resources associated with this acl manager

setResourceType

void setResourceType(String resourceType)

setUserID

void setUserID(String userID)
        throws Exception

Throws:

Exception