org.wso2.carbon.user.core.tracker.UserStoreManagerRegistry Java Examples

/**
 * Construct the user store type's meta.
 *
 * @param typeId        the type id of the user store.
 * @return MetaUserStoreType.
 */
private MetaUserStoreType buildUserStoreMetaResponse(String typeId) {

    String typeName = base64URLDecodeId(typeId);
    Properties properties = UserStoreManagerRegistry.getUserStoreProperties(
            getUserStoreType(typeName));
    MetaUserStoreType metaUserStore = new MetaUserStoreType();
    UserStorePropertiesRes userStorePropertiesRes = new UserStorePropertiesRes();
    if ((properties != null)) {
        userStorePropertiesRes.mandatory(buildPropertiesRes(properties.getMandatoryProperties()));
        userStorePropertiesRes.optional(buildPropertiesRes(properties.getOptionalProperties()));
        userStorePropertiesRes.advanced(buildPropertiesRes(properties.getAdvancedProperties()));
    }
    metaUserStore.setProperties(userStorePropertiesRes);
    metaUserStore.setTypeId(typeId);
    metaUserStore.setTypeName(typeName);
    metaUserStore.setClassName(getUserStoreType(typeName));

    return metaUserStore;
}
 

/**
 * Get the list of properties from  mandatoryProperties list
 *
 * @param userStoreClass class name of user store
 * @return ArrayList consisting of mandatory properties to be encrypted
 */
private static ArrayList<String> getEncryptPropertyList(String userStoreClass) {
    //First check for mandatory field with #encrypt
    Property[] mandatoryProperties = UserStoreManagerRegistry.getUserStoreProperties(userStoreClass).
            getMandatoryProperties();
    ArrayList<String> propertyList = new ArrayList<String>();
    for (Property property : mandatoryProperties) {
        if (property != null) {
            String propertyName = property.getName();
            if (propertyName != null && property.getDescription().contains
                    (UserStoreConfigurationConstants.ENCRYPT_TEXT)) {
                propertyList.add(propertyName);
            }
        }
    }
    return propertyList;
}
 

/**
 * Get the list of properties from  mandatoryProperties list
 *
 * @param userStoreClass class name of user store
 * @return ArrayList consisting of mandatory properties to be encrypted
 */
private static ArrayList<String> getEncryptPropertyList(String userStoreClass) {
    //First check for mandatory field with #encrypt
    Property[] mandatoryProperties = UserStoreManagerRegistry.getUserStoreProperties(userStoreClass).
            getMandatoryProperties();
    ArrayList<String> propertyList = new ArrayList<String>();
    for (Property property : mandatoryProperties) {
        if (property != null) {
            String propertyName = property.getName();
            if (propertyName != null && property.getDescription().contains
                    (UserStoreConfigurationConstants.ENCRYPT_TEXT)) {
                propertyList.add(propertyName);
            }
        }
    }
    return propertyList;
}
 

/**
 * Construct a map with class name and with the corresponding type name.
 *
 * @return HashMap.
 */
private HashMap<String, String> getHashMap() {

    Set<String> classNames = UserStoreManagerRegistry.getUserStoreManagerClasses();
    HashMap<String, String> userStoreMap = new HashMap<>();

    for (String className : classNames) {
        userStoreMap.put(className, className.substring(className.lastIndexOf('.') + 1));
    }
    return userStoreMap;
}
 

/**
 * Get User Store Manager default properties for a given implementation
 *
 * @param className Implementation class name for the user store
 * @return list of default properties(mandatory+optional)
 */
