How to use org.wso2.carbon.identity.provisioning

/**
 * @param attributeMap
 * @return
 */
protected List<String> getUserNames(Map<ClaimMapping, List<String>> attributeMap) {
  return ProvisioningUtil.getClaimValues(attributeMap,
      IdentityProvisioningConstants.USERNAME_CLAIM_URI, getUserStoreDomainName());
}

/**
 * @param attributeMap
 * @return
 */
protected List<String> getGroupNames(Map<ClaimMapping, List<String>> attributeMap) {
  return ProvisioningUtil.getClaimValues(attributeMap,
      IdentityProvisioningConstants.GROUP_CLAIM_URI, null);
}

/**
 * @param provisionedIdentifier
 * @return
 * @throws CarbonException
 * @throws UserStoreException
 */
protected boolean canUserBeDeProvisioned(ProvisionedIdentifier provisionedIdentifier)
    throws UserStoreException, CarbonException, IdentityApplicationManagementException {
  // check whether we already have the provisioned identifier.current idp is not eligible to
  // provisioning.
  if (provisionedIdentifier != null && provisionedIdentifier.getIdentifier() != null) {
    return true;
  }
  return false;
}

/**
 * @param provisioningEntity
 * @throws IdentityProvisioningException
 */
private void deleteUser(ProvisioningEntity provisioningEntity)
    throws IdentityProvisioningException {
  JSONObject entity = new JSONObject();
  try {
    entity.put(SalesforceConnectorConstants.IS_ACTIVE, false);
    entity.put(SalesforceConnectorConstants.USERNAME_ATTRIBUTE, alterUsername(provisioningEntity));
    update(provisioningEntity.getIdentifier().getIdentifier(), entity);
  } catch (JSONException e) {
    log.error("Error while creating JSON body");
    throw new IdentityProvisioningException(e);
  }
}

  /**
   * Update the value of given group attribute with mapped roles
   *
   * @param provisioningEntity
   * @param idPRoleMapping
   * @param groupAttributeName
   */
  private void updateMappedGroupForAttribute(ProvisioningEntity provisioningEntity, RoleMapping[] idPRoleMapping,
                        String groupAttributeName) {

    List<String> groupList = ProvisioningUtil.getClaimValues(provisioningEntity.getAttributes(),
        groupAttributeName, null);
    List<String> mappedGroups = getMappedGroups(groupList, idPRoleMapping);

    if (mappedGroups != null && !mappedGroups.isEmpty()) {
      ProvisioningUtil.setClaimValue(groupAttributeName, provisioningEntity.getAttributes(), mappedGroups);
    }
  }
}

private String[] buildProvisioningEntries(String provisioningPattern) throws IdentityProvisioningException {
  if (!provisioningPattern.contains("{") || !provisioningPattern.contains("}")) {
    throw new IdentityProvisioningException("Invalid Provisioning Pattern");
  }
  String provisioningPatternWithoutCurlBrace = provisioningPattern.replaceAll("\\{", "").replaceAll("\\}", "");
  return provisioningPatternWithoutCurlBrace.split(",");
}

/**
 * @param idpName
 * @param connectorType
 * @param provisioningEntity
 * @param tenantDomain
 * @return
 * @throws IdentityApplicationManagementException
 */
private ProvisionedIdentifier getProvisionedEntityIdentifier(String idpName,
                               String connectorType, ProvisioningEntity provisioningEntity, String tenantDomain)
    throws IdentityApplicationManagementException {
  int tenantId = getTenantIdOfDomain(tenantDomain);
  return dao.getProvisionedIdentifier(idpName, connectorType, provisioningEntity, tenantId, tenantDomain);
}

/**
 * introduce extendability for handling provisioning exceptions
 *
 * @param idPName
 * @param connectorType
 * @param provisioningEntity
 * @param executors
 * @param e
 */
protected void handleException(String idPName, String connectorType, ProvisioningEntity provisioningEntity,
                ExecutorService executors, Exception e) {
  if (log.isDebugEnabled()) {
    log.debug(generateMessageOnFailureProvisioningOperation(idPName, connectorType, provisioningEntity), e);
  }
}

  /**
   * Update the value of given group attribute with mapped roles
   *
   * @param provisioningEntity
   * @param idPRoleMapping
   * @param groupAttributeName
   */
  private void updateMappedGroupForAttribute(ProvisioningEntity provisioningEntity, RoleMapping[] idPRoleMapping,
                        String groupAttributeName) {

    List<String> groupList = ProvisioningUtil.getClaimValues(provisioningEntity.getAttributes(),
        groupAttributeName, null);
    List<String> mappedGroups = getMappedGroups(groupList, idPRoleMapping);

    if (mappedGroups != null && !mappedGroups.isEmpty()) {
      ProvisioningUtil.setClaimValue(groupAttributeName, provisioningEntity.getAttributes(), mappedGroups);
    }
  }
}

