com.cafesoft.cams.service
Interface UserRepositoryService

All Superinterfaces:

Debuggable, Lifecycle, LifecycleService, Service

public interface UserRepositoryService

extends LifecycleService

Provides a service that allows the user of this service to obtain a handle to a UserRepository object.

The UserRepository configuration properties are passed via the Service configuration settings within the security-domain.xml.

The initialization parameters expected are the following:

repositoryFilePath - the file path to the user repository file.

handlerClass - the fully qualified class name of the XML handler class to parse the user repository file

repositoryFactoryClass - the file path to the user repository file.

The expected lifecycle of the service is as follows:

Created

Initialized

Started

Stopped

Recycled

Since:

12/4/01

Field Summary

Fields inherited from interface com.cafesoft.core.lifecycle.Lifecycle

START_EVENT, STOP_EVENT

Method Summary

UserRepository	getUserRepository() Get the UserRepository object stored in the service.
boolean	isModified() Determine if the user repository has been modified.

Methods inherited from interface com.cafesoft.core.service.Service

destroy, getServiceConfig, initialize

Methods inherited from interface com.cafesoft.core.util.Debuggable

setDebug

Methods inherited from interface com.cafesoft.core.lifecycle.Lifecycle

addLifecycleListener, isStarted, removeLifecycleListener, start, stop

Method Detail

getUserRepository

public UserRepository getUserRepository()
                                 throws ServiceException

Get the UserRepository object stored in the service.

Returns:

the UserRepository created by the service, or null if one has not been created

Throws:

ServiceException - if unable to get the UserRepository.

isModified

public boolean isModified()

Determine if the user repository has been modified.

Returns:

returns false if the service has not been either started or initialized. In addition, returns false if the UserRepository has not been instantiated. Returns true otherwise.