Java Doc for LDAPUser.java in » Web-Framework » TURBINE » org » apache » turbine » services » security » ldap » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » TURBINE » org.apache.turbine.services.security.ldap

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.turbine.services.security.ldap .LDAPUser

All known Subclasses:   org.apache.turbine.services.security.ldap .ActiveDirectoryUser,
LDAPUser
public class LDAPUser extends BaseObject implements User(Code)
LDAPUser implements User and provides access to a user who accesses the system via LDAP.
author:
   Craig D. Berry
author:
   Tracy M. Adewunmi
author:
   Leonard J. Flournoy
author:
   Daniel Rall
author:
   Humberto Hernandez
version:
   $Id: LDAPUser.java 534527 2007-05-02 16:10:59Z tv $

Constructor Summary
public LDAPUser()
     Constructor.

Method Summary
public int getAccessCounter()
     Gets the access counter for a user from perm storage.
public int getAccessCounterForSession()
     Gets the access counter for a user during a session.
public String getConfirmed()

public java.util.Date getCreateDate()
     Gets the create date for this User.
public String getDN()
     Gets the distinguished name (DN) of the User.
public String getEmail()
     Returns the Email for this user.
public String getFirstName()
     Returns the first name for this user.
public int getId()
     Not implemented.
public Integer getIdAsObj()
     Not implemented.
public Attributes getLDAPAttributes()
     Get the JNDI Attributes used to store the user in LDAP. This method could be redefined in a subclass.
throws:
  NamingException - if there is a JNDI error.
public java.util.Date getLastAccessDate()
     Gets the last access date for this User.
public java.util.Date getLastLogin()
     Get last login date/time for this user.
public String getLastName()
     Returns the last name for this user.
public String getName()
     Returns the username for this user.
public String getPassword()
     Get password for this user.
public Object getPerm(String name)
     Get an object from permanent storage.
Parameters:
  name - The object's name.
public Object getPerm(String name, Object def)
     Get an object from permanent storage; return default if value is null.
Parameters:
  name - The object's name.
Parameters:
  def - A default value to return.
public Hashtable getPermStorage()
     This should only be used in the case where we want to save the data to the database.
public Object getTemp(String name)
     Get an object from temporary storage.
Parameters:
  name - The object's name.
public Object getTemp(String name, Object def)
     Get an object from temporary storage; return default if value is null.
Parameters:
  name - The object's name.
Parameters:
  def - A default value to return.
public Hashtable getTempStorage()
     This should only be used in the case where we want to save the data to the database.
public int getTimeout()
     A User object can have a variable Timeout, which is defined in minutes.
public String getUserName()
     Returns the username for this user.
public boolean hasLoggedIn()
     The user is considered logged in if they have not timed out.
public void incrementAccessCounter()
     Increments the permanent hit counter for the user.
public void incrementAccessCounterForSession()
     Increments the session hit counter for the user.
public boolean isConfirmed()
     This method reports whether or not the user has been confirmed in the system by checking the CONFIRM_VALUE column to see if it is equal to CONFIRM_DATA.
public Object removeTemp(String name)
     Remove an object from temporary storage and return the object.
Parameters:
  name - The name of the object to remove.
public void save()
     Saves this object to the data store.
public void save(Connection conn)

public void save(String dbname)

public void setAccessCounter(int cnt)
     Sets the access counter for a user, saved in perm storage.
public void setAccessCounterForSession(int cnt)
     Sets the session access counter for a user, saved in temp storage.
public void setConfirmed(String confirm)

public void setCreateDate(java.util.Date date)
     Sets the create date for this User.
public void setEmail(String email)

public void setFirstName(String fname)

public void setHasLoggedIn(Boolean value)
     This sets whether or not someone has logged in.
public void setId(int id)
     Not implemented.
public void setLDAPAttributes(Attributes attribs)
     Populates the user with values obtained from the LDAP Service.
public void setLastAccessDate()
     Sets the last access date for this User.
public void setLastLogin(java.util.Date date)
     Set last login date/time.
public void setLastName(String lname)
     Set the users Last Name Sets the last name for this user.
public void setName(String name)
     Not implemented.
public void setPassword(String password)
     Set password.
public void setPerm(String name, Object value)
     Put an object into permanent storage.
public void setPermStorage(Hashtable stuff)
     This should only be used in the case where we want to save the data to the database.
public void setTemp(String name, Object value)
     Put an object into temporary storage.
