com.atlassian.jira.scheme.mapper
Interface SchemeGroupsToRolesTransformer

All Known Implementing Classes:
SchemeGroupsToRolesTransformerImpl

public interface SchemeGroupsToRolesTransformer

This object will allow you to specify a Set of regular expressions that should map Group names to a ProjectRole. You can then use this object to transform a Set of Scheme's SchemeEntity's from the groups that have been mapped from to the role they have been mapped to.


Method Summary
 SchemeTransformResults doTransform(List schemes, Set groupToRoleMappings)
          This will take a list of Scheme's and transform their associated SchemeEntity's of type 'group' to the project roles that are mapped via the passed in GroupToRoleMapping's.
 void persistTransformationResults(SchemeTransformResults schemeTransformResults)
          This method, given a SchemeTransformResult will 'unpack' all the users in the groups that are mapped to each ProjectRole and then add the users to that ProjectRole for the Project's that are associated with this SchemeTransformResults original.
 

Method Detail

doTransform

SchemeTransformResults doTransform(List schemes,
                                   Set groupToRoleMappings)
This will take a list of Scheme's and transform their associated SchemeEntity's of type 'group' to the project roles that are mapped via the passed in GroupToRoleMapping's.

Parameters:
schemes - the List of Scheme's that should be transformed. NOTE: there will be one SchemeTransformResult per scheme passed in.
groupToRoleMappings - defines the group SchemeEntity's that will be replaced by the defined ProjectRole SchemeEntity.
Returns:
a collection of SchemeTransformResult's. An empty collection if the passed in schemes are null or empty.

persistTransformationResults

void persistTransformationResults(SchemeTransformResults schemeTransformResults)
This method, given a SchemeTransformResult will 'unpack' all the users in the groups that are mapped to each ProjectRole and then add the users to that ProjectRole for the Project's that are associated with this SchemeTransformResults original. It will also save the resulting transformed scheme, renaming the original scheme to 'Backup of ...'. Scheme.

Parameters:
schemeTransformResults - - contains the results of the GroupToRoles transform as created by the doTransform method of this class.


Copyright © 2002-2014 Atlassian. All Rights Reserved.