Package org.wso2.carbon.user.api

Interface ProfileConfigurationManager

public interface ProfileConfigurationManager

This is the interface to manage profiles in the system.

A profile contains a set of claims.

Method Summary

Modifier and Type	Method	Description
void	addProfileConfig(ProfileConfiguration profileConfig)	Adds a profile configuration
void	deleteProfileConfig(ProfileConfiguration profileConfig)	Deletes a profile configuration
ProfileConfiguration[]	getAllProfiles()	Retrieves all profiles
ProfileConfiguration	getProfileConfig(String profileName)	Gets the profile configuration given the profile name.
void	updateProfileConfig(ProfileConfiguration profileConfig)	Updates a profile configuration

Method Details

getProfileConfig

ProfileConfiguration getProfileConfig(String profileName)
                               throws UserStoreException

Gets the profile configuration given the profile name.

Parameters:

profileName -

Returns:

Throws:

UserStoreException

addProfileConfig

void addProfileConfig(ProfileConfiguration profileConfig)
               throws UserStoreException

Adds a profile configuration

Parameters:

profileConfig -

Throws:

UserStoreException

updateProfileConfig

void updateProfileConfig(ProfileConfiguration profileConfig)
                  throws UserStoreException

Updates a profile configuration

Parameters:

profileConfig -

Throws:

UserStoreException

deleteProfileConfig

void deleteProfileConfig(ProfileConfiguration profileConfig)
                  throws UserStoreException

Deletes a profile configuration

Parameters:

profileConfig -

Throws:

UserStoreException

getAllProfiles

ProfileConfiguration[] getAllProfiles()
                               throws UserStoreException

Retrieves all profiles

Returns:

An array of profiles in the system

Throws:

UserStoreException