org.pentaho.di.repository.filerep

Class KettleFileRepository

java.lang.Object

org.pentaho.di.repository.AbstractRepository

org.pentaho.di.repository.filerep.KettleFileRepository

All Implemented Interfaces:

Repository

public class KettleFileRepository
extends AbstractRepository

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_REPOSITORY_VERSION
org.pentaho.metastore.stores.xml.XmlMetaStore	metaStore

Constructor Summary

Constructors

Constructor and Description
KettleFileRepository()

Method Summary

Modifier and Type	Method and Description
String	calcFilename(ObjectId id)
String	calcObjectId(RepositoryDirectoryInterface dir)
String	calcObjectId(RepositoryDirectoryInterface directory, String name, String extension)
String	calcObjectId(RepositoryElementInterface element)
String	calcRelativeElementDirectory(RepositoryDirectoryInterface dir)
void	clearSharedObjectCache() Clear the shared object cache, if applicable.
void	connect(String username, String password) Connect to the repository.
int	countNrJobEntryAttributes(ObjectId id_jobentry, String code)
int	countNrStepAttributes(ObjectId id_step, String code)
RepositoryDirectoryInterface	createRepositoryDirectory(RepositoryDirectoryInterface parentDirectory, String directoryPath) Create a new directory, possibly by creating several sub-directies of / at the same time.
void	deleteClusterSchema(ObjectId id_cluster)
void	deleteCondition(ObjectId id_condition)
void	deleteDatabaseMeta(String databaseName) Remove a database connection from the repository
void	deleteFile(String filename)
void	deleteJob(ObjectId id_job)
void	deletePartitionSchema(ObjectId id_partition_schema)
void	deleteRepositoryDirectory(RepositoryDirectoryInterface dir)
void	deleteRootObject(String name, String extension)
void	deleteSlave(ObjectId id_slave)
void	deleteTransformation(ObjectId id_transformation) Delete everything related to a transformation from the repository.
void	delUser(ObjectId id_user)
void	disconnect() Disconnect from the repository.
boolean	exists(String name, RepositoryDirectoryInterface repositoryDirectory, RepositoryObjectType objectType) See if a repository object exists in the repository
RepositoryDirectoryInterface	findDirectory(ObjectId directory)
RepositoryDirectoryInterface	findDirectory(String directory)
ObjectId	getClusterID(String name)
ObjectId[]	getClusterIDs(boolean includeDeleted)
String[]	getClusterNames(boolean includeDeleted)
ObjectId[]	getClusterSlaveIDs(ObjectId id_cluster_schema)
String[]	getClustersUsingSlave(ObjectId id_slave)
String	getConnectMessage() This is an informational message that a repository can display on connecting within Spoon.
ObjectId[]	getDatabaseAttributeIDs(ObjectId id_database)
ObjectId	getDatabaseID(String name)
ObjectId[]	getDatabaseIDs(boolean includeDeleted)
String[]	getDatabaseNames(boolean includeDeleted)
RepositoryDirectoryInterface	getDefaultSaveDirectory(RepositoryElementInterface repositoryElement)
String[]	getDirectoryNames(ObjectId id_directory) Returns the child directory names of a parent directory
IRepositoryExporter	getExporter()
IRepositoryImporter	getImporter()
List<RepositoryElementMetaInterface>	getJobAndTransformationObjects(ObjectId id_directory, boolean includeDeleted) Gets all job and transformation objects in the given directory.
boolean	getJobEntryAttributeBoolean(ObjectId id_jobentry, int nr, String code, boolean def)
long	getJobEntryAttributeInteger(ObjectId id_jobentry, int nr, String code)
String	getJobEntryAttributeString(ObjectId id_jobentry, int nr, String code)
ObjectId	getJobId(String name, RepositoryDirectoryInterface repositoryDirectory)
String[]	getJobNames(ObjectId id_directory, boolean includeDeleted)
ObjectId[]	getJobNoteIDs(ObjectId id_job)
List<RepositoryElementMetaInterface>	getJobObjects(ObjectId id_directory, boolean includeDeleted)
String[]	getJobsUsingDatabase(ObjectId id_database) Get the repository version.
LogChannelInterface	getLog()
org.pentaho.metastore.stores.xml.XmlMetaStore	getMetaStore()
String	getName()
int	getNrSubDirectories(ObjectId id_directory)
RepositoryObject	getObjectInformation(ObjectId objectId, RepositoryObjectType objectType) Get more information about a certain object ID in the form of the RepositoryObject
ObjectId	getPartitionSchemaID(String name)
ObjectId[]	getPartitionSchemaIDs(boolean includeDeleted)
String[]	getPartitionSchemaNames(boolean includeDeleted)
KettleFileRepositoryMeta	getRepositoryMeta()
ObjectId	getRootDirectoryID()
RepositorySecurityManager	getSecurityManager()
RepositorySecurityProvider	getSecurityProvider()
IRepositoryService	getService(Class<? extends IRepositoryService> clazz) Retrieves a given repository service
List<Class<? extends IRepositoryService>>	getServiceInterfaces() Retrieves the current list of of IRepository Services.
ObjectId	getSlaveID(String name)
ObjectId[]	getSlaveIDs(boolean includeDeleted)
String[]	getSlaveNames(boolean includeDeleted)
List<SlaveServer>	getSlaveServers()
boolean	getStepAttributeBoolean(ObjectId id_step, int nr, String code, boolean def)
long	getStepAttributeInteger(ObjectId id_step, int nr, String code)
String	getStepAttributeString(ObjectId id_step, int nr, String code)
ObjectId[]	getSubConditionIDs(ObjectId id_condition)
ObjectId[]	getSubDirectoryIDs(ObjectId id_directory)
ObjectId[]	getTransformationClusterSchemaIDs(ObjectId id_transformation)
ObjectId[]	getTransformationConditionIDs(ObjectId id_transformation)
ObjectId[]	getTransformationDatabaseIDs(ObjectId id_transformation)
ObjectId	getTransformationID(String name, RepositoryDirectoryInterface repositoryDirectory)
String[]	getTransformationNames(ObjectId id_directory, boolean includeDeleted)
List<RepositoryElementMetaInterface>	getTransformationObjects(ObjectId idDirectory, boolean includeDeleted)
ObjectId[]	getTransformationPartitionSchemaIDs(ObjectId id_transformation)
String[]	getTransformationsUsingCluster(ObjectId id_cluster)
String[]	getTransformationsUsingDatabase(ObjectId id_database)
String[]	getTransformationsUsingPartitionSchema(ObjectId id_partition_schema)
String[]	getTransformationsUsingSlave(ObjectId id_slave)
ObjectId[]	getTransNoteIDs(ObjectId id_transformation)
RepositoryDirectoryInterface	getUserHomeDirectory()
ObjectId	getUserID(String login)
ObjectId[]	getUserIDs()
IUser	getUserInfo()
String[]	getUserLogins()
String	getVersion() Get the repository version.
boolean	hasService(Class<? extends IRepositoryService> clazz) Checks whether a given repository service is available or not
void	init(RepositoryMeta repositoryMeta) Initialize the repository with the repository metadata and user information.
ObjectId	insertClusterSlave(ClusterSchema clusterSchema, SlaveServer slaveServer)
void	insertJobEntryDatabase(ObjectId id_job, ObjectId id_jobentry, ObjectId id_database)
void	insertJobNote(ObjectId id_job, ObjectId id_note)
ObjectId	insertLogEntry(String description) Insert an entry in the audit trail of the repository.
void	insertStepDatabase(ObjectId id_transformation, ObjectId id_step, ObjectId id_database)
ObjectId	insertTransformationCluster(ObjectId id_transformation, ObjectId id_cluster)
ObjectId	insertTransformationPartitionSchema(ObjectId id_transformation, ObjectId id_partition_schema)
ObjectId	insertTransformationSlave(ObjectId id_transformation, ObjectId id_slave)
void	insertTransNote(ObjectId id_transformation, ObjectId id_note)
void	insertTransStepCondition(ObjectId id_transformation, ObjectId id_step, ObjectId id_condition)
boolean	isConnected()
ClusterSchema	loadClusterSchema(ObjectId id_cluster_schema, List<SlaveServer> slaveServers, String versionName)
Condition	loadCondition(ObjectId id_condition)
Condition	loadConditionFromStepAttribute(ObjectId id_step, String code) Load a condition from the repository with the Object ID stored in a step attribute.
DatabaseMeta	loadDatabaseMeta(ObjectId id_database, String versionName) Load the Database connection Metadata from the repository
DatabaseMeta	loadDatabaseMetaFromJobEntryAttribute(ObjectId id_jobentry, String nameCode, int nr, String idCode, List<DatabaseMeta> databases) This method is introduced to avoid having to go over an integer/string/whatever in the interface and the job entry code.
DatabaseMeta	loadDatabaseMetaFromStepAttribute(ObjectId id_step, String code, List<DatabaseMeta> databases) This method is introduced to avoid having to go over an integer/string/whatever in the interface and the step code.
JobMeta	loadJob(ObjectId idJob, String versionLabel) Load a job from the repository by id
JobMeta	loadJob(String jobname, RepositoryDirectoryInterface repdir, ProgressMonitorListener monitor, String versionName) Load a job from the repository
Node	loadNodeFromXML(ObjectId id, String tag)
PartitionSchema	loadPartitionSchema(ObjectId id_partition_schema, String versionName)
RepositoryDirectoryInterface	loadRepositoryDirectoryTree()
RepositoryDirectoryInterface	loadRepositoryDirectoryTree(RepositoryDirectoryInterface dir)
SlaveServer	loadSlaveServer(ObjectId id_slave_server, String versionName)
TransMeta	loadTransformation(ObjectId idTransformation, String versionLabel) Load a transformation by id
TransMeta	loadTransformation(String transname, RepositoryDirectoryInterface repdir, ProgressMonitorListener monitor, boolean setInternalVariables, String versionName) Load a transformation with a name from a folder in the repository
UserInfo	loadUserInfo(String login)
UserInfo	loadUserInfo(String login, String password)
ValueMetaAndData	loadValueMetaAndData(ObjectId id_value)
void	moveJob(String jobname, ObjectId id_directory_from, ObjectId id_directory_to)
void	moveTransformation(String transname, ObjectId id_directory_from, ObjectId id_directory_to)
List<DatabaseMeta>	readDatabases() Read all the databases defined in the repository
void	readDatabases(HasDatabasesInterface transMeta, boolean overWriteShared) Read all the databases from the repository, insert into the has databases object, overwriting optionally
SharedObjects	readJobMetaSharedObjects(JobMeta jobMeta)
SharedObjects	readTransSharedObjects(TransMeta transMeta)
ObjectId	renameJob(ObjectId id_job, RepositoryDirectoryInterface newDir, String newName) Move / rename a job
ObjectId	renameJob(ObjectId id_job, String versionComment, RepositoryDirectoryInterface newDir, String newName) Move / rename a job
ObjectId	renameRepositoryDirectory(ObjectId id, RepositoryDirectoryInterface newParentDir, String newName) Move / rename a repository directory
ObjectId	renameTransformation(ObjectId id_transformation, RepositoryDirectoryInterface newDir, String newName) Move / rename a transformation
ObjectId	renameTransformation(ObjectId id_transformation, String versionComment, RepositoryDirectoryInterface newDir, String newName) Move / rename a transformation
void	renameUser(ObjectId id_user, String newname)
void	save(RepositoryElementInterface repositoryElement, String versionComment)
void	save(RepositoryElementInterface repositoryElement, String versionComment, Calendar versionDate, ProgressMonitorListener monitor, boolean overwrite) Save the object to the repository with version comments as well as version dates.
void	save(RepositoryElementInterface repositoryElement, String versionComment, ProgressMonitorListener monitor, boolean overwrite) Save an object to the repository optionally overwriting any associated objects.
void	save(RepositoryElementInterface repositoryElement, String versionComment, ProgressMonitorListener monitor, ObjectId parentId, boolean used)
ObjectId	saveCondition(Condition condition)
ObjectId	saveCondition(Condition condition, ObjectId id_condition_parent)
void	saveConditionStepAttribute(ObjectId id_transformation, ObjectId id_step, String code, Condition condition) This method saves the object ID of the condition object (if not null) in the step attributes
void	saveDatabaseMetaJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, int nr, String nameCode, String idCode, DatabaseMeta database) This method saves the object ID of the database object (if not null) in the job entry attributes
void	saveDatabaseMetaJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, String code, DatabaseMeta database)
void	saveDatabaseMetaStepAttribute(ObjectId id_transformation, ObjectId id_step, String code, DatabaseMeta database) This method saves the object ID of the database object (if not null) in the step attributes
void	saveJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, int nr, String code, boolean value)
void	saveJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, int nr, String code, long value)
void	saveJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, int nr, String code, String value)
void	saveRepositoryDirectory(RepositoryDirectoryInterface dir)
void	saveStepAttribute(ObjectId id_transformation, ObjectId id_step, int nr, String code, boolean value)
void	saveStepAttribute(ObjectId id_transformation, ObjectId id_step, int nr, String code, double value)
void	saveStepAttribute(ObjectId id_transformation, ObjectId id_step, int nr, String code, long value)
void	saveStepAttribute(ObjectId id_transformation, ObjectId id_step, int nr, String code, String value)
void	saveUserInfo(UserInfo userInfo)
void	setMetaStore(org.pentaho.metastore.stores.xml.XmlMetaStore metaStore)
void	setRepositoryMeta(KettleFileRepositoryMeta repositoryMeta)
boolean	test()
void	undeleteObject(RepositoryElementMetaInterface repositoryObject) Removes he deleted flag from a repository element in the repository.

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