public Properties getUserStoreManagerProperties(String className) throws IdentityUserStoreMgtException {
    Properties properties = UserStoreManagerRegistry.getUserStoreProperties(className);

    if (properties != null && properties.getOptionalProperties() != null) {

        Property[] optionalProperties = properties.getOptionalProperties();
        boolean foundUniqueIDProperty = false;
        for (Property property : optionalProperties) {
            if (UserStoreConfigurationConstant.UNIQUE_ID_CONSTANT.equals(property.getName())) {
                foundUniqueIDProperty = true;
                break;
            }
        }
        if (!foundUniqueIDProperty) {
            if (LOG.isDebugEnabled()) {
                LOG.debug("Inserting property : " + UserStoreConfigurationConstant.UNIQUE_ID_CONSTANT +
                          " since " + UserStoreConfigurationConstant.UNIQUE_ID_CONSTANT +
                          " property not defined as an optional property in " + className + " class");
            }
            List<Property> optionalPropertyList = new ArrayList<>(Arrays.asList(optionalProperties));
            Property uniqueIDProperty = new Property(
                    UserStoreConfigurationConstant.UNIQUE_ID_CONSTANT, "", "", null);
            optionalPropertyList.add(uniqueIDProperty);

            properties.setOptionalProperties(
                    optionalPropertyList.toArray(new Property[optionalPropertyList.size()]));
        }
    }

    return properties;
}
 

/**
 * Get User Store Manager default properties for a given implementation
 *
 * @param className:Implementation class name for the user store
 * @return : list of default properties(mandatory+optional)
 */
public Properties getUserStoreManagerProperties(String className) throws IdentityUserStoreMgtException {
    Properties properties = UserStoreManagerRegistry.getUserStoreProperties(className);

    if (properties != null && properties.getOptionalProperties() != null) {

        Property[] optionalProperties =  properties.getOptionalProperties();

        boolean foundUniqueIDProperty = false;
        for (Property property : optionalProperties) {
            if (UserStoreConfigurationConstant.UNIQUE_ID_CONSTANT.equals(property.getName())) {
                foundUniqueIDProperty = true;
                break;
            }
        }
        if (!foundUniqueIDProperty) {
            if (log.isDebugEnabled()) {
                log.debug("Inserting property : " + UserStoreConfigurationConstant.UNIQUE_ID_CONSTANT +
                        " since " + UserStoreConfigurationConstant.UNIQUE_ID_CONSTANT +
                        " property not defined as an optional property in " + className + " class");
            }
            List<Property> optionalPropertyList = new ArrayList<>(Arrays.asList(optionalProperties));
            Property uniqueIDProperty = new Property(
                    UserStoreConfigurationConstant.UNIQUE_ID_CONSTANT, "", "", null);
            optionalPropertyList.add(uniqueIDProperty);

            properties.setOptionalProperties(
                    optionalPropertyList.toArray(new Property[optionalPropertyList.size()]));
        }
    }

    return properties;
}
 

@Override
public Set<String> getAvailableUserStoreClasses() throws IdentityUserStoreMgtException {

    return getAllowedUserstoreClasses(UserStoreManagerRegistry.getUserStoreManagerClasses());
}
 

/**
 * Obtains the mandatory properties for a given userStoreClass
 *
 * @param userStoreClass userStoreClass name
 * @return Property[] of Mandatory Properties
 */
private static Property[] getMandatoryProperties(String userStoreClass) {

    return UserStoreManagerRegistry.getUserStoreProperties(userStoreClass).getMandatoryProperties();
}
 

/**
 * Get available user store manager implementations
 *
 * @return: Available implementations for user store managers
 */
public String[] getAvailableUserStoreClasses() throws IdentityUserStoreMgtException {
    Set<String> classNames = UserStoreManagerRegistry.getUserStoreManagerClasses();
    return classNames.toArray(new String[classNames.size()]);
}
 

/**
 * Obtains the mandatory properties for a given userStoreClass
 *
 * @param userStoreClass userStoreClass name
 * @return Property[] of Mandatory Properties
 */
private Property[] getMandatoryProperties(String userStoreClass) {
    return UserStoreManagerRegistry.getUserStoreProperties(userStoreClass).getMandatoryProperties();
}