org.pentaho.di.repository.kdr

Class KettleDatabaseRepositorySecurityProvider

java.lang.Object

org.pentaho.di.repository.BaseRepositorySecurityProvider

org.pentaho.di.repository.kdr.KettleDatabaseRepositorySecurityProvider

All Implemented Interfaces:

IRepositoryService, RepositorySecurityManager, RepositorySecurityProvider, RepositorySecurityUserValidator

public class KettleDatabaseRepositorySecurityProvider
extends BaseRepositorySecurityProvider
implements RepositorySecurityProvider, RepositorySecurityManager, RepositorySecurityUserValidator

Field Summary

Fields inherited from class org.pentaho.di.repository.BaseRepositorySecurityProvider

repositoryMeta, userInfo

Fields inherited from interface org.pentaho.di.repository.RepositorySecurityProvider

ADMINISTER_SECURITY_ACTION, ADMINISTER_SECURITY_ROLE, CREATE_CONTENT_ACTION, CREATE_CONTENT_ROLE, EXECUTE_CONTENT_ACTION, NAMESPACE, READ_CONTENT_ACTION, READ_CONTENT_ROLE, SCHEDULE_CONTENT_ACTION

Constructor Summary

Constructors

Constructor and Description
KettleDatabaseRepositorySecurityProvider(KettleDatabaseRepository repository, RepositoryMeta repositoryMeta, IUser userInfo)

Method Summary

Modifier and Type	Method and Description
boolean	allowsVersionComments(String fullPath)
IUser	constructUser()
void	deleteUsers(List<IUser> users)
void	delUser(ObjectId id_user)
void	delUser(String name)
List<String>	getAllRoles() Retrieves all roles in the system
List<String>	getAllUsers() Retrieves all users in the system
ObjectId	getUserID(String login)
ObjectId[]	getUserIDs()
String[]	getUserLogins()
List<IUser>	getUsers()
boolean	isLockingPossible()
boolean	isManaged()
boolean	isReadOnly()
boolean	isVersionCommentMandatory()
boolean	isVersioningEnabled(String fullPath) Determines whether versioning should be enabled in the UI for the given fully qualified file/path.
IUser	loadUserInfo(String login)
void	normalizeUserInfo(IUser user) Performs normalization over user due to validation rules. Note: normalized is not guaranteed to pass validation rules
void	renameUser(ObjectId id_user, String newname)
void	saveUserInfo(IUser userInfo) This method creates new user after all validations have been done.
void	setUsers(List<IUser> users)
void	updateUser(IUser user)
void	validateAction(RepositoryOperation... operations) Validates the supplied operation.
boolean	validateUserInfo(IUser user) Validates user and returns true if all its data is valid. Note: this method performs fail-fast approach and does not return any details.

Methods inherited from class org.pentaho.di.repository.BaseRepositorySecurityProvider

getRepositoryMeta, getUserInfo, setRepositoryMeta

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.repository.RepositorySecurityProvider

getUserInfo

Constructor Detail

KettleDatabaseRepositorySecurityProvider

public KettleDatabaseRepositorySecurityProvider(KettleDatabaseRepository repository,
                                                RepositoryMeta repositoryMeta,
                                                IUser userInfo)

Parameters:

repository -

userInfo -

Method Detail

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface RepositorySecurityProvider

Returns:

true if the repository or the user is read only

isLockingPossible

public boolean isLockingPossible()

Specified by:

isLockingPossible in interface RepositorySecurityProvider

Returns:

true if this repository supports file locking and if the user is allowed to lock a file

allowsVersionComments

public boolean allowsVersionComments(String fullPath)

Specified by:

allowsVersionComments in interface RepositorySecurityProvider

Returns:

true if the repository supports revisions AND if it is possible to give version comments

isVersionCommentMandatory

public boolean isVersionCommentMandatory()

Specified by:

isVersionCommentMandatory in interface RepositorySecurityProvider

Returns:

true if version comments are mandatory if allowed.

loadUserInfo

public IUser loadUserInfo(String login)
                   throws KettleException

Specified by:

loadUserInfo in interface RepositorySecurityManager

Throws:

KettleException

saveUserInfo

public void saveUserInfo(IUser userInfo)
                  throws KettleException

This method creates new user after all validations have been done. For updating user's data please use updateUser(IUser).

