com.tsgrp.opencontent.elasticsearch.authentication

Class ElasticsearchAuthenticationImpl

java.lang.Object

com.tsgrp.opencontent.elasticsearch.authentication.ElasticsearchAuthenticationImpl

All Implemented Interfaces:

IAuthentication

public class ElasticsearchAuthenticationImpl
extends java.lang.Object
implements IAuthentication

Nested Class Summary

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

IAuthentication.RunAsWork<Result>

Method Summary

Modifier and Type	Method and Description
boolean	endSession(java.lang.String ticket) Terminate the session with 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	getSessionForUser(java.lang.String userName) This is for SSO by authenticating based on a user
AuthenticationResult	newSession(java.lang.String username, java.lang.String password, java.lang.String domain, java.lang.String docbase) Create a new ticket object used for connections to the docbase with the given credentials.
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.
<R> R	runAsAdmin(IAuthentication.RunAsWork<R> runAsWork) This code is to be used extremely sparingly.
java.lang.String	runAsUser(java.lang.String userName) This code is to be used extremely sparingly.
boolean	validateSession(java.lang.String ticket) Validate Session checks ticket in case it is null or empty from the session If we're using LDAPAuthentication it actually checks our map to see if the ticket exists

Methods inherited from class java.lang.Object

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

Method Detail

endSession

public boolean endSession(java.lang.String ticket)

Description copied from interface: IAuthentication

Terminate the session with given ticket. The return code indicates whether the method call was successful; if called with a valid ticket, it should return true. Any further calls to the method with the now-invalid ticket will return false.

Specified by:

endSession in interface IAuthentication

Parameters:

ticket - a ticket obtained via IAuthentication.newSession(String, String, String, String) or IAuthentication.newSessionSimple(String, String, String).

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)

Description copied from interface: IAuthentication

Create a new ticket object used for connections to the docbase with the given credentials.

Specified by:

newSession in interface IAuthentication

Parameters:

username - username

password - password

domain - domain name

docbase - name of docbase

Returns:

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

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 in case it is null or empty from the session If we're using LDAPAuthentication it actually checks our map to see if the ticket exists

Specified by:

validateSession in interface IAuthentication

Parameters:

{String} - ticket

Returns:

{boolean} true if the ticket is valid, false otherwise

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

runAsAdmin

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

Description copied from interface: IAuthentication

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

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