站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.4 API 英文版文档

UserModuleImpl - JBOSS Portal 2.4 API 英文版文档


org.jboss.portal.identity.db
Class UserModuleImpl

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport
      extended byorg.jboss.system.ServiceMBeanSupport
          extended byorg.jboss.portal.common.system.AbstractJBossService
              extended byorg.jboss.portal.identity.db.UserModuleImpl
All Implemented Interfaces:
javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, org.jboss.system.Service, org.jboss.system.ServiceMBean, UserModule

public class UserModuleImpl
extends AbstractJBossService
implements UserModule


Field Summary
protected  JNDI.Binding jndiBinding
          .
protected  java.lang.String jndiName
          .
protected  org.hibernate.SessionFactory sessionFactory
          .
protected  java.lang.String sessionFactoryJNDIName
          .
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport
server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from interface org.jboss.system.ServiceMBean
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
UserModuleImpl()
           
 
Method Summary
 User createUser(java.lang.String userName, java.lang.String password, java.lang.String realEmail)
          Creates a new user with the specified name.
 User findUserById(java.lang.Object id)
          Retrieve a user by its id.
 User findUserById(java.lang.String id)
          Retrieve a user by its id.
 User findUserByUserName(java.lang.String userName)
          Retrieve a user by its name.
 java.util.Set findUsers(int offset, int limit)
          Get a range of users.
 java.util.Set findUsersFilteredByUserName(java.lang.String filter, int offset, int limit)
          Get a range of users.
protected  org.hibernate.Session getCurrentSession()
          Can be subclasses to provide testing in a non JTA environement.
 java.lang.String getJNDIName()
           
 org.hibernate.SessionFactory getSessionFactory()
           
 java.lang.String getSessionFactoryJNDIName()
           
 int getUserCount()
          Returns the number of users.
 void removeUser(java.lang.Object id)
          Remove a user.
 void setJNDIName(java.lang.String jndiName)
           
 void setSessionFactoryJNDIName(java.lang.String sessionFactoryJNDIName)
           
protected  void startService()
           
protected  void stopService()
           
 
Methods inherited from class org.jboss.portal.common.system.AbstractJBossService
create, destroy, getState, getStateString, start, stop
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport
createService, destroyService, getDeploymentInfo, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport
addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

sessionFactory

protected org.hibernate.SessionFactory sessionFactory
.


sessionFactoryJNDIName

protected java.lang.String sessionFactoryJNDIName
.


jndiName

protected java.lang.String jndiName
.


jndiBinding

protected JNDI.Binding jndiBinding
.

Constructor Detail

UserModuleImpl

public UserModuleImpl()
Method Detail

startService

protected void startService()
                     throws java.lang.Exception
Throws:
java.lang.Exception

stopService

protected void stopService()
                    throws java.lang.Exception
Throws:
java.lang.Exception

getSessionFactory

public org.hibernate.SessionFactory getSessionFactory()

getSessionFactoryJNDIName

public java.lang.String getSessionFactoryJNDIName()

setSessionFactoryJNDIName

public void setSessionFactoryJNDIName(java.lang.String sessionFactoryJNDIName)

getJNDIName

public java.lang.String getJNDIName()

setJNDIName

public void setJNDIName(java.lang.String jndiName)

findUserByUserName

public User findUserByUserName(java.lang.String userName)
                        throws IdentityException
Description copied from interface: UserModule
Retrieve a user by its name.

Specified by:
findUserByUserName in interface UserModule
Parameters:
userName - the user name
Returns:
the user
Throws:
IdentityException

findUserById

public User findUserById(java.lang.String id)
                  throws java.lang.IllegalArgumentException,
                         IdentityException,
                         NoSuchUserException
Description copied from interface: UserModule
Retrieve a user by its id.

Specified by:
findUserById in interface UserModule
Parameters:
id - the user id
Returns:
the user
Throws:
java.lang.IllegalArgumentException - if the id is null or not in the good format
IdentityException
NoSuchUserException

findUserById

public User findUserById(java.lang.Object id)
                  throws java.lang.IllegalArgumentException,
                         IdentityException,
                         NoSuchUserException
Description copied from interface: UserModule
Retrieve a user by its id.

Specified by:
findUserById in interface UserModule
Parameters:
id - the user id
Returns:
the user
Throws:
java.lang.IllegalArgumentException - if the id is null
IdentityException
NoSuchUserException

createUser

public User createUser(java.lang.String userName,
                       java.lang.String password,
                       java.lang.String realEmail)
                throws IdentityException
Description copied from interface: UserModule
Creates a new user with the specified name.

Specified by:
createUser in interface UserModule
Parameters:
userName -
Returns:
the user
Throws:
IdentityException

removeUser

public void removeUser(java.lang.Object id)
                throws IdentityException
Description copied from interface: UserModule
Remove a user.

Specified by:
removeUser in interface UserModule
Parameters:
id - the user id
Throws:
IdentityException

findUsers

public java.util.Set findUsers(int offset,
                               int limit)
                        throws IdentityException
Description copied from interface: UserModule
Get a range of users.

Specified by:
findUsers in interface UserModule
Parameters:
offset - the offset of the first result to retrieve
limit - the maximum number of users to retrieve
Returns:
the user set
Throws:
IdentityException

findUsersFilteredByUserName

public java.util.Set findUsersFilteredByUserName(java.lang.String filter,
                                                 int offset,
                                                 int limit)
                                          throws IdentityException
Description copied from interface: UserModule
Get a range of users.

Specified by:
findUsersFilteredByUserName in interface UserModule
Parameters:
filter - a string filter applied to the user name.
offset - the offset of the frist result to retrieve
limit - the maximum number of users to retrieve
Returns:
the user set
Throws:
IdentityException

getUserCount

public int getUserCount()
                 throws IdentityException
Description copied from interface: UserModule
Returns the number of users.

Specified by:
getUserCount in interface UserModule
Returns:
the number of users
Throws:
IdentityException

getCurrentSession

protected org.hibernate.Session getCurrentSession()
                                           throws java.lang.IllegalStateException
Can be subclasses to provide testing in a non JTA environement.

Throws:
java.lang.IllegalStateException - if no session factory is present