Package com.webmethods.portal.service.access

Interface IAclManager

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

  • Field Details

  • Method Details

    • 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