create, getJobEntryAttributeBoolean, getJobEntryAttributeBoolean, getJobEntryAttributeBoolean, getJobEntryAttributeInteger, getJobEntryAttributeString, getStepAttributeBoolean, getStepAttributeBoolean, getStepAttributeInteger, getStepAttributeString, getUnderlyingRepository, loadDatabaseMetaFromJobEntryAttribute, save, saveDatabaseMetaJobEntryAttribute, saveJobEntryAttribute, saveJobEntryAttribute, saveJobEntryAttribute, saveStepAttribute, saveStepAttribute, saveStepAttribute, saveStepAttribute

Methods inherited from class java.lang.Object

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

Field Detail

FILE_REPOSITORY_VERSION

public static final String FILE_REPOSITORY_VERSION

See Also:

Constant Field Values

metaStore

public org.pentaho.metastore.stores.xml.XmlMetaStore metaStore

Constructor Detail

KettleFileRepository

public KettleFileRepository()

Method Detail

connect

public void connect(String username,
                    String password)
             throws KettleException

Description copied from interface: Repository

Connect to the repository. Make sure you don't connect more than once to the same repository with this repository object.

Parameters:

username - the username of the user connecting to the repository.

password - the password of the user connecting to the repository.

Throws:

KettleSecurityException - in case the supplied user or password is incorrect.

