org.pentaho.di.repository

Interface RepositorySecurityProvider

All Superinterfaces:

IRepositoryService

All Known Implementing Classes:

KettleDatabaseRepositorySecurityProvider, KettleFileRepositorySecurityProvider

public interface RepositorySecurityProvider
extends IRepositoryService

This is the interface to the security provider for the repositories out there.

This allows the repository to transparently implement any kind of authentication supported by Kettle.

Author:

matt

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMINISTER_SECURITY_ACTION
static String	ADMINISTER_SECURITY_ROLE
static String	CREATE_CONTENT_ACTION
static String	CREATE_CONTENT_ROLE
static String	EXECUTE_CONTENT_ACTION
static String	NAMESPACE
static String	READ_CONTENT_ACTION
static String	READ_CONTENT_ROLE
static String	SCHEDULE_CONTENT_ACTION

Method Summary

Modifier and Type	Method and Description
boolean	allowsVersionComments(String fullPath)
List<String>	getAllRoles() Retrieves all roles in the system
List<String>	getAllUsers() Retrieves all users in the system
IUser	getUserInfo()
String[]	getUserLogins()
boolean	isLockingPossible()
boolean	isReadOnly()
boolean	isVersionCommentMandatory()
boolean	isVersioningEnabled(String fullPath) Determines whether versioning should be enabled in the UI for the given fully qualified file/path.
void	validateAction(RepositoryOperation... operations) Validates the supplied operation.

Field Detail

CREATE_CONTENT_ROLE

static final String CREATE_CONTENT_ROLE

See Also:

Constant Field Values

READ_CONTENT_ROLE

static final String READ_CONTENT_ROLE

See Also:

Constant Field Values

ADMINISTER_SECURITY_ROLE

static final String ADMINISTER_SECURITY_ROLE

See Also:

Constant Field Values

CREATE_CONTENT_ACTION

static final String CREATE_CONTENT_ACTION

See Also:

Constant Field Values

READ_CONTENT_ACTION

static final String READ_CONTENT_ACTION

See Also:

Constant Field Values

EXECUTE_CONTENT_ACTION

static final String EXECUTE_CONTENT_ACTION

See Also:

Constant Field Values

SCHEDULE_CONTENT_ACTION

static final String SCHEDULE_CONTENT_ACTION

See Also:

Constant Field Values

ADMINISTER_SECURITY_ACTION

static final String ADMINISTER_SECURITY_ACTION

See Also:

Constant Field Values

NAMESPACE

static final String NAMESPACE

See Also:

Constant Field Values

Method Detail

getUserInfo

IUser getUserInfo()

Returns:

the user information set on the security provider

validateAction

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

Validates the supplied operation.

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.

isReadOnly

boolean isReadOnly()

Returns:

true if the repository or the user is read only

isLockingPossible

boolean isLockingPossible()

Returns:

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

allowsVersionComments

boolean allowsVersionComments(String fullPath)

Returns:

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

isVersionCommentMandatory

boolean isVersionCommentMandatory()

Returns:

true if version comments are mandatory if allowed.

getAllUsers

List<String> getAllUsers()
                  throws KettleException

Retrieves all users in the system

Returns:

list of username

Throws:

KettleSecurityException - in case anything went wrong

KettleException

getAllRoles

List<String> getAllRoles()
                  throws KettleException

Retrieves all roles in the system

Returns:

list of role

Throws:

KettleSecurityException - in case anything went wrong

KettleException

getUserLogins

String[] getUserLogins()
                throws KettleException

Throws:

KettleException

isVersioningEnabled

boolean isVersioningEnabled(String fullPath)

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.

Returns:

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