Package org.wso2.carbon.user.api

Interface UserRealmService

public interface UserRealmService

This is the OSGI service that provides the entry point to the UserRealm. This service holds all UserRealms in the system.

Method Summary

Modifier and Type	Method	Description
UserRealm	getBootstrapRealm()	Get the bootstrap realm
RealmConfiguration	getBootstrapRealmConfiguration()	Get the boot strap realm configuration, this is always build from conf/user-mgt.xml
TenantManager	getTenantManager()	Get tenant manager
TenantMgtConfiguration	getTenantMgtConfiguration()	Get tenant mgt configuration read from tenant-mgt.xml
UserRealm	getTenantUserRealm(int tenantId)	Only returns if available in cache.
void	setBootstrapRealmConfiguration(RealmConfiguration realmConfiguration)	Set bootstrap realm configuration
void	setTenantManager(TenantManager tenantManager)

Method Details

getBootstrapRealm

UserRealm getBootstrapRealm()
                     throws UserStoreException

Get the bootstrap realm

Returns:

Throws:

UserStoreException

getTenantManager

TenantManager getTenantManager()

Get tenant manager

Returns:

TenantManager

setTenantManager

void setTenantManager(TenantManager tenantManager)
               throws UserStoreException

Parameters:

tenantManager -

Throws:

UserStoreException

getTenantUserRealm

UserRealm getTenantUserRealm(int tenantId)
                      throws UserStoreException

Only returns if available in cache.

Parameters:

tenantId -

Returns:

Throws:

UserStoreException

getBootstrapRealmConfiguration

RealmConfiguration getBootstrapRealmConfiguration()

Get the boot strap realm configuration, this is always build from conf/user-mgt.xml

Returns:

the realm configuration

setBootstrapRealmConfiguration

void setBootstrapRealmConfiguration(RealmConfiguration realmConfiguration)

Set bootstrap realm configuration

getTenantMgtConfiguration

TenantMgtConfiguration getTenantMgtConfiguration()

Get tenant mgt configuration read from tenant-mgt.xml