KettleException - in case there is a general unexpected error OR if we're already connected to the repository.

test

public boolean test()

Overrides:

test in class AbstractRepository

disconnect

public void disconnect()

Description copied from interface: Repository

Disconnect from the repository.

init

public void init(RepositoryMeta repositoryMeta)

Description copied from interface: Repository

Initialize the repository with the repository metadata and user information.

getLog

public LogChannelInterface getLog()

Returns:

the logging channel of this repository

isConnected

public boolean isConnected()

getSecurityProvider

public RepositorySecurityProvider getSecurityProvider()

Returns:

The security provider for this repository.

getSecurityManager

public RepositorySecurityManager getSecurityManager()

Returns:

The security manager for this repository.

calcRelativeElementDirectory

public String calcRelativeElementDirectory(RepositoryDirectoryInterface dir)

calcObjectId

public String calcObjectId(RepositoryDirectoryInterface dir)

calcObjectId

public String calcObjectId(RepositoryDirectoryInterface directory,
                           String name,
                           String extension)

calcObjectId

public String calcObjectId(RepositoryElementInterface element)

calcFilename

public String calcFilename(ObjectId id)

exists

public boolean exists(String name,
                      RepositoryDirectoryInterface repositoryDirectory,
                      RepositoryObjectType objectType)
               throws KettleException

Description copied from interface: Repository

See if a repository object exists in the repository

Parameters:

name - the name of the object

repositoryDirectory - the directory in which it should reside

objectType - the type of repository object

Returns:

true if the job exists

Throws:

KettleException - in case something goes wrong.

save

public void save(RepositoryElementInterface repositoryElement,
                 String versionComment)
          throws KettleException

Throws:

KettleException

save

public void save(RepositoryElementInterface repositoryElement,
                 String versionComment,
                 ProgressMonitorListener monitor,
                 boolean overwrite)
          throws KettleException

Description copied from interface: Repository

Save an object to the repository optionally overwriting any associated objects.

Parameters:

repositoryElement - Object to save

versionComment - Version comment for update

monitor - Progress Monitor to report feedback to

