org.wso2.carbon.user.api

Interface UserRealm

public interface UserRealm

The Realm of the WSO2 user Kernel.

The realm represents a user store. This is a collection of interfaces.

To enable WSO2 platform with a custom realm, implement this interface and add the class to the class path. Provide the class name in the configuration file and the framework will pick the new realm code.

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationManager	getAuthorizationManager() Get the AuthorizationReader of the system
ClaimManager	getClaimManager() Get the ClaimManager of the system
ProfileConfigurationManager	getProfileConfigurationManager() Get the ProfileConfigurationManager of the system
RealmConfiguration	getRealmConfiguration() Get the realm configuration
UserStoreManager	getUserStoreManager() Get the UserStoreManager of the system

Method Detail

getAuthorizationManager

AuthorizationManager getAuthorizationManager()
                                             throws UserStoreException

Get the AuthorizationReader of the system

Returns:

The AuthorizationReader the system

Throws:

UserStoreException

getUserStoreManager

UserStoreManager getUserStoreManager()
                                     throws UserStoreException

Get the UserStoreManager of the system

Returns:

The UserStoreManager of the system

Throws:

UserStoreException

getClaimManager

ClaimManager getClaimManager()
                             throws UserStoreException

Get the ClaimManager of the system

Returns:

The ClaimManager of the system

Throws:

UserStoreException

getProfileConfigurationManager

ProfileConfigurationManager getProfileConfigurationManager()
                                                           throws UserStoreException

Get the ProfileConfigurationManager of the system

Returns:

The ProfileConfigurationManager of the system

Throws:

UserStoreException

getRealmConfiguration

RealmConfiguration getRealmConfiguration()
                                         throws UserStoreException

Get the realm configuration

Returns:

Throws:

UserStoreException