org.w3c.jigsaw.auth
Class AuthRealm

java.lang.Object
  |
  +--org.w3c.tools.resources.AttributeHolder
        |
        +--org.w3c.tools.resources.Resource
              |
              +--org.w3c.tools.resources.FramedResource
                    |
                    +--org.w3c.tools.resources.AbstractContainer
                          |
                          +--org.w3c.tools.resources.ContainerResource
                                |
                                +--org.w3c.tools.resources.ExternalContainer
                                      |
                                      +--org.w3c.jigsaw.auth.AuthRealm

public class AuthRealm
extends org.w3c.tools.resources.ExternalContainer


Fields inherited from class org.w3c.tools.resources.ExternalContainer
repository, transientFlag
 
Fields inherited from class org.w3c.tools.resources.ContainerResource
acquired, ATTR_KEY
 
Fields inherited from class org.w3c.tools.resources.FramedResource
ATTR_OID, attrListener, debugEvent, event_disabled, framesRef, structListener
 
Fields inherited from class org.w3c.tools.resources.Resource
ATTR_CONTEXT, ATTR_HELP_URL, ATTR_IDENTIFIER, ATTR_LAST_MODIFIED, ATTR_PARENT, ATTR_RESOURCE_FRAMES, ATTR_STORE_ENTRY, ATTR_URL
 
Fields inherited from class org.w3c.tools.resources.AttributeHolder
attributes, slowpickle, values
 
Constructor Summary
AuthRealm()
           
AuthRealm(java.lang.String id, org.w3c.tools.resources.ResourceContext context)
           
 
Method Summary
 java.util.Enumeration enumerateUserNames()
          Enumerate this realm user's name.
 java.io.File getRepository(org.w3c.tools.resources.ResourceContext context)
           
 org.w3c.tools.resources.ResourceReference loadUser(java.lang.String name)
          Load the user having this name.
static AuthRealm makeRealm(org.w3c.tools.resources.ResourceContext context, java.lang.String name)
          create a new empty realm.
 void registerResource(java.lang.String name, org.w3c.tools.resources.Resource resource, java.util.Hashtable defs)
           
 void registerUser(AuthUser user)
          register this new user in the realm.
 void save()
          Save our store.
 void unregisterUser(java.lang.String name)
          Unregister a user from the realm.
 
Methods inherited from class org.w3c.tools.resources.ExternalContainer
acquireChildren, createDefaultResource, delete, initialize, markModified
 
Methods inherited from class org.w3c.tools.resources.ContainerResource
addResource, delete, deleteChildren, enumerateResourceIdentifiers, getChildrenSpaceEntry, getClone, getKey, getMatchingCharsCount, getSpaceEntry, internalLookup, lookup, lookup, notifyUnload, replace, resourceCreated, resourceModified, resourceRemoved, updateDefaultChildAttributes
 
Methods inherited from class org.w3c.tools.resources.AbstractContainer
attributeChanged, enumerateResourceIdentifiers, resourceUnloaded
 
Methods inherited from class org.w3c.tools.resources.FramedResource
addAttributeChangedListener, addStructureChangedListener, collectFramesReference, disableEvent, displayEvent, enableEvent, eventDisabled, fireAttributeChangeEvent, fireStructureChangedEvent, fireStructureChangedEvent, frameAdded, frameModified, frameRemoved, getFrame, getFrame, getFrameReference, getFrameReference, getFramesReference, getOid, perform, performFrames, postAttributeChangeEvent, postEvent, postStructureChangedEvent, postStructureChangedEvent, processEvent, registerFrame, registerFrameIfNone, removeAttributeChangedListener, removeStructureChangedListener, setValue, unregisterFrame
 
Methods inherited from class org.w3c.tools.resources.Resource
acceptUnload, checkMultipleLock, collectFrames, getContext, getFrame, getFrames, getHelpURL, getHelpURL, getIdentifier, getLastModified, getParent, getResourceReference, getServer, getSpace, getStoreEntry, getURLPath, getValue, getValue, isInitialized, setContext, setContext, setValue, updateAttributes
 
Methods inherited from class org.w3c.tools.resources.AttributeHolder
definesAttribute, definesAttribute, getAttributes, getBoolean, getChar, getClone, getClone, getDouble, getFloat, getInt, getLong, getString, getValue, initialize, lookupAttribute, pickle, print, setBoolean, setChar, setDouble, setFloat, setInt, setLong, setString, setValue, unpickle, unpickle, unpickle, unpickleInstance, unpickleInstance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AuthRealm

public AuthRealm(java.lang.String id,
                 org.w3c.tools.resources.ResourceContext context)

AuthRealm

public AuthRealm()
Method Detail

loadUser

public org.w3c.tools.resources.ResourceReference loadUser(java.lang.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 void registerUser(AuthUser user)
register this new user in the realm.
Parameters:
user - The new user.

registerResource

public void registerResource(java.lang.String name,
                             org.w3c.tools.resources.Resource resource,
                             java.util.Hashtable defs)
Overrides:
registerResource in class org.w3c.tools.resources.ContainerResource

unregisterUser

public void unregisterUser(java.lang.String name)
                    throws org.w3c.tools.resources.MultipleLockException
Unregister a user from the realm.
Parameters:
name - The user's name.
Throws:
org.w3c.tools.resources.MultipleLockException - if someone else has locked this user.

enumerateUserNames

public java.util.Enumeration enumerateUserNames()
Enumerate this realm user's name.

makeRealm

public static AuthRealm makeRealm(org.w3c.tools.resources.ResourceContext context,
                                  java.lang.String name)
create a new empty realm.
Parameters:
name - The name of the realm.
repository - The file to use to store the realm database.

save

public void save()
Save our store.

getRepository

public java.io.File getRepository(org.w3c.tools.resources.ResourceContext context)
Overrides:
getRepository in class org.w3c.tools.resources.ExternalContainer