com.tsgrp.opencontent.dctm.authentication

Class DCTMAuthenticationImpl

java.lang.Object

com.tsgrp.opencontent.dctm.authentication.DCTMAuthenticationImpl

All Implemented Interfaces:

IAuthentication

public class DCTMAuthenticationImpl
extends java.lang.Object
implements IAuthentication

Methods to support authentication with the backend Documentum docbase. 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>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DCTMAuthenticationImpl()

Method Summary

Modifier and Type	Method and Description
boolean	endSession(java.lang.String ticket) End the Documentum session with 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	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

Methods inherited from class java.lang.Object

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

Constructor Detail

DCTMAuthenticationImpl

protected DCTMAuthenticationImpl()

Method Detail

newSessionSimple

public 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.

Specified by:

newSessionSimple in interface IAuthentication

Parameters:

username -

password -

docbase - the Documentum docbase to authenticate against

Returns:

an authentication ticket with supplemental information in case an error occurred

newSession

public 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. This method is used to begin a new "session" with Documentum, which involves authenticating with the docbase and establishing the first steps of a connection. Note - if a docbase is blank, this method will attempt to connect to the repository specified in the dctm.dictionary.repository property.

Specified by:

newSession in interface IAuthentication

Parameters:

username -

password -

domain - the Windows domain the user is associated with

docbase - the Documentum docbase to authenticate against

Returns:

an authentication ticket with supplemental information in case an error occurred

endSession

public boolean endSession(java.lang.String ticket)

End the Documentum session with the 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 newSession(String, String, String, String) or newSessionSimple(String, String, String).

Returns:

whether the session could be correctly ended

validateSession

public boolean validateSession(java.lang.String ticket)

Determine whether a given ticket is currently valid to use

Specified by:

validateSession in interface IAuthentication

Parameters:

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

Returns:

whether the ticket is valid and could be used by other Services

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

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