overwrite - Overwrite any existing objects involved in saving repositoryElement, e.g. repositoryElement, database connections, slave servers

Throws:

KettleException - Error saving the object to the repository

save

public void save(RepositoryElementInterface repositoryElement,
                 String versionComment,
                 Calendar versionDate,
                 ProgressMonitorListener monitor,
                 boolean overwrite)
          throws KettleException

Description copied from interface: Repository

Save the object to the repository with version comments as well as version dates. This form exists largely to support the importing of revisions, preserving their revision date.

Throws:

KettleException

save

public void save(RepositoryElementInterface repositoryElement,
                 String versionComment,
                 ProgressMonitorListener monitor,
                 ObjectId parentId,
                 boolean used)
          throws KettleException

Throws:

KettleException

createRepositoryDirectory

public RepositoryDirectoryInterface createRepositoryDirectory(RepositoryDirectoryInterface parentDirectory,
                                                              String directoryPath)
                                                       throws KettleException

Description copied from interface: Repository

Create a new directory, possibly by creating several sub-directies of / at the same time.

Parameters:

parentDirectory - the parent directory

directoryPath - The path to the new Repository Directory, to be created.

Returns:

The created sub-directory

Throws:

KettleException - In case something goes wrong

saveRepositoryDirectory

public void saveRepositoryDirectory(RepositoryDirectoryInterface dir)
                             throws KettleException

Throws:

KettleException

deleteJob

public void deleteJob(ObjectId id_job)
               throws KettleException

Throws:

KettleException

deleteTransformation

public void deleteTransformation(ObjectId id_transformation)
                          throws KettleException

Description copied from interface: Repository

Delete everything related to a transformation from the repository. This does not included shared objects : databases, slave servers, cluster and partition schema.

Parameters:

id_transformation - the transformation id to delete

Throws:

KettleException

deleteClusterSchema

public void deleteClusterSchema(ObjectId id_cluster)
                         throws KettleException

Throws:

KettleException

deleteCondition

public void deleteCondition(ObjectId id_condition)
                     throws KettleException

Throws:

KettleException

deletePartitionSchema

public void deletePartitionSchema(ObjectId id_partition_schema)
                           throws KettleException

Throws:

KettleException

deleteRepositoryDirectory

public void deleteRepositoryDirectory(RepositoryDirectoryInterface dir)
                               throws KettleException

Throws:

KettleException

deleteSlave

public void deleteSlave(ObjectId id_slave)
                 throws KettleException

Throws:

KettleException

deleteDatabaseMeta

public void deleteDatabaseMeta(String databaseName)
                        throws KettleException

Description copied from interface: Repository

Remove a database connection from the repository

Parameters:

databaseName - The name of the connection to remove

Throws:

KettleException - In case something went wrong: database error, insufficient permissions, depending objects, etc.

deleteRootObject

public void deleteRootObject(String name,
                             String extension)
                      throws KettleException

Throws:

KettleException

deleteFile

public void deleteFile(String filename)
                throws KettleException

Throws:

KettleException

getClusterID

public ObjectId getClusterID(String name)
                      throws KettleException

Throws:

KettleException

getClusterIDs

public ObjectId[] getClusterIDs(boolean includeDeleted)
                         throws KettleException

Throws:

KettleException

getClusterNames

public String[] getClusterNames(boolean includeDeleted)
                         throws KettleException

Throws:

KettleException

getClustersUsingSlave

public String[] getClustersUsingSlave(ObjectId id_slave)
                               throws KettleException

Throws:

KettleException

getTransformationConditionIDs

public ObjectId[] getTransformationConditionIDs(ObjectId id_transformation)
                                         throws KettleException

Throws:

KettleException

getDatabaseAttributeIDs

public ObjectId[] getDatabaseAttributeIDs(ObjectId id_database)
                                   throws KettleException

Throws:

KettleException

getDatabaseID

public ObjectId getDatabaseID(String name)
                       throws KettleException

Throws:

KettleException

getTransformationDatabaseIDs

public ObjectId[] getTransformationDatabaseIDs(ObjectId id_transformation)
                                        throws KettleException

Throws:

KettleException

getDatabaseIDs

public ObjectId[] getDatabaseIDs(boolean includeDeleted)
                          throws KettleException

Throws:

KettleException

getDatabaseNames

public String[] getDatabaseNames(boolean includeDeleted)
                          throws KettleException

Throws:

KettleException

getDirectoryNames

public String[] getDirectoryNames(ObjectId id_directory)
                           throws KettleException

Description copied from interface: Repository

Returns the child directory names of a parent directory

Parameters:

id_directory - parent directory id

Returns:

array of child names

Throws:

KettleException

getJobId

public ObjectId getJobId(String name,
                         RepositoryDirectoryInterface repositoryDirectory)
                  throws KettleException

Throws:

KettleException

getJobNames

public String[] getJobNames(ObjectId id_directory,
                            boolean includeDeleted)
                     throws KettleException

Throws:

KettleException

getJobNoteIDs

public ObjectId[] getJobNoteIDs(ObjectId id_job)
                         throws KettleException

Throws:

KettleException

getJobsUsingDatabase

public String[] getJobsUsingDatabase(ObjectId id_database)
                              throws KettleException

Description copied from interface: Repository

Get the repository version.

Returns:

The repository version as a string

Throws:

KettleException

getName

public String getName()

Returns:

The name of the repository

getPartitionSchemaID

public ObjectId getPartitionSchemaID(String name)
                              throws KettleException

Throws:

KettleException

getPartitionSchemaIDs

public ObjectId[] getPartitionSchemaIDs(boolean includeDeleted)
                                 throws KettleException

Throws:

KettleException

getPartitionSchemaNames

