com.tsgrp.opencontent.ldap.authentication

Class LDAPAuthenticationImpl

java.lang.Object

com.tsgrp.opencontent.core.user.InMemoryAbstractAuthentication

com.tsgrp.opencontent.ldap.authentication.LDAPAuthenticationImpl

All Implemented Interfaces:

IAuthentication

public class LDAPAuthenticationImpl
extends InMemoryAbstractAuthentication
implements IAuthentication

LDAP authentication method stubs A ticket acquired from newSession(String, String, String, String) is required for just about every Service available.

Nested Class Summary

Nested classes/interfaces inherited from interface com.tsgrp.opencontent.core.authentication.IAuthentication

IAuthentication.RunAsWork<Result>

Field Summary

Fields

Modifier and Type	Field and Description
protected LDAPConfig	config

Method Summary

Modifier and Type	Method and Description
void	cleanupTickets() Remove stored LDAP sessions older than expiration time span.
boolean	containsTicket(java.lang.String ticket) Determines whether the session ticket is active.
boolean	endSession(java.lang.String ticket) Ends the session for the given ticket.
AuthenticationResult	getLoginTicket(java.lang.String superUserName, java.lang.String password, java.lang.String userName, java.lang.String docBase) Retrieve a user's login ticket via a superuser
java.lang.String	getNewTicketId()
java.lang.String	getSessionForUser(java.lang.String userName) This is for SSO by authenticating based on a user
UserBean	getUserFromTicket(java.lang.String ticket) Helper method to look up the UserBean for the ticket that is passed in
AuthenticationResult	newSession(java.lang.String username, java.lang.String password, java.lang.String domain, java.lang.String docbase) Creates a new session for the input user
AuthenticationResult	newSessionSimple(java.lang.String username, java.lang.String password, java.lang.String docbase) A wrapper around the more complex IAuthentication.newSession(String, String, String, String) which omits the domain parameter.
boolean	removeTicket(java.lang.String ticket) Remove an LDAP session.
<R> R	runAsAdmin(IAuthentication.RunAsWork<R> runAsWork) Unimplemented
java.lang.String	runAsUser(java.lang.String userName) This code is to be used extremely sparingly.
void	setLdapConfig(LDAPConfig config)
void	setTicket(java.lang.String ticket, UserBean userBean) Store a new session.
boolean	validateSession(java.lang.String ticket) Validate Session checks ticket incase it is null or empty from the session

Methods inherited from class java.lang.Object

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

Field Detail

config

protected LDAPConfig config

Method Detail

setLdapConfig

public void setLdapConfig(LDAPConfig config)

endSession

public boolean endSession(java.lang.String ticket)

Ends the session for the given ticket.

Specified by:

endSession in interface IAuthentication

Parameters:

ticket - The ticket to be removed from the service.

Returns:

True if session ended, False otherwise

See Also:

IAuthentication.endSession(java.lang.String)

newSession

public AuthenticationResult newSession(java.lang.String username,
                                       java.lang.String password,
                                       java.lang.String domain,
                                       java.lang.String docbase)

Creates a new session for the input user

Specified by:

newSession in interface IAuthentication

Parameters:

username - Username to be authenticated

password - Password for the given username

domain - This actually doesn't do anything for this implementation!

docbase - This isn't used either...

Returns:

authenticationResult will include a ticket and a valid flag of 'true' if authentication was successful

See Also:

IAuthentication.newSession(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

newSessionSimple

public AuthenticationResult newSessionSimple(java.lang.String username,
                                             java.lang.String password,
                                             java.lang.String docbase)

Description copied from interface: IAuthentication

A wrapper around the more complex IAuthentication.newSession(String, String, String, String) which omits the domain parameter. An empty string is used for the domain.

Specified by:

newSessionSimple in interface IAuthentication

Parameters:

username - username

password - password

docbase - name of docbase

Returns:

• AuthenticationResult
• error equals true if method failed, otherwise false

See Also:

IAuthentication.newSessionSimple(java.lang.String, java.lang.String, java.lang.String)

validateSession

public boolean validateSession(java.lang.String ticket)

Validate Session checks ticket incase it is null or empty from the session

Specified by:

validateSession in interface IAuthentication

Parameters:

ticket - - The ticket string requiring validation

Returns:

boolean -Ticket is valid or invalid

See Also:

IAuthentication.validateSession(java.lang.String)

getLoginTicket

public AuthenticationResult getLoginTicket(java.lang.String superUserName,
                                           java.lang.String password,
                                           java.lang.String userName,
                                           java.lang.String docBase)

Description copied from interface: IAuthentication

Retrieve a user's login ticket via a superuser

Specified by:

getLoginTicket in interface IAuthentication

Parameters:

superUserName - username of a superuser in the docbase

password - password for the superuser in the docbase

userName - user whose ticket is being retrieved

docBase - name of docbase

Returns:

• AuthenticationResult
• error returns true if method failed, otherwise false

setTicket

public void setTicket(java.lang.String ticket,
                      UserBean userBean)

Store a new session.

Parameters:

ticket - Unique ticket that identifies this session

directoryUrl - URL of the active directory

Throws:

java.lang.IllegalArgumentException - if the specified ticket already exists

removeTicket

public boolean removeTicket(java.lang.String ticket)

Remove an LDAP session.

Parameters:

ticket - Unique ticket that identifies this session

Returns:

whether ticket existed and was removed

containsTicket

public boolean containsTicket(java.lang.String ticket)

Determines whether the session ticket is active.

Parameters:

ticket - the ticket we wish to validate

Returns:

true iff the session is found

getNewTicketId

public java.lang.String getNewTicketId()

cleanupTickets

public void cleanupTickets()

Remove stored LDAP sessions older than expiration time span.

getUserFromTicket

public UserBean getUserFromTicket(java.lang.String ticket)

Helper method to look up the UserBean for the ticket that is passed in

Specified by:

getUserFromTicket in class InMemoryAbstractAuthentication

Parameters:

ticket -

Returns:

UserBean for the currently logged in user

runAsAdmin

public <R> R runAsAdmin(IAuthentication.RunAsWork<R> runAsWork)

Unimplemented

Specified by:

runAsAdmin in interface IAuthentication

Returns:

R

See Also:

IAuthentication.runAsAdmin(com.tsgrp.opencontent.core.authentication.IAuthentication.RunAsWork)

runAsUser

public java.lang.String runAsUser(java.lang.String userName)

Description copied from interface: IAuthentication

This code is to be used extremely sparingly. Allows you to run OC code as a passed in user. Please talk to the OC product manager before using this code all willy-nilly, or really, even just nilly.

Specified by:

runAsUser in interface IAuthentication

Returns:

ticket retrieved as the passed in user

getSessionForUser

public java.lang.String getSessionForUser(java.lang.String userName)

Description copied from interface: IAuthentication

This is for SSO by authenticating based on a user

Specified by:

getSessionForUser in interface IAuthentication

Returns:

an OC ticket for the given user name