org.norther.tammi.root.realm
Interface RepositoryRealm

All Superinterfaces:

Configurable, MultiRepositoryClient, Realm, RepositoryClient

All Known Implementing Classes:

DefaultRepositoryRealm

public interface RepositoryRealm
extends Realm, MultiRepositoryClient

A realm accessing user data in persistent storage.

Author:

Marketta Priha

Field Summary

static String	ACCOUNT_CLASS_NAME_PROPERTY The account class name property.
static String	CASE_INSENSITIVE_PROPERTY The case insensitive property.
static String	USER_CLASS_NAME_PROPERTY The user class name property.

Fields inherited from interface org.norther.tammi.core.realm.Realm

ANONYMOUS_USER_PROPERTY, CACHED_PASSWORDS_PROPERTY, DEFAULT_ROLE_PROPERTY, DIGEST_ALGORITHM_PROPERTY, MEMBER_PROPERTY, PUBLIC_NAME_PROPERTY

Method Summary

String	getAccountClassName() Gets the account class name.
String	getAccountClassName(String domain) Gets the account class name in the specified domain.
String	getUserClassName() Gets the user class name.
boolean	isCaseInsensitive() Checks whether usernames and role names are case-insensitive.
void	setAccountClassName(String className) Sets the account class name.
void	setAccountClassName(String domain, String className) Sets the account class name in the specified domain.
void	setCaseInsensitive(boolean flag) Sets whether usernames and role names are case-insensitive.
void	setUserClassName(String className) Sets the user class name.

Methods inherited from interface org.norther.tammi.core.realm.Realm

authenticate, authenticate, authenticate, authenticate, authenticate, authenticate, authenticate, authenticate, digest, generateAuthenticate, getAnonymousUser, getAuthType, getDefaultRole, getDigestAlgorithm, getPublicName, identify, identify, isAuthenticated, isAuthenticated, isCachedPasswords, isUserInRole, setAnonymousUser, setCachedPasswords, setDefaultRole, setDigestAlgorithm, setPublicName

Methods inherited from interface org.norther.tammi.core.config.Configurable

addProperty, addProperty, clearProperties, containsProperty, getConfigKey, getProperties, getProperty, getPropertyFilePath, indexOfProperty, propertyMap, propertyMap, removeProperty, removeProperty, setConfigKey, setProperties, setProperty, setPropertyFilePath, setPropertyFilePath, storeProperties

Methods inherited from interface org.norther.tammi.root.db.MultiRepositoryClient

acquirePersister, acquirePersister, acquirePersister, clearConnections, connectionKeySet, containsConnection, getAuthenticatedPasswordKey, getAuthenticatedUsernameKey, getAuthenticationConnectionKey, getConnectionAlias, getConnectionUsername, getPersisterClassName, getResourceKey, isConnectionAuthenticated, removeConnection, setAuthenticationConnection, setConnectionAlias, setConnectionAuthenticated, setConnectionPassword, setConnectionUsername, setPersisterClassName, setResourceKey

Methods inherited from interface org.norther.tammi.root.db.RepositoryClient

acquirePersister, acquirePersister, acquirePersister, getAuthenticatedPasswordKey, getAuthenticatedUsernameKey, getAuthenticationConnectionKey, getConnectionKey, getConnectionUsername, getPersisterClassName, isConnectionAuthenticated, setAuthenticationConnection, setConnectionAuthenticated, setConnectionKey, setConnectionPassword, setConnectionUsername, setPersisterClassName

Field Detail

CASE_INSENSITIVE_PROPERTY

static final String CASE_INSENSITIVE_PROPERTY

The case insensitive property.

See Also:

Constant Field Values

USER_CLASS_NAME_PROPERTY

static final String USER_CLASS_NAME_PROPERTY

The user class name property.

See Also:

Constant Field Values

ACCOUNT_CLASS_NAME_PROPERTY

static final String ACCOUNT_CLASS_NAME_PROPERTY

The account class name property.

See Also:

Constant Field Values

Method Detail

isCaseInsensitive

boolean isCaseInsensitive()

Checks whether usernames and role names are case-insensitive.

Returns:

true if case-insensitive, false otherwise.

setCaseInsensitive

void setCaseInsensitive(boolean flag)

Sets whether usernames and role names are case-insensitive.

Parameters:

flag - true if case-insensitive, false otherwise.

getUserClassName

String getUserClassName()

Gets the user class name.

Returns:

the user class name or null.

setUserClassName

void setUserClassName(String className)

Sets the user class name.

Parameters:

className - the user class name.

getAccountClassName

String getAccountClassName()

Gets the account class name.

Returns:

the account class name or null.

setAccountClassName

void setAccountClassName(String className)

Sets the account class name.

The primary key field of the account class should be UserId and it should contain the FirstName and LastName fields to provide the real name for authenticated principals.

Parameters:

className - the account class name.

getAccountClassName

String getAccountClassName(String domain)

Gets the account class name in the specified domain.

Parameters:

domain - the user domain.

Returns:

the account class name or null.

setAccountClassName

void setAccountClassName(String domain,
                         String className)

Sets the account class name in the specified domain.

The primary key field of the account class should be UserId and it should contain the FirstName and LastName fields to provide the real name for authenticated principals.

Parameters:

domain - the user domain.

className - the account class name.