public String[] getPartitionSchemaNames(boolean includeDeleted)
                                 throws KettleException

Throws:

KettleException

getRootDirectoryID

public ObjectId getRootDirectoryID()
                            throws KettleException

Throws:

KettleException

getSlaveID

public ObjectId getSlaveID(String name)
                    throws KettleException

Throws:

KettleException

getSlaveIDs

public ObjectId[] getSlaveIDs(boolean includeDeleted)
                       throws KettleException

Throws:

KettleException

getClusterSlaveIDs

public ObjectId[] getClusterSlaveIDs(ObjectId id_cluster_schema)
                              throws KettleException

Throws:

KettleException

getSlaveNames

public String[] getSlaveNames(boolean includeDeleted)
                       throws KettleException

Throws:

KettleException

getSlaveServers

public List<SlaveServer> getSlaveServers()
                                  throws KettleException

Returns:

a list of all the slave servers in the repository.

Throws:

KettleException

getStepAttributeBoolean

public boolean getStepAttributeBoolean(ObjectId id_step,
                                       int nr,
                                       String code,
                                       boolean def)
                                throws KettleException

Throws:

KettleException

getStepAttributeInteger

public long getStepAttributeInteger(ObjectId id_step,
                                    int nr,
                                    String code)
                             throws KettleException

Throws:

KettleException

getStepAttributeString

public String getStepAttributeString(ObjectId id_step,
                                     int nr,
                                     String code)
                              throws KettleException

Throws:

KettleException

getJobEntryAttributeInteger

public long getJobEntryAttributeInteger(ObjectId id_jobentry,
                                        int nr,
                                        String code)
                                 throws KettleException

Throws:

KettleException

getJobEntryAttributeString

public String getJobEntryAttributeString(ObjectId id_jobentry,
                                         int nr,
                                         String code)
                                  throws KettleException

Throws:

KettleException

getJobEntryAttributeBoolean

public boolean getJobEntryAttributeBoolean(ObjectId id_jobentry,
                                           int nr,
                                           String code,
                                           boolean def)
                                    throws KettleException

Specified by:

getJobEntryAttributeBoolean in class AbstractRepository

Throws:

KettleException

getSubConditionIDs

public ObjectId[] getSubConditionIDs(ObjectId id_condition)
                              throws KettleException

Throws:

KettleException

getSubDirectoryIDs

public ObjectId[] getSubDirectoryIDs(ObjectId id_directory)
                              throws KettleException

Throws:

KettleException

getTransNoteIDs

public ObjectId[] getTransNoteIDs(ObjectId id_transformation)
                           throws KettleException

Throws:

KettleException

getTransformationClusterSchemaIDs

public ObjectId[] getTransformationClusterSchemaIDs(ObjectId id_transformation)
                                             throws KettleException

Throws:

KettleException

getTransformationID

public ObjectId getTransformationID(String name,
                                    RepositoryDirectoryInterface repositoryDirectory)
                             throws KettleException

Throws:

KettleException

getTransformationNames

public String[] getTransformationNames(ObjectId id_directory,
                                       boolean includeDeleted)
                                throws KettleException

Throws:

KettleException

getTransformationPartitionSchemaIDs

public ObjectId[] getTransformationPartitionSchemaIDs(ObjectId id_transformation)
                                               throws KettleException

Throws:

KettleException

getTransformationsUsingCluster

public String[] getTransformationsUsingCluster(ObjectId id_cluster)
                                        throws KettleException

Throws:

KettleException

getTransformationsUsingDatabase

public String[] getTransformationsUsingDatabase(ObjectId id_database)
                                         throws KettleException

Throws:

KettleException

getTransformationsUsingPartitionSchema

public String[] getTransformationsUsingPartitionSchema(ObjectId id_partition_schema)
                                                throws KettleException

Throws:

KettleException

getTransformationsUsingSlave

public String[] getTransformationsUsingSlave(ObjectId id_slave)
                                      throws KettleException

Throws:

KettleException

getVersion

public String getVersion()

Description copied from interface: Repository

Get the repository version.

Returns:

The repository version as a string

insertClusterSlave

public ObjectId insertClusterSlave(ClusterSchema clusterSchema,
                                   SlaveServer slaveServer)
                            throws KettleException

Throws:

KettleException

insertJobEntryDatabase

public void insertJobEntryDatabase(ObjectId id_job,
                                   ObjectId id_jobentry,
                                   ObjectId id_database)
                            throws KettleException

Throws:

KettleException

insertJobNote

public void insertJobNote(ObjectId id_job,
                          ObjectId id_note)
                   throws KettleException

Throws:

KettleException

insertLogEntry

public ObjectId insertLogEntry(String description)
                        throws KettleException

Description copied from interface: Repository

Insert an entry in the audit trail of the repository. This is an optional operation and depends on the capabilities of the underlying repository.

Throws:

KettleException

insertStepDatabase

public void insertStepDatabase(ObjectId id_transformation,
                               ObjectId id_step,
                               ObjectId id_database)
                        throws KettleException

Throws:

KettleException

insertTransNote

public void insertTransNote(ObjectId id_transformation,
                            ObjectId id_note)
                     throws KettleException

Throws:

KettleException

insertTransStepCondition

public void insertTransStepCondition(ObjectId id_transformation,
                                     ObjectId id_step,
                                     ObjectId id_condition)
                              throws KettleException

Throws:

KettleException

insertTransformationCluster

public ObjectId insertTransformationCluster(ObjectId id_transformation,
                                            ObjectId id_cluster)
                                     throws KettleException

Throws:

KettleException

insertTransformationPartitionSchema

public ObjectId insertTransformationPartitionSchema(ObjectId id_transformation,
                                                    ObjectId id_partition_schema)
                                             throws KettleException

Throws:

KettleException

insertTransformationSlave