public void setTempStorage(Hashtable storage)
     This should only be used in the case where we want to save the data to the database.
public void setTimeout(int time)
     A User object can have a variable Timeout which is defined in minutes.
public void setUserName(String username)
     Sets the username for this user.
public void updateLastLogin()
     Updates the last login date in the database.
public void valueBound(HttpSessionBindingEvent hsbe)
     Implement this method if you wish to be notified when the User has been Bound to the session.
public void valueUnbound(HttpSessionBindingEvent hsbe)
     Implement this method if you wish to be notified when the User has been Unbound from the session.

Constructor Detail
LDAPUser
public LDAPUser()(Code)
Constructor. Create a new User and set the createDate.

Method Detail
getAccessCounter
public int getAccessCounter()(Code)
Gets the access counter for a user from perm storage. The access counter for the user.

getAccessCounterForSession
public int getAccessCounterForSession()(Code)
Gets the access counter for a user during a session. The access counter for the user for the session.

getConfirmed
public String getConfirmed()(Code)
Returns the value of Confirmed variable the confirm value.

getCreateDate
public java.util.Date getCreateDate()(Code)
Gets the create date for this User. This is the time at which the user object was created. A Java Date with the date of creation for the user.

getDN
public String getDN()(Code)
Gets the distinguished name (DN) of the User. This method could be redefined in a subclass. The Distinguished Name of the user.

getEmail
public String getEmail()(Code)
Returns the Email for this user. If this is defined, then the user is considered logged in. A String with the user's Email.

getFirstName
public String getFirstName()(Code)
Returns the first name for this user. If this is defined, then the user is considered logged in. A String with the user's first name.

getId
public int getId()(Code)
Not implemented. 0

getIdAsObj
public Integer getIdAsObj()(Code)
Not implemented. null

getLDAPAttributes
public Attributes getLDAPAttributes() throws NamingException(Code)
Get the JNDI Attributes used to store the user in LDAP. This method could be redefined in a subclass.
throws:
  NamingException - if there is a JNDI error. The JNDI attributes of the user.

getLastAccessDate
public java.util.Date getLastAccessDate()(Code)
Gets the last access date for this User. This is the last time that the user object was referenced. A Java Date with the last access date for the user.

getLastLogin
public java.util.Date getLastLogin()(Code)
Get last login date/time for this user. A Java Date with the last login date for the user.

getLastName
public String getLastName()(Code)
Returns the last name for this user. If this is defined, then the user is considered logged in. A String with the user's last name.

getName
public String getName()(Code)
Returns the username for this user. If this is defined, then the user is considered logged in. A String with the username.

getPassword
public String getPassword()(Code)
Get password for this user. A String with the password for the user.

getPerm
public Object getPerm(String name)(Code)
Get an object from permanent storage.
Parameters:
  name - The object's name. An Object with the given name.

getPerm
public Object getPerm(String name, Object def)(Code)
Get an object from permanent storage; return default if value is null.
Parameters:
  name - The object's name.
Parameters:
  def - A default value to return. An Object with the given name.

getPermStorage
public Hashtable getPermStorage()(Code)
This should only be used in the case where we want to save the data to the database. A Hashtable.

getTemp
public Object getTemp(String name)(Code)
Get an object from temporary storage.
Parameters:
  name - The object's name. An Object with the given name.

getTemp
public Object getTemp(String name, Object def)(Code)
Get an object from temporary storage; return default if value is null.
Parameters:
  name - The object's name.
Parameters:
  def - A default value to return. An Object with the given name.

getTempStorage
public Hashtable getTempStorage()(Code)
This should only be used in the case where we want to save the data to the database. A Hashtable.

getTimeout
public int getTimeout()(Code)
A User object can have a variable Timeout, which is defined in minutes. If the user has been timed out, then the hasLoggedIn() value will return false. An int specifying the timeout.

getUserName
public String getUserName()(Code)
Returns the username for this user. If this is defined, then the user is considered logged in. A String with the username.

hasLoggedIn
public boolean hasLoggedIn()(Code)
The user is considered logged in if they have not timed out. True if the user has logged in.

incrementAccessCounter
public void incrementAccessCounter()(Code)
Increments the permanent hit counter for the user.

incrementAccessCounterForSession
public void incrementAccessCounterForSession()(Code)
Increments the session hit counter for the user.