private String[] buildProvisioningEntries(String provisioningPattern) throws IdentityProvisioningException {
  if (!provisioningPattern.contains("{") || !provisioningPattern.contains("}")) {
    throw new IdentityProvisioningException("Invalid Provisioning Pattern");
  }
  String provisioningPatternWithoutCurlBrace = provisioningPattern.replaceAll("\\{", "").replaceAll("\\}", "");
  return provisioningPatternWithoutCurlBrace.split(",");
}

/**
 * @param provisionedIdentifier
 * @return
 * @throws CarbonException
 * @throws UserStoreException
 */
protected boolean canUserBeDeProvisioned(ProvisionedIdentifier provisionedIdentifier)
    throws UserStoreException, CarbonException, IdentityApplicationManagementException {
  // check whether we already have the provisioned identifier.current idp is not eligible to
  // provisioning.
  if (provisionedIdentifier != null && provisionedIdentifier.getIdentifier() != null) {
    return true;
  }
  return false;
}

/**
 * @param attributeMap
 * @return
 */
protected List<String> getGroupNames(Map<ClaimMapping, List<String>> attributeMap) {
  return ProvisioningUtil.getClaimValues(attributeMap,
      IdentityProvisioningConstants.GROUP_CLAIM_URI, getUserStoreDomainName());
}

/**
 * @param attributeMap
 * @return
 */
protected List<String> getGroupNames(Map<ClaimMapping, List<String>> attributeMap) {
  return ProvisioningUtil.getClaimValues(attributeMap,
                      IdentityProvisioningConstants.GROUP_CLAIM_URI, null);
}

private String[] buildProvisioningEntries(String provisioningPattern) throws IdentityProvisioningException {
  if (!provisioningPattern.contains("{") || !provisioningPattern.contains("}")) {
    throw new IdentityProvisioningException("Invalid Provisioning Pattern");
  }
  String provisioningPatternWithoutCurlBrace = provisioningPattern.replaceAll("\\{", "").replaceAll("\\}", "");
  return provisioningPatternWithoutCurlBrace.split(",");
}

/**
 * @param provisionedIdentifier
 * @return
 * @throws CarbonException
 * @throws UserStoreException
 */
protected boolean canUserBeDeProvisioned(ProvisionedIdentifier provisionedIdentifier)
    throws UserStoreException, CarbonException, IdentityApplicationManagementException {
  // check whether we already have the provisioned identifier.current idp is not eligible to
  // provisioning.
  if (provisionedIdentifier != null && provisionedIdentifier.getIdentifier() != null) {
    return true;
  }
  return false;
}

/**
 * @param attributeMap
 * @return
 */
protected List<String> getGroupNames(Map<ClaimMapping, List<String>> attributeMap) {
  return ProvisioningUtil.getClaimValues(attributeMap,
      IdentityProvisioningConstants.GROUP_CLAIM_URI, getUserStoreDomainName());
}

/**
 * @param attributeMap
 * @return
 */
protected List<String> getGroupNames(Map<ClaimMapping, List<String>> attributeMap) {
  return ProvisioningUtil.getClaimValues(attributeMap,
                      IdentityProvisioningConstants.GROUP_CLAIM_URI, null);
}

/**
 * @param attributeMap
 * @return
 */
protected List<String> getUserNames(Map<ClaimMapping, List<String>> attributeMap) {
  return ProvisioningUtil.getClaimValues(attributeMap,
      IdentityProvisioningConstants.USERNAME_CLAIM_URI, getUserStoreDomainName());
}

/**
 * @param attributeMap
 * @return
 */
protected List<String> getGroupNames(Map<ClaimMapping, List<String>> attributeMap) {
  return ProvisioningUtil.getClaimValues(attributeMap,
      IdentityProvisioningConstants.GROUP_CLAIM_URI, getUserStoreDomainName());
}

/**
 * @param attributeMap
 * @return
 */
protected List<String> getUserNames(Map<ClaimMapping, List<String>> attributeMap) {
  return ProvisioningUtil.getClaimValues(attributeMap,
      IdentityProvisioningConstants.USERNAME_CLAIM_URI, getUserStoreDomainName());
}