Specified by:

saveUserInfo in interface RepositorySecurityManager

Parameters:

userInfo - user's info

Throws:

KettleException

IllegalArgumentException - if userInfo.getObjectId() != null

validateAction

public void validateAction(RepositoryOperation... operations)
                    throws KettleException,
                           KettleSecurityException

Description copied from interface: RepositorySecurityProvider

Validates the supplied operation.

Specified by:

validateAction in interface RepositorySecurityProvider

Overrides:

validateAction in class BaseRepositorySecurityProvider

Throws:

KettleSecurityException - in case the provided user is not know or the password is incorrect

KettleException - in case the action couldn't be validated because of an unexpected problem.

delUser

public void delUser(ObjectId id_user)
             throws KettleException

Specified by:

delUser in interface RepositorySecurityManager

Throws:

KettleException

getUserID

public ObjectId getUserID(String login)
                   throws KettleException

Specified by:

getUserID in interface RepositorySecurityManager

Throws:

KettleException

getUserIDs

public ObjectId[] getUserIDs()
                      throws KettleException

Specified by:

getUserIDs in interface RepositorySecurityManager

Throws:

KettleException

getUserLogins

public String[] getUserLogins()
                       throws KettleException

Specified by:

getUserLogins in interface RepositorySecurityProvider

Throws:

KettleException

renameUser

public void renameUser(ObjectId id_user,
                       String newname)
                throws KettleException

Specified by:

renameUser in interface RepositorySecurityManager

Throws:

KettleException

deleteUsers

public void deleteUsers(List<IUser> users)
                 throws KettleException

Specified by:

deleteUsers in interface RepositorySecurityManager

Throws:

KettleException

getUsers

public List<IUser> getUsers()
                     throws KettleException

Specified by:

getUsers in interface RepositorySecurityManager

Throws:

KettleException

setUsers

public void setUsers(List<IUser> users)
              throws KettleException

Specified by:

setUsers in interface RepositorySecurityManager

Throws:

KettleException

delUser

public void delUser(String name)
             throws KettleException

Specified by:

delUser in interface RepositorySecurityManager

Throws:

KettleException

updateUser

public void updateUser(IUser user)
                throws KettleException

Specified by:

updateUser in interface RepositorySecurityManager

Throws:

KettleException

constructUser

public IUser constructUser()
                    throws KettleException

Specified by:

constructUser in interface RepositorySecurityManager

Throws:

KettleException

getAllRoles

public List<String> getAllRoles()
                         throws KettleException

Description copied from interface: RepositorySecurityProvider

Retrieves all roles in the system

Specified by:

getAllRoles in interface RepositorySecurityProvider

Returns:

list of role

Throws:

KettleSecurityException - in case anything went wrong

KettleException

getAllUsers

public List<String> getAllUsers()
                         throws KettleException

Description copied from interface: RepositorySecurityProvider

Retrieves all users in the system

Specified by:

getAllUsers in interface RepositorySecurityProvider

Returns:

list of username

Throws:

KettleSecurityException - in case anything went wrong

KettleException

isManaged

public boolean isManaged()
                  throws KettleException

Specified by:

isManaged in interface RepositorySecurityManager

Throws:

KettleException

isVersioningEnabled

public boolean isVersioningEnabled(String fullPath)

Description copied from interface: RepositorySecurityProvider

Determines whether versioning should be enabled in the UI for the given fully qualified file/path. If set to false, the repository may still support versioning, but the versioning will not be apparent in the UI.

Specified by:

isVersioningEnabled in interface RepositorySecurityProvider

Returns:

true if version are enabled, false if they if are not

validateUserInfo

public boolean validateUserInfo(IUser user)

Description copied from interface: RepositorySecurityUserValidator

Validates user and returns true if all its data is valid.
Note: this method performs fail-fast approach and does not return any details.

Specified by:

validateUserInfo in interface RepositorySecurityUserValidator

Parameters:

user - user's info

Returns:

true or false depending on whether or not user's info is valid

normalizeUserInfo

public void normalizeUserInfo(IUser user)

Description copied from interface: RepositorySecurityUserValidator

Performs normalization over user due to validation rules.
Note: normalized is not guaranteed to pass validation rules

Specified by:

normalizeUserInfo in interface RepositorySecurityUserValidator

Parameters:

user - user's info