org.norther.tammi.core.realm
Interface NativeRealm

All Superinterfaces:

Configurable, Library, Realm

All Known Implementing Classes:

DefaultNativeRealm

public interface NativeRealm
extends Realm, Library

An interface to native realms providing access to domain users and groups. Domain groups members having a specified role are defined as properties using the following syntax:

 ##
 # A role with members from a domain group.
 # 'role'.member = 'group'
 admin.member = BUILTIN\\Administrators
 admin.member = LOCALHOST\\Administrators
 ##
 # The default role to use.
 default.role = user
 ##
 # An account for an anonymous user.
 anonymous.user = Guest
 ##
 # The default domain to use.
 default.domain = ACME
 

If role members are not specified, the domain groups themselves are used as roles.

Author:

Ilkka Priha

Field Summary

static String

DEFAULT_DOMAIN_PROPERTY The default domain 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	getDefaultDomain() Gets the default domain to use for this realm.
int	getFreeDiskSpace(String name) Get free disk space in MB for given disk, empty or null name means the current disk.
int	getGroupId() Gets the group id of the current process.
int	getUserId() Gets the user id of the current process.
void	reportErrorEvent(String source, String message) Reports an error event.
void	reportInfoEvent(String source, String message) Reports an info event.
void	reportWarningEvent(String source, String message) Reports a warning event.
void	setDefaultDomain(String domain) Sets the default domain to use for this realm.
void	setGroupId(int gid) Sets the group id of the current process.
void	setUserId(int uid) Sets the user id of the current process.

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.core.external.Library

getBinKey, getLibraryPath, getLoaderPath, setBinKey, setLibraryPath, setLoaderPath

Field Detail

DEFAULT_DOMAIN_PROPERTY

static final String DEFAULT_DOMAIN_PROPERTY

The default domain property.

See Also:

Constant Field Values

Method Detail

getDefaultDomain

String getDefaultDomain()

Gets the default domain to use for this realm.

Returns:

the default domain name.

setDefaultDomain

void setDefaultDomain(String domain)

Sets the default domain to use for this realm.

Parameters:

domain - the default domain name.

getUserId

int getUserId()

Gets the user id of the current process.

Returns:

the process uid.

setUserId

void setUserId(int uid)
               throws LogException

Sets the user id of the current process.

Parameters:

uid - the new process uid.

Throws:

LogException - on errors.

getGroupId

int getGroupId()

Gets the group id of the current process.

Returns:

the process gid.

setGroupId

void setGroupId(int gid)
                throws LogException

Sets the group id of the current process.

Parameters:

gid - the new process gid.

Throws:

LogException - on errors.

getFreeDiskSpace

int getFreeDiskSpace(String name)

Get free disk space in MB for given disk, empty or null name means the current disk.

Parameters:

name - the filesystem root directory name.

Returns:

the free disk space in MB.

reportErrorEvent

void reportErrorEvent(String source,
                      String message)

Reports an error event.

Parameters:

source - the message source.

message - the event message to report.

reportWarningEvent

void reportWarningEvent(String source,
                        String message)

Reports a warning event.

Parameters:

source - the message source.

message - the event message to report.

reportInfoEvent

void reportInfoEvent(String source,
                     String message)

Reports an info event.

Parameters:

source - the message source.

message - the event message to report.