public ObjectId insertTransformationSlave(ObjectId id_transformation,
                                          ObjectId id_slave)
                                   throws KettleException

Throws:

KettleException

loadClusterSchema

public ClusterSchema loadClusterSchema(ObjectId id_cluster_schema,
                                       List<SlaveServer> slaveServers,
                                       String versionName)
                                throws KettleException

Throws:

KettleException

loadCondition

public Condition loadCondition(ObjectId id_condition)
                        throws KettleException

Throws:

KettleException

loadConditionFromStepAttribute

public Condition loadConditionFromStepAttribute(ObjectId id_step,
                                                String code)
                                         throws KettleException

Description copied from interface: Repository

Load a condition from the repository with the Object ID stored in a step attribute.

Returns:

Throws:

KettleException

loadNodeFromXML

public Node loadNodeFromXML(ObjectId id,
                            String tag)
                     throws KettleException

Throws:

KettleException

loadDatabaseMeta

public DatabaseMeta loadDatabaseMeta(ObjectId id_database,
                                     String versionName)
                              throws KettleException

Description copied from interface: Repository

Load the Database connection Metadata from the repository

Parameters:

id_database - the id of the database connection to load

versionName - the revision to load. Specify null to load the last version.

Throws:

KettleException - in case something goes wrong with database, connection, etc.

loadDatabaseMetaFromJobEntryAttribute

public DatabaseMeta loadDatabaseMetaFromJobEntryAttribute(ObjectId id_jobentry,
                                                          String nameCode,
                                                          int nr,
                                                          String idCode,
                                                          List<DatabaseMeta> databases)
                                                   throws KettleException

Description copied from interface: Repository

This method is introduced to avoid having to go over an integer/string/whatever in the interface and the job entry code.

Returns:

Throws:

KettleException

saveDatabaseMetaJobEntryAttribute

public void saveDatabaseMetaJobEntryAttribute(ObjectId id_job,
                                              ObjectId id_jobentry,
                                              int nr,
                                              String nameCode,
                                              String idCode,
                                              DatabaseMeta database)
                                       throws KettleException

Description copied from interface: Repository

This method saves the object ID of the database object (if not null) in the job entry attributes

Throws:

KettleException

loadDatabaseMetaFromStepAttribute

public DatabaseMeta loadDatabaseMetaFromStepAttribute(ObjectId id_step,
                                                      String code,
                                                      List<DatabaseMeta> databases)
                                               throws KettleException

Description copied from interface: Repository

This method is introduced to avoid having to go over an integer/string/whatever in the interface and the step code.

Returns:

Throws:

KettleException

loadJob

public JobMeta loadJob(String jobname,
                       RepositoryDirectoryInterface repdir,
                       ProgressMonitorListener monitor,
                       String versionName)
                throws KettleException

Description copied from interface: Repository

Load a job from the repository

Parameters:

jobname - the name

repdir - the directory

monitor - the progress monitor or null

versionName - the revision to load. Specify null to load the last version.

Throws:

KettleException

loadPartitionSchema

public PartitionSchema loadPartitionSchema(ObjectId id_partition_schema,
                                           String versionName)
                                    throws KettleException

Throws:

KettleException

loadRepositoryDirectoryTree

public RepositoryDirectoryInterface loadRepositoryDirectoryTree()
                                                         throws KettleException

Throws:

KettleException

loadRepositoryDirectoryTree

public RepositoryDirectoryInterface loadRepositoryDirectoryTree(RepositoryDirectoryInterface dir)
                                                         throws KettleException

Throws:

KettleException

findDirectory

public RepositoryDirectoryInterface findDirectory(String directory)
                                           throws KettleException

Throws:

KettleException

findDirectory

public RepositoryDirectoryInterface findDirectory(ObjectId directory)
                                           throws KettleException

Throws:

KettleException

getTransformationObjects

public List<RepositoryElementMetaInterface> getTransformationObjects(ObjectId idDirectory,
                                                                     boolean includeDeleted)
                                                              throws KettleException

Throws:

KettleException

getJobObjects

public List<RepositoryElementMetaInterface> getJobObjects(ObjectId id_directory,
                                                          boolean includeDeleted)
                                                   throws KettleException

Throws:

KettleException

getNrSubDirectories

public int getNrSubDirectories(ObjectId id_directory)
                        throws KettleException

Throws:

KettleException

loadSlaveServer

public SlaveServer loadSlaveServer(ObjectId id_slave_server,
                                   String versionName)
                            throws KettleException

Throws:

KettleException

loadTransformation

public TransMeta loadTransformation(String transname,
                                    RepositoryDirectoryInterface repdir,
                                    ProgressMonitorListener monitor,
                                    boolean setInternalVariables,
                                    String versionName)
                             throws KettleException

Description copied from interface: Repository

Load a transformation with a name from a folder in the repository

Parameters:

transname - the name of the transformation to load

monitor - the progress monitor to use (UI feedback)

setInternalVariables - set to true if you want to automatically set the internal variables of the loaded transformation. (true is the default with very few exceptions!)

versionName - the revision to load. Specify null to load the last version.

Throws:

KettleException

readDatabases

public void readDatabases(HasDatabasesInterface transMeta,
                          boolean overWriteShared)
                   throws KettleException

Read all the databases from the repository, insert into the has databases object, overwriting optionally

Parameters:

TransMeta - The transformation to load into.

overWriteShared - if an object with the same name exists, overwrite

Throws:

KettleException

loadValueMetaAndData

public ValueMetaAndData loadValueMetaAndData(ObjectId id_value)
                                      throws KettleException

Throws:

KettleException

moveJob

public void moveJob(String jobname,
                    ObjectId id_directory_from,
                    ObjectId id_directory_to)
             throws KettleException

Throws:

KettleException