isConfirmed
public boolean isConfirmed()(Code)
This method reports whether or not the user has been confirmed in the system by checking the CONFIRM_VALUE column to see if it is equal to CONFIRM_DATA. True if the user has been confirmed.

removeTemp
public Object removeTemp(String name)(Code)
Remove an object from temporary storage and return the object.
Parameters:
  name - The name of the object to remove. An Object.

save
public void save() throws Exception(Code)
Saves this object to the data store.
throws:
  Exception - if it cannot be saved

save
public void save(Connection conn) throws Exception(Code)
not implemented
Parameters:
  conn - the database connection
throws:
  Exception - if there is an error

save
public void save(String dbname) throws Exception(Code)
not implemented
Parameters:
  dbname - the database name
throws:
  Exception - if there is an error

setAccessCounter
public void setAccessCounter(int cnt)(Code)
Sets the access counter for a user, saved in perm storage.
Parameters:
  cnt - The new count.

setAccessCounterForSession
public void setAccessCounterForSession(int cnt)(Code)
Sets the session access counter for a user, saved in temp storage.
Parameters:
  cnt - The new count.

setConfirmed
public void setConfirmed(String confirm)(Code)
Set the users confirmed variable
Parameters:
  confirm - The new confim value.

setCreateDate
public void setCreateDate(java.util.Date date)(Code)
Sets the create date for this User. This is the time at which the user object was created.
Parameters:
  date - The create date.

setEmail
public void setEmail(String email)(Code)
Set the users Email
Parameters:
  email - The new email.

setFirstName
public void setFirstName(String fname)(Code)
Set the users First Name
Parameters:
  fname - The new firstname.

setHasLoggedIn
public void setHasLoggedIn(Boolean value)(Code)
This sets whether or not someone has logged in. hasLoggedIn() returns this value.
Parameters:
  value - Whether someone has logged in or not.

setId
public void setId(int id)(Code)
Not implemented.
Parameters:
  id - The id of the User.

setLDAPAttributes
public void setLDAPAttributes(Attributes attribs) throws NamingException(Code)
Populates the user with values obtained from the LDAP Service. This method could be redefined in subclasses.
Parameters:
  attribs - The attributes obtained from LDAP.
throws:
  NamingException - if there was an error with JNDI.

setLastAccessDate
public void setLastAccessDate()(Code)
Sets the last access date for this User. This is the last time that the user object was referenced.

setLastLogin
public void setLastLogin(java.util.Date date)(Code)
Set last login date/time.
Parameters:
  date - The last login date.

setLastName
public void setLastName(String lname)(Code)
Set the users Last Name Sets the last name for this user.
Parameters:
  lname - The new lastname.

setName
public void setName(String name)(Code)
Not implemented.
Parameters:
  name - the name of the User.

setPassword
public void setPassword(String password)(Code)
Set password.
Parameters:
  password - The new password.

setPerm
public void setPerm(String name, Object value)(Code)
Put an object into permanent storage.
Parameters:
  name - The object's name.
Parameters:
  value - The object.

setPermStorage
public void setPermStorage(Hashtable stuff)(Code)
This should only be used in the case where we want to save the data to the database.
Parameters:
  stuff - A Hashtable.

setTemp
public void setTemp(String name, Object value)(Code)
Put an object into temporary storage.
Parameters:
  name - The object's name.
Parameters:
  value - The object.

setTempStorage
public void setTempStorage(Hashtable storage)(Code)
This should only be used in the case where we want to save the data to the database.
Parameters:
  storage - A Hashtable.

setTimeout
public void setTimeout(int time)(Code)
A User object can have a variable Timeout which is defined in minutes. If the user has been timed out, then the hasLoggedIn() value will return false.
Parameters:
  time - The user's timeout.

setUserName
public void setUserName(String username)(Code)
Sets the username for this user.
Parameters:
  username - The user's username.

updateLastLogin
public void updateLastLogin() throws Exception(Code)
Updates the last login date in the database.
exception:
  Exception - a generic exception.

valueBound
public void valueBound(HttpSessionBindingEvent hsbe)(Code)
Implement this method if you wish to be notified when the User has been Bound to the session.
Parameters:
  hsbe - The HttpSessionBindingEvent.

valueUnbound
public void valueUnbound(HttpSessionBindingEvent hsbe)(Code)
Implement this method if you wish to be notified when the User has been Unbound from the session.
Parameters:
  hsbe - The HttpSessionBindingEvent.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.