org.wso2.carbon.user.api

Class RealmConfiguration

java.lang.Object

org.wso2.carbon.user.api.RealmConfiguration

public class RealmConfiguration
extends Object

The object representing the realm configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	addAdmin
protected String	adminPassword
protected String	adminRoleName
protected String	adminUserName
protected String	authorizationManagerClass
protected Map<String,String>	authzProperties
protected String	description
protected String	everyOneRoleName
protected boolean	isPrimary
protected Map<String,Map<String,String>>	multipleCredentialProps
protected boolean	passwordsExternallyManaged
protected Date	persistedTimestamp
protected String	realmClassName
protected Map<String,String>	realmProperties
protected List<String>	reservedRoleNames
protected List<String>	restrictedDomainsForSelfSignUp
protected RealmConfiguration	secondaryRealmConfig
protected int	tenantId
protected String	userStoreClass
protected Map<String,String>	userStoreProperties

Constructor Summary

Constructors

Constructor and Description
RealmConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMultipleCredentialProperties(String userStoreClass, Map<String,String> multipleCredentialsProperties)
void	addReservedRoleName(String roleName)
void	addRestrictedDomainForSelfSignUp(String domain)
RealmConfiguration	cloneRealmConfiguration()
RealmConfiguration	cloneRealmConfigurationWithoutSecondary()
String	getAddAdmin()
String	getAdminPassword()
String	getAdminRoleName()
String	getAdminUserName()
String	getAuthorizationManagerClass()
String	getAuthorizationManagerProperty(String key)
String	getAuthorizationPropertyValue(String propertyName)
Map<String,String>	getAuthzProperties()
String	getDescription()
String	getEveryOneRoleName()
Map<String,Map<String,String>>	getMultipleCredentialProps()
Date	getPersistedTimestamp()
String	getRealmClassName()
Map<String,String>	getRealmProperties()
String	getRealmProperty(String propertyName)
RealmConfiguration	getSecondaryRealmConfig()
int	getTenantId()
String	getUserStoreClass()
Map<String,String>	getUserStoreProperties()
String	getUserStoreProperty(String propertyName)
boolean	isPasswordsExternallyManaged()
boolean	isPrimary()
boolean	isReservedRoleName(String roleName)
boolean	isRestrictedDomainForSlefSignUp(String domain)
void	setAddAdmin(String addAdmin)
void	setAdminPassword(String adminPassword)
void	setAdminRoleName(String adminRoleName)
void	setAdminUserName(String adminUserName)
void	setAuthorizationManagerClass(String authorizationManagerClass)
void	setAuthzProperties(Map<String,String> authzProperties)
void	setDescription(String description)
void	setEveryOneRoleName(String everyOneRoleName)
void	setPasswordsExternallyManaged(boolean passwordsExternallyManaged)
void	setPersistedTimestamp(Date persistedTimestamp)
void	setPrimary(boolean priamry)
void	setRealmClassName(String realmClassName)
void	setRealmProperties(Map<String,String> realmProperties)
void	setSecondaryRealmConfig(RealmConfiguration secondaryRealm)
void	setTenantId(int tenantId)
void	setUserStoreClass(String userStoreClass)
void	setUserStoreProperties(Map<String,String> userStoreProperties)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

userStoreClass

protected String userStoreClass

authorizationManagerClass

protected String authorizationManagerClass

addAdmin

protected String addAdmin

adminRoleName

protected String adminRoleName

adminUserName

protected String adminUserName

adminPassword

protected String adminPassword

everyOneRoleName

protected String everyOneRoleName

realmClassName

protected String realmClassName

description

protected String description

restrictedDomainsForSelfSignUp

protected List<String> restrictedDomainsForSelfSignUp

reservedRoleNames

protected List<String> reservedRoleNames

userStoreProperties

protected Map<String,String> userStoreProperties

authzProperties

protected Map<String,String> authzProperties

realmProperties

protected Map<String,String> realmProperties

tenantId

protected int tenantId

