com.tsgrp.opencontent.core.authentication

Interface IAuthentication

All Known Implementing Classes:

AlfrescoEmbAuthenticationImpl, DCTMAuthenticationImpl, DynamoAuthenticationImpl, ElasticsearchAuthenticationImpl, HBaseAuthenticationImpl, LDAPAuthenticationImpl, S3AuthenticationImpl, SolrAuthenticationImpl

public interface IAuthentication

Interface for authentication-related methods

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IAuthentication.RunAsWork<Result> Interface that allows us to pass an anonymous function to runAsAdmin.

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 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) Determine whether a given ticket is currently valid to use

Method Detail

newSessionSimple

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

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

Parameters:

username - username

password - password

docbase - name of docbase

Returns:

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

newSession

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.

Parameters:

username - username

password - password

domain - domain name

docbase - name of docbase

Returns:

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

endSession

boolean endSession(java.lang.String ticket)

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.

Parameters:

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

Returns:

True if session ended, False otherwise

validateSession

boolean validateSession(java.lang.String ticket)

Determine whether a given ticket is currently valid to use

Parameters:

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

Returns:

True if the ticket is valid and could be used by other Services, False otherwise

getLoginTicket

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

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

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

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.

Parameters:

runAsWork -

Returns:

R

runAsUser

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

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.

Parameters:

userName -

Returns:

ticket retrieved as the passed in user

getSessionForUser

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

This is for SSO by authenticating based on a user

Parameters:

userName -

Returns:

an OC ticket for the given user name