Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.ldap
Class LdapAuthFactory

java.lang.Object
  extended by com.jivesoftware.base.AuthFactory
      extended by com.jivesoftware.base.ldap.LdapAuthFactory

public class LdapAuthFactory
extends AuthFactory

A AuthFactory implementation that uses LDAP to verify the username and password. If it's the first time that an LDAP user has logged into Jive, then a database record is automatically created for them.

To use this AuthFactory, you must set the Jive property AuthFactory.className to "com.jivesoftware.forum.ldap.LdapAuthFactory".


Field Summary
 
Fields inherited from class com.jivesoftware.base.AuthFactory
cipher, COOKIE_AUTOLOGIN, COOKIE_JIVE_SERVER_INFO, COOKIE_LOGGED_IN, SESSION_AUTHORIZATION
 
Constructor Summary
LdapAuthFactory()
           
 
Method Summary
 AuthToken createAnonymousAuthToken()
          Creates anonymous AuthToken tokens.
 AuthToken createAuthToken(java.lang.String username, java.lang.String password)
          Creates AuthToken tokens for users.
 
Methods inherited from class com.jivesoftware.base.AuthFactory
addServerInfoCookie, checkAuthorization, checkIfBanned, clearSessionUserInfo, createAuthToken, createSessionUserInfo, decryptAuthInfo, encryptAuthInfo, forceReload, getAnonymousAuthToken, getAuthToken, getAuthToken, getServerInfoCookieProperty, loginUser, logoutUser
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LdapAuthFactory

public LdapAuthFactory()
Method Detail

createAuthToken

public AuthToken createAuthToken(java.lang.String username,
                                 java.lang.String password)
                          throws UnauthorizedException
Description copied from class: AuthFactory
Creates AuthToken tokens for users. This method must be implemented by concrete subclasses of AuthFactory.

Specified by:
createAuthToken in class AuthFactory
Parameters:
username - the username to create an AuthToken with.
password - the password to create an AuthToken with.
Returns:
an AuthToken token if the username and password are correct.
Throws:
UnauthorizedException - if the username and password do not match any existing user.

createAnonymousAuthToken

public AuthToken createAnonymousAuthToken()
Description copied from class: AuthFactory
Creates anonymous AuthToken tokens. This method must be implemented by concrete subclasses AuthFactory.

Specified by:
createAnonymousAuthToken in class AuthFactory
Returns:
an anonymous AuthToken token.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.