Project: stp

com.ibm.rational.wvcm.stp.cc
Interface CcPolicy

All Superinterfaces:
CcResource, CcTypeBase, CcVobResource, Resource, StpResource

public interface CcPolicy
extends CcTypeBase

A proxy for a ClearCase policy.

A policy has an Access Control List (ACL) for each controlled VOB metatype (such as UCM project, branch type, element). The entries in a policy list a principal and its granted permissions. Principals in a policy are usually roles, with the name of the role defined by the ClearCase administrator. You can also put in specific users or groups as well, but we recommend putting them into the rolemaps implementing the policy.

Each ACL-enabled VOB has a default policy named DefaultPolicy. This default policy grants the VOB owner full access; nobody else has any access.


Nested Class Summary
 
Nested classes/interfaces inherited from interface CcTypeBase
CcTypeBase.InstanceConstraint, CcTypeBase.Scope, CcTypeBase.TypeCreateFlag
 
Nested classes/interfaces inherited from interface CcVobResource
CcVobResource.ApplyAttributeFlag
 
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpResource
StpResource.UnsupportedProperty
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Field Summary
static PropertyNameList.PropertyName<Map<String,List<CcAccessControlEntry>>> ACL_MAP
          Map of names of VOB object proxy types to lists of access control entries which make up the permissions template this policy will apply to a rolemap.
static PropertyNameList.PropertyName<ResourceList<CcRolemap>> ROLEMAP_LIST
          List of rolemaps which implement this policy.
 
Fields inherited from interface CcTypeBase
HAS_SHARED_MASTERSHIP, INSTANCE_CONSTRAINT, SCOPE
 
Fields inherited from interface CcVobResource
ATTRIBUTE_LIST, CC_MASTER_REPLICA, CURRENT_REPLICA, EFFECTIVE_ACL, HAS_LOCAL_MASTERSHIP, HYPERLINK_LIST, LOCK_INFO, MY_EFFECTIVE_ACCESS, MY_EFFECTIVE_ACL, PERMISSIONS, ROLEMAP, VOB
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpResource
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
 
Fields inherited from interface javax.wvcm.Resource
ALL_CUSTOM_PROPERTIES, COMMENT, CONTENT_CHARACTER_SET, CONTENT_IDENTIFIER, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CREATION_DATE, CREATOR_DISPLAY_NAME, DISPLAY_NAME, IS_EXECUTABLE, LAST_MODIFIED, PARENT_LIST, PATHNAME_LOCATION, PROVIDER_LIST, RESOURCE_IDENTIFIER, WORKSPACE_FOLDER_LIST
 
Method Summary
 CcPolicy doCreateCcPolicy(CcTypeBase.TypeCreateFlag[] flags, Feedback feedback)
           Create a new policy at the location specified by this proxy.
 CcPolicy doModifyCcPolicy(CcTypeBase.TypeCreateFlag[] flags, Feedback feedback)
           Modify an existing policy at the location specified by this proxy.
 Map<String,List<CcAccessControlEntry>> getAclMap()
          Get the value of this resource's ACL_MAP property.
 ResourceList<CcRolemap> getRolemapList()
          Get the value of this resource's ROLEMAP_LIST property.
 void setAclMap(Map<String,List<CcAccessControlEntry>> aclMap)
          Set the value of this proxy's ACL_MAP property.
 
Methods inherited from interface CcTypeBase
getHasSharedMastership, getInstanceConstraint, getScope, setHasSharedMastership, setInstanceConstraint, setScope
 
Methods inherited from interface CcVobResource
doApplyAttribute, doApplyRolemap, doRemoveAttribute, doRequestForMastership, getAttributeList, getCurrentReplica, getEffectiveAcl, getHasLocalMastership, getHyperlinkList, getLockInfo, getMasterReplica, getMyEffectiveAccess, getMyEffectiveAcl, getPermissions, getRolemap, getVob, setLockInfo, setPermissions
 
Methods inherited from interface CcResource
ccProvider, doResolve, hasSupportedProperties, isResolved
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCreatorGroupName, getCreatorLoginName, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, stpLocation, stpProvider
 
Methods inherited from interface javax.wvcm.Resource
doCopy, doFind, doFindAll, doGetPropertyNameList, doGetPropertyNameList, doReadContent, doReadProperties, doUnbindAll, doWriteContent, doWriteProperties, forgetProperty, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getDisplayName, getIsExecutable, getLastModified, getParentList, getPathnameLocation, getProperty, getProviderList, getWorkspaceFolderList, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setIsExecutable, setProperty, setProperty, updatedPropertyNameList
 

Field Detail

ACL_MAP

static final PropertyNameList.PropertyName<Map<String,List<CcAccessControlEntry>>> ACL_MAP
Map of names of VOB object proxy types to lists of access control entries which make up the permissions template this policy will apply to a rolemap.


ROLEMAP_LIST

static final PropertyNameList.PropertyName<ResourceList<CcRolemap>> ROLEMAP_LIST
List of rolemaps which implement this policy.

Method Detail

doCreateCcPolicy

CcPolicy doCreateCcPolicy(CcTypeBase.TypeCreateFlag[] flags,
                          Feedback feedback)
                          throws WvcmException

Create a new policy at the location specified by this proxy. The location should be an object name selector specifying the policy's name and the repository (VOB) in which to create it.

Set the optional ACL_MAP property to specify the principals and access allowed for the proxy types in this policy. If this property is not set, the policy will not provide any permissions.

You may optionally set the following additional properties prior to calling this method:
  • Resource.COMMENT
  • CcTypeBase.SCOPE (Not yet supported.)

    Parameters:
    flags - Resource-specific creation flags. (The ACQUIRE flag is not yet supported.)
    Throws:
    WvcmException

  • doModifyCcPolicy

    CcPolicy doModifyCcPolicy(CcTypeBase.TypeCreateFlag[] flags,
                              Feedback feedback)
                              throws WvcmException

    Modify an existing policy at the location specified by this proxy. The location should be an object name selector specifying the policy's name and the repository (VOB) in which to create it.

    Set the optional ACL_MAP property to modify the principals and access allowed for the proxy types in this policy. If not specified, the existing map will not be changed.

    You may optionally set the following additional properties prior to calling this method:
  • Resource.COMMENT Provides a comment for the policy modification, without overriding the creation comment.
  • Parameters:
    flags - Resource-specific creation flags. (The ACQUIRE flag is not yet supported.)
    Throws:
    WvcmException

    getAclMap

    Map<String,List<CcAccessControlEntry>> getAclMap()
                                                     throws WvcmException
    Get the value of this resource's ACL_MAP property.

    Returns:
    Map of names of VOB object proxy types to lists of access control entries which make up the effective ACLs that this policy would generate when combined with a rolemap and applied to VOB objects.
    Throws:
    WvcmException

    getRolemapList

    ResourceList<CcRolemap> getRolemapList()
                                           throws WvcmException
    Get the value of this resource's ROLEMAP_LIST property.

    Returns:
    List of rolemaps which implement this policy.
    Throws:
    WvcmException

    setAclMap

    void setAclMap(Map<String,List<CcAccessControlEntry>> aclMap)
                   throws WvcmException
    Set the value of this proxy's ACL_MAP property. This property may only be set for use with the doCreateCcPolicy(com.ibm.rational.wvcm.stp.cc.CcTypeBase.TypeCreateFlag[], Feedback) call. It cannot be written using Resource.doWriteProperties(Feedback).

    Throws:
    WvcmException - if this proxy doesn't define a value for this property.

    Generated Sat 22-Feb-2014 01:07 AM

    Copyright © IBM 2014. All rights reserved.