Project: stp

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

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

public interface CcRolemap
extends CcTypeBase

A proxy for a ClearCase rolemap.

A rolemap specifies the principals (users, groups, etc) that take on roles listed in a policy. In combination with a policy, it defines the access controls for one or more VOB objects.

The intention is that a small number of policies can be defined that determine ‘how’ permissions are applied to objects. Defining a number of rolemaps for each policy describes ‘who’ takes on the roles in the policy. By splitting the ‘how’ and the ‘who’, policies can be reused multiple times to reduce the complexity of security administration. Each VOB with access control lists (ACLs) enables has a default rolemap named DefaultRolemap. This default rolemap is empty. The default rolemap controls all objects in the VOB until new objects are created with a reference to some other rolemap, or until an existing object is reprotected to use a new rolemap.


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>>> ALL_EFFECTIVE_ACL
          Map of names of VOB object proxy types to lists of access control entries which make up the effective ACLs that this rolemap would generate when applied to VOB objects.
static PropertyNameList.PropertyName<Boolean> IS_IN_USE
          Is this rolemap in use?
static PropertyNameList.PropertyName<CcPolicy> POLICY
          Policy used to define the ACLs for this rolemap.
static PropertyNameList.PropertyName<List<CcRolemapEntry>> ROLEMAP_ENTRIES
          List of role-to-principal bindings which define this rolemap
 
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
 CcRolemap doCreateCcRolemap(CcTypeBase.TypeCreateFlag[] flags, Feedback feedback)
           Create a new rolemap at the location specified by this proxy.
 CcRolemap doModifyCcRolemap(CcTypeBase.TypeCreateFlag[] flags, Feedback feedback)
           Modify an existing rolemap at the location specified by this proxy.
 Map<String,List<CcAccessControlEntry>> getAllEffectiveAcl()
          Get the value of this resource's ALL_EFFECTIVE_ACL property.
 boolean getIsInUse()
          Get the value of this resource's IS_IN_USE property.
 CcPolicy getPolicy()
          Get the value of this resource's POLICY property.
 List<CcRolemapEntry> getRolemapEntries()
          Get the value of this resource's ROLEMAP_ENTRIES property.
 void setPolicy(CcPolicy policy)
          Set the value of this proxy's POLICY property.
 void setRolemapEntries(List<CcRolemapEntry> rolemapEntries)
          Set the value of this proxy's ROLEMAP_ENTRIES 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

ALL_EFFECTIVE_ACL

static final PropertyNameList.PropertyName<Map<String,List<CcAccessControlEntry>>> ALL_EFFECTIVE_ACL
Map of names of VOB object proxy types to lists of access control entries which make up the effective ACLs that this rolemap would generate when applied to VOB objects.


IS_IN_USE

static final PropertyNameList.PropertyName<Boolean> IS_IN_USE
Is this rolemap in use? true if the rolemap is currently applied to one or more objects, false otherwise.


POLICY

static final PropertyNameList.PropertyName<CcPolicy> POLICY
Policy used to define the ACLs for this rolemap.


ROLEMAP_ENTRIES

static final PropertyNameList.PropertyName<List<CcRolemapEntry>> ROLEMAP_ENTRIES
List of role-to-principal bindings which define this rolemap

Method Detail

doCreateCcRolemap

CcRolemap doCreateCcRolemap(CcTypeBase.TypeCreateFlag[] flags,
                            Feedback feedback)
                            throws WvcmException

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

Set the required POLICY property to specify the policy with which the rolemap should be associated.

Set the optional ROLEMAP_ENTRIES property to specify the role-to-principal bindings for this rolemap. If this property is not set, the rolemap will be created with an empty binding list.

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

  • doModifyCcRolemap

    CcRolemap doModifyCcRolemap(CcTypeBase.TypeCreateFlag[] flags,
                                Feedback feedback)
                                throws WvcmException

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

    Set the optional POLICY property to modify the policy with which the rolemap should be associated. If not specified, the existing policy will be left unchanged.

    Set the optional ROLEMAP_ENTRIES property to specify the role-to-principal bindings for this rolemap. If this property is not set, the existing rolemap entries will be left unchanged.

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

    getAllEffectiveAcl

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

    Returns:
    Map of names of VOB object proxy types to lists of access control entries which make up the effective ACLs that this rolemap would generate when applied to VOB objects. null if the resource does not support ACLs.
    Throws:
    WvcmException

    getIsInUse

    boolean getIsInUse()
                       throws WvcmException
    Get the value of this resource's IS_IN_USE property.

    Returns:
    true if the rolemap is currently applied to one or more objects, false otherwise.
    Throws:
    WvcmException

    getPolicy

    CcPolicy getPolicy()
                       throws WvcmException
    Get the value of this resource's POLICY property.

    Returns:
    Policy used to define the ACLs for this rolemap.
    Throws:
    WvcmException

    getRolemapEntries

    List<CcRolemapEntry> getRolemapEntries()
                                           throws WvcmException
    Get the value of this resource's ROLEMAP_ENTRIES property.

    Returns:
    List of role-to-principal bindings which define this rolemap
    Throws:
    WvcmException

    setPolicy

    void setPolicy(CcPolicy policy)
                   throws WvcmException
    Set the value of this proxy's POLICY property. This property may only be set for use with the doCreateCcRolemap(com.ibm.rational.wvcm.stp.cc.CcTypeBase.TypeCreateFlag[], Feedback) or doModifyCcRolemap(com.ibm.rational.wvcm.stp.cc.CcTypeBase.TypeCreateFlag[], Feedback) calls. It cannot be written using Resource.doWriteProperties(Feedback).

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

    setRolemapEntries

    void setRolemapEntries(List<CcRolemapEntry> rolemapEntries)
                           throws WvcmException
    Set the value of this proxy's ROLEMAP_ENTRIES property. This property may only be set for use with the doCreateCcRolemap(com.ibm.rational.wvcm.stp.cc.CcTypeBase.TypeCreateFlag[], Feedback) or doModifyCcRolemap(com.ibm.rational.wvcm.stp.cc.CcTypeBase.TypeCreateFlag[], Feedback) calls. It cannot be written using Resource.doWriteProperties(Feedback).

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

    Generated Wed 22-May-2013 09:09 AM

    Copyright © IBM 2013. All rights reserved.