org.benow.repository.security
Class UserModuleImpl

java.lang.Object
  extended by org.benow.security.SecureObject
      extended by org.benow.repository.util.PersistentObjectImpl
          extended by org.benow.repository.mapping.JSQLObject
              extended by org.benow.repository.security.UserModuleImpl
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable, org.benow.java.config.Configurable, PersistentObject, org.benow.security.user.UserModule
Direct Known Subclasses:
LanguageUserModuleImpl

public abstract class UserModuleImpl
extends JSQLObject
implements org.benow.security.user.UserModule

User modules hold certain information relevant to a user. They may have a Position annotation (on the class) to determine display order amongst other modules.

Author:
andy
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.benow.repository.mapping.JSQLObject
JSQLObject.XSQLVersionDesc, JSQLObject.XSQLVersioned
 
Field Summary
protected static org.apache.log4j.Logger log
           
protected  UserImpl user
           
 
Fields inherited from class org.benow.repository.util.PersistentObjectImpl
conn, recycled
 
Fields inherited from class org.benow.security.SecureObject
admin
 
Fields inherited from interface org.benow.repository.util.PersistentObject
FIELD_NAME_KEY
 
Constructor Summary
protected UserModuleImpl()
           
  UserModuleImpl(org.benow.security.user.User user)
           
 
Method Summary
 boolean allowDuringConfiguration(java.lang.String uri)
           
static java.lang.String getClassDisplayName(java.lang.Class<? extends org.benow.security.user.UserModule> curr)
          Returns the display name for the given class.
 java.lang.String getConfigURI()
          Gets uri to a configuration for this module, if not configured.
 java.lang.String getDisplayName()
           
 org.benow.security.user.User getOwner()
           
 int getPosition()
           
 org.benow.security.user.User getUser()
          synonym for getOwner
 java.lang.String getXMLNodeName()
           
 boolean isComplete()
           
 void setOwner(org.benow.security.user.User owner)
           
 
Methods inherited from class org.benow.repository.mapping.JSQLObject
fetchExpectedField, fetchField, fetchFieldQuiet, forgetField, isFetched, isLocked, lock, refetchFieldQuiet, setFetched
 
Methods inherited from class org.benow.repository.util.PersistentObjectImpl
compareTo, doIsTransient, equals, getKey, isTransient, recycle, remove, remove, repositoryAfterLoad, repositoryAfterPersist, repositoryAfterTransient, repositoryBeforePersist, repositoryBeforeTransient, setKey, toString, update, update
 
Methods inherited from class org.benow.security.SecureObject
assertOnePermission, assertPermission, assertPermission, declarePermission, declareViewPermission, declareViewPermission
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

log

protected static org.apache.log4j.Logger log

user

protected UserImpl user
Constructor Detail

UserModuleImpl

protected UserModuleImpl()

UserModuleImpl

public UserModuleImpl(org.benow.security.user.User user)
Method Detail

getXMLNodeName

public java.lang.String getXMLNodeName()

getUser

public org.benow.security.user.User getUser()
synonym for getOwner


getOwner

public org.benow.security.user.User getOwner()
Specified by:
getOwner in interface org.benow.security.user.UserModule

setOwner

public void setOwner(org.benow.security.user.User owner)
Specified by:
setOwner in interface org.benow.security.user.UserModule

isComplete

public boolean isComplete()
Specified by:
isComplete in interface org.benow.java.config.Configurable

getDisplayName

public java.lang.String getDisplayName()

getPosition

public int getPosition()

getClassDisplayName

public static java.lang.String getClassDisplayName(java.lang.Class<? extends org.benow.security.user.UserModule> curr)
Returns the display name for the given class. The value of the display annotation, if any, or the simple name of the class with the following applied

Parameters:
curr -
Returns:

getConfigURI

public java.lang.String getConfigURI()
Gets uri to a configuration for this module, if not configured.

Specified by:
getConfigURI in interface org.benow.java.config.Configurable
Returns:
uri for configuration, or null if fully configured

allowDuringConfiguration

public boolean allowDuringConfiguration(java.lang.String uri)
Specified by:
allowDuringConfiguration in interface org.benow.java.config.Configurable