org.scrashmeow.ojb.console.framework
Class UserContainer

java.lang.Object
  |
  +--org.scrashmeow.ojb.console.framework.UserContainer

All Implemented Interfaces:

java.io.Serializable

public class UserContainer

extends java.lang.Object

implements java.io.Serializable

The container for all session variables for a given variable used by the web application. The one exception is the locale of the user which is stored as a separate variable

Author:

Alexander Bibighaus

See Also:

Serialized Form

Field Summary

protected java.lang.Object	currentInstance Field currentInstance
protected org.apache.ojb.broker.PBKey	databaseKey Field databaseKey
protected RepositoryKeyAcl	repositoryAcl Field repositoryAcl
protected UserObjectCache	userObjects Field userObjects
protected UserRepositoryList	userRepositoryList
protected java.lang.Integer	windowSize Field windowSize

Constructor Summary

UserContainer()
Constructor for UserContainer.

Method Summary

java.lang.Object	getCurrentInstance() Returns the currentInstance.
org.apache.ojb.broker.PBKey	getDatabaseKey() Returns the key.
RepositoryKeyAcl	getRepositoryAcl() Returns the repositoryAcl.
java.lang.Object	getUserObject(java.lang.String uid) Method getUserObject @add-javadoc!!!
UserObjectCache	getUserObjects() Returns the userObjects.
UserRepositoryList	getUserRepositoryList()
java.lang.Integer	getWindowSize() Returns the windowSize.
java.lang.String	putUserObject(java.lang.Object obj) Method putUserObject @add-javadoc!!!
void	putUserObject(java.lang.String uid, java.lang.Object obj) Method putUserObject @add-javadoc!!!
void	removeUserObject(java.lang.String uid) Method removeUserObject @add-javadoc!!!
void	setCurrentInstance(java.lang.Object currentInstance) Sets the currentInstance.
void	setDatabaseKey(org.apache.ojb.broker.PBKey key) Sets the key.
void	setRepositoryAcl(RepositoryKeyAcl repositoryAcl) Sets the repositoryAcl.
void	setUserObjects(UserObjectCache userObjects) Sets the userObjects.
void	setUserRepositoryList(UserRepositoryList list)
void	setWindowSize(java.lang.Integer windowSize) Sets the windowSize.
void	valueBound(HttpSessionBindingEvent event) The container calls this method when it is being bound to the session.
void	valueUnbound(HttpSessionBindingEvent event) The container calls this method when it is being unbound from the session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

databaseKey

protected org.apache.ojb.broker.PBKey databaseKey

Field databaseKey

currentInstance

protected java.lang.Object currentInstance

Field currentInstance

windowSize

protected java.lang.Integer windowSize

Field windowSize

repositoryAcl

protected RepositoryKeyAcl repositoryAcl

Field repositoryAcl

userObjects

protected UserObjectCache userObjects

Field userObjects

userRepositoryList

protected UserRepositoryList userRepositoryList

Constructor Detail

UserContainer

public UserContainer()

Constructor for UserContainer.

Method Detail

valueBound

public void valueBound(HttpSessionBindingEvent event)

The container calls this method when it is being bound to the session.

Parameters:

event - @add-javadoc!!!

valueUnbound

public void valueUnbound(HttpSessionBindingEvent event)

The container calls this method when it is being unbound from the session.

Parameters:

event - @add-javadoc!!!

getDatabaseKey

public org.apache.ojb.broker.PBKey getDatabaseKey()

Returns the key.

Returns:

PBKey

setDatabaseKey

public void setDatabaseKey(org.apache.ojb.broker.PBKey key)

Sets the key.

Parameters:

key - The key to set

getCurrentInstance

public java.lang.Object getCurrentInstance()

Returns the currentInstance.

Returns:

Object

setCurrentInstance

public void setCurrentInstance(java.lang.Object currentInstance)

Sets the currentInstance.

Parameters:

currentInstance - The currentInstance to set

getWindowSize

public java.lang.Integer getWindowSize()

Returns the windowSize.

Returns:

Integer

setWindowSize

public void setWindowSize(java.lang.Integer windowSize)

Sets the windowSize.

Parameters:

windowSize - The windowSize to set

getRepositoryAcl

public RepositoryKeyAcl getRepositoryAcl()

Returns the repositoryAcl.

Returns:

RepositoryKeyAcl

setRepositoryAcl

public void setRepositoryAcl(RepositoryKeyAcl repositoryAcl)

Sets the repositoryAcl.

Parameters:

repositoryAcl - The repositoryAcl to set

putUserObject

public java.lang.String putUserObject(java.lang.Object obj)

Method putUserObject @add-javadoc!!!

Parameters:

obj - @add-javadoc!!!

Returns:

@add-javadoc!!!

putUserObject

public void putUserObject(java.lang.String uid,
                          java.lang.Object obj)

Method putUserObject @add-javadoc!!!

Parameters:

uid - @add-javadoc!!!

obj - @add-javadoc!!!

removeUserObject

public void removeUserObject(java.lang.String uid)

Method removeUserObject @add-javadoc!!!

Parameters:

uid - @add-javadoc!!!

getUserObject

public java.lang.Object getUserObject(java.lang.String uid)

Method getUserObject @add-javadoc!!!

Parameters:

uid - @add-javadoc!!!

Returns:

@add-javadoc!!!

getUserObjects

public UserObjectCache getUserObjects()

Returns the userObjects.

Returns:

UserObjectCache

setUserObjects

public void setUserObjects(UserObjectCache userObjects)

Sets the userObjects.

Parameters:

userObjects - The userObjects to set

getUserRepositoryList

public UserRepositoryList getUserRepositoryList()

Returns:

setUserRepositoryList

public void setUserRepositoryList(UserRepositoryList list)

Parameters:

list -