moveTransformation

public void moveTransformation(String transname,
                               ObjectId id_directory_from,
                               ObjectId id_directory_to)
                        throws KettleException

Throws:

KettleException

readDatabases

public List<DatabaseMeta> readDatabases()
                                 throws KettleException

Description copied from interface: Repository

Read all the databases defined in the repository

Returns:

a list of all the databases defined in the repository

Throws:

KettleException

clearSharedObjectCache

public void clearSharedObjectCache()

Clear the shared object cache, if applicable.

readJobMetaSharedObjects

public SharedObjects readJobMetaSharedObjects(JobMeta jobMeta)
                                       throws KettleException

Throws:

KettleException

readTransSharedObjects

public SharedObjects readTransSharedObjects(TransMeta transMeta)
                                     throws KettleException

Throws:

KettleException

renameJob

public ObjectId renameJob(ObjectId id_job,
                          RepositoryDirectoryInterface newDir,
                          String newName)
                   throws KettleException

Description copied from interface: Repository

Move / rename a job

Parameters:

id_job - The ObjectId of the job to move

newDir - The RepositoryDirectoryInterface that will be the new parent of the job (May be null if a move is not desired)

newName - The new name of the job (May be null if a rename is not desired)

Returns:

The ObjectId of the job that was moved

Throws:

KettleException

renameJob

public ObjectId renameJob(ObjectId id_job,
                          String versionComment,
                          RepositoryDirectoryInterface newDir,
                          String newName)
                   throws KettleException

Description copied from interface: Repository

Move / rename a job

Parameters:

id_job - The ObjectId of the job to move

versionComment - Version comment for rename

newDir - The RepositoryDirectoryInterface that will be the new parent of the job (May be null if a move is not desired)

newName - The new name of the job (May be null if a rename is not desired)

Returns:

The ObjectId of the job that was moved

Throws:

KettleException

renameRepositoryDirectory

public ObjectId renameRepositoryDirectory(ObjectId id,
                                          RepositoryDirectoryInterface newParentDir,
                                          String newName)
                                   throws KettleException

Description copied from interface: Repository

Move / rename a repository directory

Parameters:

id - The ObjectId of the repository directory to move

newParentDir - The RepositoryDirectoryInterface that will be the new parent of the repository directory (May be null if a move is not desired)

newName - The new name of the repository directory (May be null if a rename is not desired)

Returns:

The ObjectId of the repository directory that was moved

Throws:

KettleException

renameTransformation

public ObjectId renameTransformation(ObjectId id_transformation,
                                     RepositoryDirectoryInterface newDir,
                                     String newName)
                              throws KettleException

Description copied from interface: Repository

Move / rename a transformation

Parameters:

id_transformation - The ObjectId of the transformation to move

newDir - The RepositoryDirectoryInterface that will be the new parent of the transformation (May be null if a move is not desired)

newName - The new name of the transformation (May be null if a rename is not desired)

Returns:

The ObjectId of the transformation that was moved

Throws:

KettleException

renameTransformation

public ObjectId renameTransformation(ObjectId id_transformation,
                                     String versionComment,
                                     RepositoryDirectoryInterface newDir,
                                     String newName)
                              throws KettleException

Description copied from interface: Repository

Move / rename a transformation

Parameters:

id_transformation - The ObjectId of the transformation to move

versionComment - Version comment for rename

newDir - The RepositoryDirectoryInterface that will be the new parent of the transformation (May be null if a move is not desired)

newName - The new name of the transformation (May be null if a rename is not desired)

Returns:

The ObjectId of the transformation that was moved

Throws:

KettleException

saveCondition

public ObjectId saveCondition(Condition condition)
                       throws KettleException

Throws:

KettleException

saveCondition

public ObjectId saveCondition(Condition condition,
                              ObjectId id_condition_parent)
                       throws KettleException

Throws:

KettleException

saveConditionStepAttribute

public void saveConditionStepAttribute(ObjectId id_transformation,
                                       ObjectId id_step,
                                       String code,
                                       Condition condition)
                                throws KettleException

Description copied from interface: Repository

This method saves the object ID of the condition object (if not null) in the step attributes

Throws:

KettleException

saveDatabaseMetaJobEntryAttribute

public void saveDatabaseMetaJobEntryAttribute(ObjectId id_job,
                                              ObjectId id_jobentry,
                                              String code,
                                              DatabaseMeta database)
                                       throws KettleException

Throws:

KettleException

saveDatabaseMetaStepAttribute

public void saveDatabaseMetaStepAttribute(ObjectId id_transformation,
                                          ObjectId id_step,
                                          String code,
                                          DatabaseMeta database)
                                   throws KettleException

Description copied from interface: Repository

This method saves the object ID of the database object (if not null) in the step attributes

Throws:

KettleException

saveJobEntryAttribute

public void saveJobEntryAttribute(ObjectId id_job,
                                  ObjectId id_jobentry,
                                  int nr,
                                  String code,
                                  String value)
                           throws KettleException

Throws:

KettleException

saveJobEntryAttribute

public void saveJobEntryAttribute(ObjectId id_job,
                                  ObjectId id_jobentry,
                                  int nr,
                                  String code,
                                  boolean value)
                           throws KettleException

Throws:

KettleException

saveJobEntryAttribute

public void saveJobEntryAttribute(ObjectId id_job,
                                  ObjectId id_jobentry,
                                  int nr,
                                  String code,
                                  long value)
                           throws KettleException

Throws:

KettleException

saveStepAttribute

public void saveStepAttribute(ObjectId id_transformation,
                              ObjectId id_step,
                              int nr,
                              String code,
                              String value)
                       throws KettleException

Throws:

KettleException

saveStepAttribute