persistedTimestamp

protected Date persistedTimestamp

passwordsExternallyManaged

protected boolean passwordsExternallyManaged

isPrimary

protected boolean isPrimary

secondaryRealmConfig

protected RealmConfiguration secondaryRealmConfig

multipleCredentialProps

protected Map<String,Map<String,String>> multipleCredentialProps

Constructor Detail

RealmConfiguration

public RealmConfiguration()

Method Detail

isRestrictedDomainForSlefSignUp

public boolean isRestrictedDomainForSlefSignUp(String domain)

isReservedRoleName

public boolean isReservedRoleName(String roleName)

addRestrictedDomainForSelfSignUp

public void addRestrictedDomainForSelfSignUp(String domain)

addReservedRoleName

public void addReservedRoleName(String roleName)

isPrimary

public boolean isPrimary()

setPrimary

public void setPrimary(boolean priamry)

isPasswordsExternallyManaged

public boolean isPasswordsExternallyManaged()

setPasswordsExternallyManaged

public void setPasswordsExternallyManaged(boolean passwordsExternallyManaged)

cloneRealmConfigurationWithoutSecondary

public RealmConfiguration cloneRealmConfigurationWithoutSecondary()
                                                           throws Exception

Throws:

Exception

cloneRealmConfiguration

public RealmConfiguration cloneRealmConfiguration()
                                           throws Exception

Throws:

Exception

getSecondaryRealmConfig

public RealmConfiguration getSecondaryRealmConfig()

setSecondaryRealmConfig

public void setSecondaryRealmConfig(RealmConfiguration secondaryRealm)

getAuthorizationPropertyValue

public String getAuthorizationPropertyValue(String propertyName)

getRealmProperty

public String getRealmProperty(String propertyName)

getUserStoreProperty

public String getUserStoreProperty(String propertyName)

getAddAdmin

public String getAddAdmin()

setAddAdmin

public void setAddAdmin(String addAdmin)

getAdminRoleName

public String getAdminRoleName()

setAdminRoleName

public void setAdminRoleName(String adminRoleName)

getAdminUserName

public String getAdminUserName()

setAdminUserName

public void setAdminUserName(String adminUserName)

getAdminPassword

public String getAdminPassword()

setAdminPassword

public void setAdminPassword(String adminPassword)

getEveryOneRoleName

public String getEveryOneRoleName()

setEveryOneRoleName

public void setEveryOneRoleName(String everyOneRoleName)

getAuthorizationManagerClass

public String getAuthorizationManagerClass()

setAuthorizationManagerClass

public void setAuthorizationManagerClass(String authorizationManagerClass)

getAuthorizationManagerProperty

public String getAuthorizationManagerProperty(String key)

getUserStoreClass

public String getUserStoreClass()

setUserStoreClass

public void setUserStoreClass(String userStoreClass)

getUserStoreProperties

public Map<String,String> getUserStoreProperties()

setUserStoreProperties

public void setUserStoreProperties(Map<String,String> userStoreProperties)

getAuthzProperties

public Map<String,String> getAuthzProperties()

setAuthzProperties

public void setAuthzProperties(Map<String,String> authzProperties)

getRealmProperties

public Map<String,String> getRealmProperties()

setRealmProperties

public void setRealmProperties(Map<String,String> realmProperties)

getTenantId

public int getTenantId()

setTenantId

public void setTenantId(int tenantId)

getPersistedTimestamp

public Date getPersistedTimestamp()

setPersistedTimestamp

public void setPersistedTimestamp(Date persistedTimestamp)

getRealmClassName

public String getRealmClassName()

setRealmClassName

public void setRealmClassName(String realmClassName)

addMultipleCredentialProperties

public void addMultipleCredentialProperties(String userStoreClass,
                                   Map<String,String> multipleCredentialsProperties)

getMultipleCredentialProps

public Map<String,Map<String,String>> getMultipleCredentialProps()

getDescription

public String getDescription()

setDescription

public void setDescription(String description)