    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class w3c.jigsaw.auth.AuthRealm

    java.lang.Object
       |
       +----w3c.jigsaw.resources.AttributeHolder
               |
               +----w3c.jigsaw.resources.Resource
                       |
                       +----w3c.jigsaw.auth.AuthRealm

public class AuthRealm
extends Resource
implements ResourceStoreHolder

##

ATTR_REPOSITORY
  Attribute index - The repository for the realm.
ATTR_SERVER
  The server we are attached to.
store
  Our user store.

##

AuthRealm()

##

acquireStore()
  Acquire and load the users store.
delete()
  Delete this authentication realm.
enumerateUserNames()
  Enumerate this realm user's name.
getRepository()
  Get our repository.
getServer()
  Get our attached server.
loadUser(String)
  Load the user having this name.
makeRealm(String, File)
  create a new empty realm.
notifyStoreShutdown(ResourceStore)
  The resource store asks us to shutdown our associated store.
notifyStoreStabilize(ResourceStore)
  ResourceStoreHolder implementation - Save our store.
notifyStoreUnload(ResourceStore)
  ResourceStoreHolder implementation - Unload the store.
registerUser(AuthUser)
  register this new user in the realm.
save()
  Save our store.
unregisterUser(String)
  Unregister a user from the realm.

##

ATTR_SERVER

      protected static int ATTR_SERVER

  The server we are attached to.

ATTR_REPOSITORY

      protected static int ATTR_REPOSITORY

  Attribute index - The repository for the realm.

store

      protected ResourceStore store

  Our user store.

##

AuthRealm

      public AuthRealm()

##

acquireStore

      protected synchronized void acquireStore()

  Acquire and load the users store. Should only be called from a synchronized method.

getRepository

      public File getRepository()

  Get our repository.

getServer

      public httpd getServer()

  Get our attached server.

loadUser

      public synchronized AuthUser loadUser(String name)

  Load the user having this name.
  Parameters:
    name - The user's name.
  Returns:
    An instance of AuthUser or null if not found.

registerUser

      public synchronized void registerUser(AuthUser user)

  register this new user in the realm.
  Parameters:
    user - The new user.

unregisterUser

      public synchronized void unregisterUser(String name)

  Unregister a user from the realm.
  Parameters:
    name - The user's name.

enumerateUserNames

      public synchronized Enumeration enumerateUserNames()

  Enumerate this realm user's name.

makeRealm

      public static AuthRealm makeRealm(String name,
                                        File repository)

  create a new empty realm.
  Parameters:
    name - The name of the realm.
    repository - The file to use to store the realm database.

delete

      public void delete()

  Delete this authentication realm. This method will remove all traces of the existence of this authentication realm.
  Overrides:
    delete in class Resource

save

      public synchronized void save()

  Save our store.

notifyStoreUnload

      public synchronized boolean notifyStoreUnload(ResourceStore st)

  ResourceStoreHolder implementation - Unload the store.
  Parameters:
    st - The store to unload.
  Returns:
    A boolean true if store was successfully unloaded.

notifyStoreShutdown

      public void notifyStoreShutdown(ResourceStore st)

  The resource store asks us to shutdown our associated store.
  Parameters:
    st - The store to shutdown.

notifyStoreStabilize

      public boolean notifyStoreStabilize(ResourceStore st)

  ResourceStoreHolder implementation - Save our store.
  Parameters:
    st - The store to be saved.
  Returns:
    A boolean true if saving the store is now not modified.

    All Packages  Class Hierarchy  This Package  Previous  Next  Index