public void saveStepAttribute(ObjectId id_transformation,
                              ObjectId id_step,
                              int nr,
                              String code,
                              boolean value)
                       throws KettleException

Throws:

KettleException

saveStepAttribute

public void saveStepAttribute(ObjectId id_transformation,
                              ObjectId id_step,
                              int nr,
                              String code,
                              long value)
                       throws KettleException

Throws:

KettleException

saveStepAttribute

public void saveStepAttribute(ObjectId id_transformation,
                              ObjectId id_step,
                              int nr,
                              String code,
                              double value)
                       throws KettleException

Throws:

KettleException

delUser

public void delUser(ObjectId id_user)
             throws KettleException

Throws:

KettleException

getUserID

public ObjectId getUserID(String login)
                   throws KettleException

Throws:

KettleException

getUserIDs

public ObjectId[] getUserIDs()
                      throws KettleException

Throws:

KettleException

getUserInfo

public IUser getUserInfo()

Returns:

the currently logged on user. (also available through the repository security provider)

getUserLogins

public String[] getUserLogins()
                       throws KettleException

Throws:

KettleException

loadUserInfo

public UserInfo loadUserInfo(String login)
                      throws KettleException

Throws:

KettleException

loadUserInfo

public UserInfo loadUserInfo(String login,
                             String password)
                      throws KettleException

Throws:

KettleException

renameUser

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

Throws:

KettleException

saveUserInfo

public void saveUserInfo(UserInfo userInfo)
                  throws KettleException

Throws:

KettleException

countNrJobEntryAttributes

public int countNrJobEntryAttributes(ObjectId id_jobentry,
                                     String code)
                              throws KettleException

Throws:

KettleException

countNrStepAttributes

public int countNrStepAttributes(ObjectId id_step,
                                 String code)
                          throws KettleException

Throws:

KettleException

getRepositoryMeta

public KettleFileRepositoryMeta getRepositoryMeta()

Returns:

the repositoryMeta

setRepositoryMeta

public void setRepositoryMeta(KettleFileRepositoryMeta repositoryMeta)

Parameters:

repositoryMeta - the repositoryMeta to set

undeleteObject

public void undeleteObject(RepositoryElementMetaInterface repositoryObject)
                    throws KettleException

Description copied from interface: Repository

Removes he deleted flag from a repository element in the repository. If it wasn't deleted, it remains untouched.

Throws:

KettleException - get throws in case something goes horribly wrong.

getJobAndTransformationObjects

public List<RepositoryElementMetaInterface> getJobAndTransformationObjects(ObjectId id_directory,
                                                                           boolean includeDeleted)
                                                                    throws KettleException

Description copied from interface: Repository

Gets all job and transformation objects in the given directory. (Combines Repository.getJobObjects(ObjectId, boolean) and Repository.getTransformationObjects(ObjectId, boolean) into one operation.

Parameters:

id_directory - directory

includeDeleted - true to return deleted objects

Returns:

list of repository objects

Throws:

KettleException - In case something goes wrong

getService

public IRepositoryService getService(Class<? extends IRepositoryService> clazz)
                              throws KettleException

Description copied from interface: Repository

Retrieves a given repository service

Returns:

repository service

Throws:

KettleException - in case something goes horribly wrong.

getServiceInterfaces

public List<Class<? extends IRepositoryService>> getServiceInterfaces()
                                                               throws KettleException

Description copied from interface: Repository

Retrieves the current list of of IRepository Services.

Returns:

List of repository services

Throws:

KettleException - in case something goes horribly wrong.

hasService

public boolean hasService(Class<? extends IRepositoryService> clazz)
                   throws KettleException

Description copied from interface: Repository

Checks whether a given repository service is available or not

Throws:

KettleException - in case something goes horribly wrong.

getDefaultSaveDirectory

public RepositoryDirectoryInterface getDefaultSaveDirectory(RepositoryElementInterface repositoryElement)
                                                     throws KettleException

Throws:

KettleException

getUserHomeDirectory

public RepositoryDirectoryInterface getUserHomeDirectory()
                                                  throws KettleException

Throws:

KettleException

getObjectInformation

public RepositoryObject getObjectInformation(ObjectId objectId,
                                             RepositoryObjectType objectType)
                                      throws KettleException

Description copied from interface: Repository

Get more information about a certain object ID in the form of the RepositoryObject

Parameters:

objectId - The ID of the object to get more information about.

objectType - The type of object to investigate.

Returns:

The repository object or null if nothing could be found.

Throws:

KettleException - In case there was a loading problem.

loadJob

public JobMeta loadJob(ObjectId idJob,
                       String versionLabel)
                throws KettleException

Description copied from interface: Repository

Load a job from the repository by id

Parameters:

idJob - the id of the job

versionLabel - version to load. Specify null to load the last version.

Throws:

KettleException

loadTransformation

public TransMeta loadTransformation(ObjectId idTransformation,
                                    String versionLabel)
                             throws KettleException

Description copied from interface: Repository

Load a transformation by id

Parameters:

idTransformation - the id of the transformation to load

versionLabel - version to load. Specify null to load the last version.

Throws:

KettleException

getConnectMessage

public String getConnectMessage()

Description copied from interface: Repository

This is an informational message that a repository can display on connecting within Spoon. If a null is returned, no message is displayed to the end user.

Returns:

message

getExporter

public IRepositoryExporter getExporter()

Returns:

the exporter that will handle exports from this repository

getImporter

public IRepositoryImporter getImporter()

Returns:

the importer that will handle imports into this repository

getMetaStore

public org.pentaho.metastore.stores.xml.XmlMetaStore getMetaStore()

Returns:

the Metastore that is implemented in this Repository. Return null if this repository doesn't implement a Metastore.

setMetaStore

public void setMetaStore(org.pentaho.metastore.stores.xml.XmlMetaStore metaStore)