Interface Repository

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void clearSharedObjectCache()
      Clear the shared object cache, if applicable.
      void connect​(String username, String password)
      Connect to the repository.
      int countNrJobEntryAttributes​(org.pentaho.di.repository.ObjectId id_jobentry, String code)  
      int countNrStepAttributes​(org.pentaho.di.repository.ObjectId id_step, String code)  
      org.pentaho.di.repository.RepositoryDirectoryInterface createRepositoryDirectory​(org.pentaho.di.repository.RepositoryDirectoryInterface parentDirectory, String directoryPath)
      Create a new directory, possibly by creating several sub-directies of / at the same time.
      void deleteClusterSchema​(org.pentaho.di.repository.ObjectId id_cluster)  
      void deleteDatabaseMeta​(String databaseName)
      Remove a database connection from the repository
      void deleteJob​(org.pentaho.di.repository.ObjectId id_job)  
      void deletePartitionSchema​(org.pentaho.di.repository.ObjectId id_partition_schema)  
      void deleteRepositoryDirectory​(org.pentaho.di.repository.RepositoryDirectoryInterface dir)  
      void deleteSlave​(org.pentaho.di.repository.ObjectId id_slave)  
      void deleteTransformation​(org.pentaho.di.repository.ObjectId id_transformation)
      Delete everything related to a transformation from the repository.
      void disconnect()
      Disconnect from the repository.
      boolean exists​(String name, org.pentaho.di.repository.RepositoryDirectoryInterface repositoryDirectory, org.pentaho.di.repository.RepositoryObjectType objectType)
      See if a repository object exists in the repository
      org.pentaho.di.repository.RepositoryDirectoryInterface findDirectory​(String directory)  
      org.pentaho.di.repository.RepositoryDirectoryInterface findDirectory​(org.pentaho.di.repository.ObjectId directory)  
      org.pentaho.di.repository.ObjectId getClusterID​(String name)  
      org.pentaho.di.repository.ObjectId[] getClusterIDs​(boolean includeDeleted)  
      String[] getClusterNames​(boolean includeDeleted)  
      String getConnectMessage()
      This is an informational message that a repository can display on connecting within Spoon.
      org.pentaho.di.repository.ObjectId getDatabaseID​(String name)  
      org.pentaho.di.repository.ObjectId[] getDatabaseIDs​(boolean includeDeleted)  
      String[] getDatabaseNames​(boolean includeDeleted)  
      org.pentaho.di.repository.RepositoryDirectoryInterface getDefaultSaveDirectory​(org.pentaho.di.repository.RepositoryElementInterface repositoryElement)  
      String[] getDirectoryNames​(org.pentaho.di.repository.ObjectId id_directory)
      Returns the child directory names of a parent directory
      IRepositoryExporter getExporter()  
      IRepositoryImporter getImporter()  
      List<org.pentaho.di.repository.RepositoryElementMetaInterface> getJobAndTransformationObjects​(org.pentaho.di.repository.ObjectId id_directory, boolean includeDeleted)
      Gets all job and transformation objects in the given directory.
      boolean getJobEntryAttributeBoolean​(org.pentaho.di.repository.ObjectId id_jobentry, int nr, String code)  
      boolean getJobEntryAttributeBoolean​(org.pentaho.di.repository.ObjectId id_jobentry, String code)  
      boolean getJobEntryAttributeBoolean​(org.pentaho.di.repository.ObjectId id_jobentry, String code, boolean def)  
      long getJobEntryAttributeInteger​(org.pentaho.di.repository.ObjectId id_jobentry, int nr, String code)  
      long getJobEntryAttributeInteger​(org.pentaho.di.repository.ObjectId id_jobentry, String code)  
      String getJobEntryAttributeString​(org.pentaho.di.repository.ObjectId id_jobentry, int nr, String code)  
      String getJobEntryAttributeString​(org.pentaho.di.repository.ObjectId id_jobentry, String code)  
      org.pentaho.di.repository.ObjectId getJobId​(String name, org.pentaho.di.repository.RepositoryDirectoryInterface repositoryDirectory)  
      String[] getJobNames​(org.pentaho.di.repository.ObjectId id_directory, boolean includeDeleted)  
      List<org.pentaho.di.repository.RepositoryElementMetaInterface> getJobObjects​(org.pentaho.di.repository.ObjectId id_directory, boolean includeDeleted)  
      String[] getJobsUsingDatabase​(org.pentaho.di.repository.ObjectId id_database)
      Get the repository version.
      org.pentaho.di.core.logging.LogChannelInterface getLog()  
      org.pentaho.metastore.api.IMetaStore getMetaStore()  
      String getName()  
      RepositoryObject getObjectInformation​(org.pentaho.di.repository.ObjectId objectId, org.pentaho.di.repository.RepositoryObjectType objectType)
      Get more information about a certain object ID in the form of the RepositoryObject
      org.pentaho.di.repository.ObjectId getPartitionSchemaID​(String name)  
      org.pentaho.di.repository.ObjectId[] getPartitionSchemaIDs​(boolean includeDeleted)  
      String[] getPartitionSchemaNames​(boolean includeDeleted)  
      RepositoryMeta getRepositoryMeta()  
      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.
      org.pentaho.di.repository.ObjectId getSlaveID​(String name)  
      org.pentaho.di.repository.ObjectId[] getSlaveIDs​(boolean includeDeleted)  
      String[] getSlaveNames​(boolean includeDeleted)  
      List<SlaveServer> getSlaveServers()  
      boolean getStepAttributeBoolean​(org.pentaho.di.repository.ObjectId id_step, int nr, String code)  
      boolean getStepAttributeBoolean​(org.pentaho.di.repository.ObjectId id_step, int nr, String code, boolean def)  
      boolean getStepAttributeBoolean​(org.pentaho.di.repository.ObjectId id_step, String code)  
      long getStepAttributeInteger​(org.pentaho.di.repository.ObjectId id_step, int nr, String code)  
      long getStepAttributeInteger​(org.pentaho.di.repository.ObjectId id_step, String code)  
      String getStepAttributeString​(org.pentaho.di.repository.ObjectId id_step, int nr, String code)  
      String getStepAttributeString​(org.pentaho.di.repository.ObjectId id_step, String code)  
      org.pentaho.di.repository.ObjectId getTransformationID​(String name, org.pentaho.di.repository.RepositoryDirectoryInterface repositoryDirectory)  
      String[] getTransformationNames​(org.pentaho.di.repository.ObjectId id_directory, boolean includeDeleted)  
      List<org.pentaho.di.repository.RepositoryElementMetaInterface> getTransformationObjects​(org.pentaho.di.repository.ObjectId id_directory, boolean includeDeleted)  
      String[] getTransformationsUsingDatabase​(org.pentaho.di.repository.ObjectId id_database)  
      org.pentaho.platform.api.repository2.unified.IUnifiedRepository getUnderlyingRepository()  
      default Optional<URI> getUri()
      Returns the URI of the repository location, if defined by the implementation
      org.pentaho.di.repository.RepositoryDirectoryInterface getUserHomeDirectory()  
      IUser getUserInfo()  
      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.
      void insertJobEntryDatabase​(org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.ObjectId id_jobentry, org.pentaho.di.repository.ObjectId id_database)  
      org.pentaho.di.repository.ObjectId insertLogEntry​(String description)
      Insert an entry in the audit trail of the repository.
      void insertStepDatabase​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, org.pentaho.di.repository.ObjectId id_database)  
      boolean isConnected()  
      ClusterSchema loadClusterSchema​(org.pentaho.di.repository.ObjectId id_cluster_schema, List<SlaveServer> slaveServers, String versionLabel)  
      org.pentaho.di.core.Condition loadConditionFromStepAttribute​(org.pentaho.di.repository.ObjectId id_step, String code)
      Load a condition from the repository with the Object ID stored in a step attribute.
      org.pentaho.di.core.database.DatabaseMeta loadDatabaseMeta​(org.pentaho.di.repository.ObjectId id_database, String revision)
      Load the Database connection Metadata from the repository
      org.pentaho.di.core.database.DatabaseMeta loadDatabaseMetaFromJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_jobentry, String nameCode, int nr, String idCode, List<org.pentaho.di.core.database.DatabaseMeta> databases)
      This method is introduced to avoid having to go over an integer/string/whatever in the interface and the job entry code.
      org.pentaho.di.core.database.DatabaseMeta loadDatabaseMetaFromJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_jobentry, String nameCode, String idCode, List<org.pentaho.di.core.database.DatabaseMeta> databases)
      This method is introduced to avoid having to go over an integer/string/whatever in the interface and the job entry code.
      org.pentaho.di.core.database.DatabaseMeta loadDatabaseMetaFromStepAttribute​(org.pentaho.di.repository.ObjectId id_step, String code, List<org.pentaho.di.core.database.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​(String jobname, org.pentaho.di.repository.RepositoryDirectoryInterface repdir, org.pentaho.di.core.ProgressMonitorListener monitor, String revision)
      Load a job from the repository
      JobMeta loadJob​(org.pentaho.di.repository.ObjectId id_job, String versionLabel)
      Load a job from the repository by id
      PartitionSchema loadPartitionSchema​(org.pentaho.di.repository.ObjectId id_partition_schema, String versionLabel)  
      org.pentaho.di.repository.RepositoryDirectoryInterface loadRepositoryDirectoryTree()  
      SlaveServer loadSlaveServer​(org.pentaho.di.repository.ObjectId id_slave_server, String versionLabel)  
      TransMeta loadTransformation​(String transname, org.pentaho.di.repository.RepositoryDirectoryInterface repdir, org.pentaho.di.core.ProgressMonitorListener monitor, boolean setInternalVariables, String revision)
      Load a transformation with a name from a folder in the repository
      TransMeta loadTransformation​(org.pentaho.di.repository.ObjectId id_transformation, String versionLabel)
      Load a transformation by id
      List<org.pentaho.di.core.database.DatabaseMeta> readDatabases()
      Read all the databases defined in the repository
      SharedObjects readJobMetaSharedObjects​(JobMeta jobMeta)  
      SharedObjects readTransSharedObjects​(TransMeta transMeta)  
      org.pentaho.di.repository.ObjectId renameJob​(org.pentaho.di.repository.ObjectId id_job, String versionComment, org.pentaho.di.repository.RepositoryDirectoryInterface newDirectory, String newName)
      Move / rename a job
      org.pentaho.di.repository.ObjectId renameJob​(org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.RepositoryDirectoryInterface newDirectory, String newName)
      Move / rename a job
      org.pentaho.di.repository.ObjectId renameRepositoryDirectory​(org.pentaho.di.repository.ObjectId id, org.pentaho.di.repository.RepositoryDirectoryInterface newParentDir, String newName)
      Move / rename a repository directory
      org.pentaho.di.repository.ObjectId renameTransformation​(org.pentaho.di.repository.ObjectId id_transformation, String versionComment, org.pentaho.di.repository.RepositoryDirectoryInterface newDirectory, String newName)
      Move / rename a transformation
      org.pentaho.di.repository.ObjectId renameTransformation​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.RepositoryDirectoryInterface newDirectory, String newName)
      Move / rename a transformation
      void save​(org.pentaho.di.repository.RepositoryElementInterface repositoryElement, String versionComment, Calendar versionDate, org.pentaho.di.core.ProgressMonitorListener monitor, boolean overwrite)
      Save the object to the repository with version comments as well as version dates.
      void save​(org.pentaho.di.repository.RepositoryElementInterface repositoryElement, String versionComment, org.pentaho.di.core.ProgressMonitorListener monitor)  
      void save​(org.pentaho.di.repository.RepositoryElementInterface repositoryElement, String versionComment, org.pentaho.di.core.ProgressMonitorListener monitor, boolean overwrite)
      Save an object to the repository optionally overwriting any associated objects.
      void saveConditionStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, String code, org.pentaho.di.core.Condition condition)
      This method saves the object ID of the condition object (if not null) in the step attributes
      void saveDatabaseMetaJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.ObjectId id_jobentry, int nr, String nameCode, String idCode, org.pentaho.di.core.database.DatabaseMeta database)
      This method saves the object ID of the database object (if not null) in the job entry attributes
      void saveDatabaseMetaJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.ObjectId id_jobentry, String nameCode, String idCode, org.pentaho.di.core.database.DatabaseMeta database)
      This method saves the object ID of the database object (if not null) in the job entry attributes
      void saveDatabaseMetaStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, String code, org.pentaho.di.core.database.DatabaseMeta database)
      This method saves the object ID of the database object (if not null) in the step attributes
      void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.ObjectId id_jobentry, int nr, String code, boolean value)  
      void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.ObjectId id_jobentry, int nr, String code, long value)  
      void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.ObjectId id_jobentry, int nr, String code, String value)  
      void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.ObjectId id_jobentry, String code, boolean value)  
      void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.ObjectId id_jobentry, String code, long value)  
      void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.ObjectId id_jobentry, String code, String value)  
      void saveRepositoryDirectory​(org.pentaho.di.repository.RepositoryDirectoryInterface dir)  
      void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, int nr, String code, boolean value)  
      void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, int nr, String code, double value)  
      void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, int nr, String code, long value)  
      void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, int nr, String code, String value)  
      void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, String code, boolean value)  
      void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, String code, double value)  
      void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, String code, long value)  
      void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, String code, String value)  
      void undeleteObject​(org.pentaho.di.repository.RepositoryElementMetaInterface repositoryObject)
      Removes he deleted flag from a repository element in the repository.
    • Method Detail

      • getName

        String getName()
        Returns:
        The name of the repository
      • getVersion

        String getVersion()
        Get the repository version.
        Returns:
        The repository version as a string
      • getRepositoryMeta

        RepositoryMeta getRepositoryMeta()
        Returns:
        the metadata describing this repository.
      • getUserInfo

        IUser getUserInfo()
        Returns:
        the currently logged on user. (also available through the repository security provider)
      • getLog

        org.pentaho.di.core.logging.LogChannelInterface getLog()
        Returns:
        the logging channel of this repository
      • connect

        void connect​(String username,
                     String password)
              throws org.pentaho.di.core.exception.KettleException,
                     org.pentaho.di.core.exception.KettleSecurityException
        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:
        org.pentaho.di.core.exception.KettleSecurityException - in case the supplied user or password is incorrect.
        org.pentaho.di.core.exception.KettleException - in case there is a general unexpected error OR if we're already connected to the repository.
      • disconnect

        void disconnect()
        Disconnect from the repository.
      • isConnected

        boolean isConnected()
      • getUri

        default Optional<URI> getUri()
        Returns the URI of the repository location, if defined by the implementation
      • init

        void init​(RepositoryMeta repositoryMeta)
        Initialize the repository with the repository metadata and user information.
      • exists

        boolean exists​(String name,
                       org.pentaho.di.repository.RepositoryDirectoryInterface repositoryDirectory,
                       org.pentaho.di.repository.RepositoryObjectType objectType)
                throws org.pentaho.di.core.exception.KettleException
        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:
        org.pentaho.di.core.exception.KettleException - in case something goes wrong.
      • getTransformationID

        org.pentaho.di.repository.ObjectId getTransformationID​(String name,
                                                               org.pentaho.di.repository.RepositoryDirectoryInterface repositoryDirectory)
                                                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getJobId

        org.pentaho.di.repository.ObjectId getJobId​(String name,
                                                    org.pentaho.di.repository.RepositoryDirectoryInterface repositoryDirectory)
                                             throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • save

        void save​(org.pentaho.di.repository.RepositoryElementInterface repositoryElement,
                  String versionComment,
                  org.pentaho.di.core.ProgressMonitorListener monitor)
           throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • save

        void save​(org.pentaho.di.repository.RepositoryElementInterface repositoryElement,
                  String versionComment,
                  org.pentaho.di.core.ProgressMonitorListener monitor,
                  boolean overwrite)
           throws org.pentaho.di.core.exception.KettleException
        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:
        org.pentaho.di.core.exception.KettleException - Error saving the object to the repository
      • save

        void save​(org.pentaho.di.repository.RepositoryElementInterface repositoryElement,
                  String versionComment,
                  Calendar versionDate,
                  org.pentaho.di.core.ProgressMonitorListener monitor,
                  boolean overwrite)
           throws org.pentaho.di.core.exception.KettleException
        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.
        Parameters:
        repositoryElement -
        versionComment -
        versionDate -
        monitor -
        overwrite -
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getDefaultSaveDirectory

        org.pentaho.di.repository.RepositoryDirectoryInterface getDefaultSaveDirectory​(org.pentaho.di.repository.RepositoryElementInterface repositoryElement)
                                                                                throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getUserHomeDirectory

        org.pentaho.di.repository.RepositoryDirectoryInterface getUserHomeDirectory()
                                                                             throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • clearSharedObjectCache

        void clearSharedObjectCache()
        Clear the shared object cache, if applicable.
      • loadTransformation

        TransMeta loadTransformation​(String transname,
                                     org.pentaho.di.repository.RepositoryDirectoryInterface repdir,
                                     org.pentaho.di.core.ProgressMonitorListener monitor,
                                     boolean setInternalVariables,
                                     String revision)
                              throws org.pentaho.di.core.exception.KettleException
        Load a transformation with a name from a folder in the repository
        Parameters:
        transname - the name of the transformation to load
        The - folder to load it from
        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!)
        revision - the revision to load. Specify null to load the last version.
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadTransformation

        TransMeta loadTransformation​(org.pentaho.di.repository.ObjectId id_transformation,
                                     String versionLabel)
                              throws org.pentaho.di.core.exception.KettleException
        Load a transformation by id
        Parameters:
        id_transformation - the id of the transformation to load
        versionLabel - version to load. Specify null to load the last version.
        Throws:
        org.pentaho.di.core.exception.KettleException
      • readTransSharedObjects

        SharedObjects readTransSharedObjects​(TransMeta transMeta)
                                      throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • renameTransformation

        org.pentaho.di.repository.ObjectId renameTransformation​(org.pentaho.di.repository.ObjectId id_transformation,
                                                                org.pentaho.di.repository.RepositoryDirectoryInterface newDirectory,
                                                                String newName)
                                                         throws org.pentaho.di.core.exception.KettleException
        Move / rename a transformation
        Parameters:
        id_transformation - The ObjectId of the transformation to move
        newDirectory - 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:
        org.pentaho.di.core.exception.KettleException
      • renameTransformation

        org.pentaho.di.repository.ObjectId renameTransformation​(org.pentaho.di.repository.ObjectId id_transformation,
                                                                String versionComment,
                                                                org.pentaho.di.repository.RepositoryDirectoryInterface newDirectory,
                                                                String newName)
                                                         throws org.pentaho.di.core.exception.KettleException
        Move / rename a transformation
        Parameters:
        id_transformation - The ObjectId of the transformation to move
        versionComment - Version comment for rename
        newDirectory - 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:
        org.pentaho.di.core.exception.KettleException
      • deleteTransformation

        void deleteTransformation​(org.pentaho.di.repository.ObjectId id_transformation)
                           throws org.pentaho.di.core.exception.KettleException
        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:
        org.pentaho.di.core.exception.KettleException
      • loadJob

        JobMeta loadJob​(String jobname,
                        org.pentaho.di.repository.RepositoryDirectoryInterface repdir,
                        org.pentaho.di.core.ProgressMonitorListener monitor,
                        String revision)
                 throws org.pentaho.di.core.exception.KettleException
        Load a job from the repository
        Parameters:
        jobname - the name
        repdir - the directory
        monitor - the progress monitor or null
        revision - the revision to load. Specify null to load the last version.
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadJob

        JobMeta loadJob​(org.pentaho.di.repository.ObjectId id_job,
                        String versionLabel)
                 throws org.pentaho.di.core.exception.KettleException
        Load a job from the repository by id
        Parameters:
        id_job - the id of the job
        versionLabel - version to load. Specify null to load the last version.
        Throws:
        org.pentaho.di.core.exception.KettleException
      • readJobMetaSharedObjects

        SharedObjects readJobMetaSharedObjects​(JobMeta jobMeta)
                                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • renameJob

        org.pentaho.di.repository.ObjectId renameJob​(org.pentaho.di.repository.ObjectId id_job,
                                                     String versionComment,
                                                     org.pentaho.di.repository.RepositoryDirectoryInterface newDirectory,
                                                     String newName)
                                              throws org.pentaho.di.core.exception.KettleException
        Move / rename a job
        Parameters:
        id_job - The ObjectId of the job to move
        versionComment - Version comment for rename
        newDirectory - 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:
        org.pentaho.di.core.exception.KettleException
      • renameJob

        org.pentaho.di.repository.ObjectId renameJob​(org.pentaho.di.repository.ObjectId id_job,
                                                     org.pentaho.di.repository.RepositoryDirectoryInterface newDirectory,
                                                     String newName)
                                              throws org.pentaho.di.core.exception.KettleException
        Move / rename a job
        Parameters:
        id_job - The ObjectId of the job to move
        newDirectory - 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:
        org.pentaho.di.core.exception.KettleException
      • deleteJob

        void deleteJob​(org.pentaho.di.repository.ObjectId id_job)
                throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadDatabaseMeta

        org.pentaho.di.core.database.DatabaseMeta loadDatabaseMeta​(org.pentaho.di.repository.ObjectId id_database,
                                                                   String revision)
                                                            throws org.pentaho.di.core.exception.KettleException
        Load the Database connection Metadata from the repository
        Parameters:
        id_database - the id of the database connection to load
        revision - the revision to load. Specify null to load the last version.
        Throws:
        org.pentaho.di.core.exception.KettleException - in case something goes wrong with database, connection, etc.
      • deleteDatabaseMeta

        void deleteDatabaseMeta​(String databaseName)
                         throws org.pentaho.di.core.exception.KettleException
        Remove a database connection from the repository
        Parameters:
        databaseName - The name of the connection to remove
        Throws:
        org.pentaho.di.core.exception.KettleException - In case something went wrong: database error, insufficient permissions, depending objects, etc.
      • getDatabaseIDs

        org.pentaho.di.repository.ObjectId[] getDatabaseIDs​(boolean includeDeleted)
                                                     throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getDatabaseNames

        String[] getDatabaseNames​(boolean includeDeleted)
                           throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • readDatabases

        List<org.pentaho.di.core.database.DatabaseMeta> readDatabases()
                                                               throws org.pentaho.di.core.exception.KettleException
        Read all the databases defined in the repository
        Returns:
        a list of all the databases defined in the repository
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getDatabaseID

        org.pentaho.di.repository.ObjectId getDatabaseID​(String name)
                                                  throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadClusterSchema

        ClusterSchema loadClusterSchema​(org.pentaho.di.repository.ObjectId id_cluster_schema,
                                        List<SlaveServer> slaveServers,
                                        String versionLabel)
                                 throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getClusterIDs

        org.pentaho.di.repository.ObjectId[] getClusterIDs​(boolean includeDeleted)
                                                    throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getClusterNames

        String[] getClusterNames​(boolean includeDeleted)
                          throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getClusterID

        org.pentaho.di.repository.ObjectId getClusterID​(String name)
                                                 throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • deleteClusterSchema

        void deleteClusterSchema​(org.pentaho.di.repository.ObjectId id_cluster)
                          throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadSlaveServer

        SlaveServer loadSlaveServer​(org.pentaho.di.repository.ObjectId id_slave_server,
                                    String versionLabel)
                             throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getSlaveIDs

        org.pentaho.di.repository.ObjectId[] getSlaveIDs​(boolean includeDeleted)
                                                  throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getSlaveNames

        String[] getSlaveNames​(boolean includeDeleted)
                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getSlaveServers

        List<SlaveServer> getSlaveServers()
                                   throws org.pentaho.di.core.exception.KettleException
        Returns:
        a list of all the slave servers in the repository.
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getSlaveID

        org.pentaho.di.repository.ObjectId getSlaveID​(String name)
                                               throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • deleteSlave

        void deleteSlave​(org.pentaho.di.repository.ObjectId id_slave)
                  throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadPartitionSchema

        PartitionSchema loadPartitionSchema​(org.pentaho.di.repository.ObjectId id_partition_schema,
                                            String versionLabel)
                                     throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getPartitionSchemaIDs

        org.pentaho.di.repository.ObjectId[] getPartitionSchemaIDs​(boolean includeDeleted)
                                                            throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getPartitionSchemaNames

        String[] getPartitionSchemaNames​(boolean includeDeleted)
                                  throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getPartitionSchemaID

        org.pentaho.di.repository.ObjectId getPartitionSchemaID​(String name)
                                                         throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • deletePartitionSchema

        void deletePartitionSchema​(org.pentaho.di.repository.ObjectId id_partition_schema)
                            throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadRepositoryDirectoryTree

        org.pentaho.di.repository.RepositoryDirectoryInterface loadRepositoryDirectoryTree()
                                                                                    throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • findDirectory

        org.pentaho.di.repository.RepositoryDirectoryInterface findDirectory​(String directory)
                                                                      throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • findDirectory

        org.pentaho.di.repository.RepositoryDirectoryInterface findDirectory​(org.pentaho.di.repository.ObjectId directory)
                                                                      throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveRepositoryDirectory

        void saveRepositoryDirectory​(org.pentaho.di.repository.RepositoryDirectoryInterface dir)
                              throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • deleteRepositoryDirectory

        void deleteRepositoryDirectory​(org.pentaho.di.repository.RepositoryDirectoryInterface dir)
                                throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • renameRepositoryDirectory

        org.pentaho.di.repository.ObjectId renameRepositoryDirectory​(org.pentaho.di.repository.ObjectId id,
                                                                     org.pentaho.di.repository.RepositoryDirectoryInterface newParentDir,
                                                                     String newName)
                                                              throws org.pentaho.di.core.exception.KettleException
        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:
        org.pentaho.di.core.exception.KettleException
      • createRepositoryDirectory

        org.pentaho.di.repository.RepositoryDirectoryInterface createRepositoryDirectory​(org.pentaho.di.repository.RepositoryDirectoryInterface parentDirectory,
                                                                                         String directoryPath)
                                                                                  throws org.pentaho.di.core.exception.KettleException
        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:
        org.pentaho.di.core.exception.KettleException - In case something goes wrong
      • getTransformationNames

        String[] getTransformationNames​(org.pentaho.di.repository.ObjectId id_directory,
                                        boolean includeDeleted)
                                 throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getJobObjects

        List<org.pentaho.di.repository.RepositoryElementMetaInterface> getJobObjects​(org.pentaho.di.repository.ObjectId id_directory,
                                                                                     boolean includeDeleted)
                                                                              throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getTransformationObjects

        List<org.pentaho.di.repository.RepositoryElementMetaInterface> getTransformationObjects​(org.pentaho.di.repository.ObjectId id_directory,
                                                                                                boolean includeDeleted)
                                                                                         throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getJobAndTransformationObjects

        List<org.pentaho.di.repository.RepositoryElementMetaInterface> getJobAndTransformationObjects​(org.pentaho.di.repository.ObjectId id_directory,
                                                                                                      boolean includeDeleted)
                                                                                               throws org.pentaho.di.core.exception.KettleException
        Gets all job and transformation objects in the given directory. (Combines getJobObjects(ObjectId, boolean) and getTransformationObjects(ObjectId, boolean) into one operation.
        Parameters:
        id_directory - directory
        includeDeleted - true to return deleted objects
        Returns:
        list of repository objects
        Throws:
        org.pentaho.di.core.exception.KettleException - In case something goes wrong
      • getJobNames

        String[] getJobNames​(org.pentaho.di.repository.ObjectId id_directory,
                             boolean includeDeleted)
                      throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getDirectoryNames

        String[] getDirectoryNames​(org.pentaho.di.repository.ObjectId id_directory)
                            throws org.pentaho.di.core.exception.KettleException
        Returns the child directory names of a parent directory
        Parameters:
        id_directory - parent directory id
        Returns:
        array of child names
        Throws:
        org.pentaho.di.core.exception.KettleException
      • insertLogEntry

        org.pentaho.di.repository.ObjectId insertLogEntry​(String description)
                                                   throws org.pentaho.di.core.exception.KettleException
        Insert an entry in the audit trail of the repository. This is an optional operation and depends on the capabilities of the underlying repository.
        Parameters:
        The - description to be put in the audit trail of the repository.
        Throws:
        org.pentaho.di.core.exception.KettleException
      • insertStepDatabase

        void insertStepDatabase​(org.pentaho.di.repository.ObjectId id_transformation,
                                org.pentaho.di.repository.ObjectId id_step,
                                org.pentaho.di.repository.ObjectId id_database)
                         throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • insertJobEntryDatabase

        void insertJobEntryDatabase​(org.pentaho.di.repository.ObjectId id_job,
                                    org.pentaho.di.repository.ObjectId id_jobentry,
                                    org.pentaho.di.repository.ObjectId id_database)
                             throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveConditionStepAttribute

        void saveConditionStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation,
                                        org.pentaho.di.repository.ObjectId id_step,
                                        String code,
                                        org.pentaho.di.core.Condition condition)
                                 throws org.pentaho.di.core.exception.KettleException
        This method saves the object ID of the condition object (if not null) in the step attributes
        Parameters:
        id_step -
        code -
        condition -
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadConditionFromStepAttribute

        org.pentaho.di.core.Condition loadConditionFromStepAttribute​(org.pentaho.di.repository.ObjectId id_step,
                                                                     String code)
                                                              throws org.pentaho.di.core.exception.KettleException
        Load a condition from the repository with the Object ID stored in a step attribute.
        Parameters:
        id_step -
        code -
        Returns:
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getStepAttributeBoolean

        boolean getStepAttributeBoolean​(org.pentaho.di.repository.ObjectId id_step,
                                        int nr,
                                        String code,
                                        boolean def)
                                 throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getStepAttributeBoolean

        boolean getStepAttributeBoolean​(org.pentaho.di.repository.ObjectId id_step,
                                        int nr,
                                        String code)
                                 throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getStepAttributeBoolean

        boolean getStepAttributeBoolean​(org.pentaho.di.repository.ObjectId id_step,
                                        String code)
                                 throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getStepAttributeInteger

        long getStepAttributeInteger​(org.pentaho.di.repository.ObjectId id_step,
                                     int nr,
                                     String code)
                              throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getStepAttributeInteger

        long getStepAttributeInteger​(org.pentaho.di.repository.ObjectId id_step,
                                     String code)
                              throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getStepAttributeString

        String getStepAttributeString​(org.pentaho.di.repository.ObjectId id_step,
                                      int nr,
                                      String code)
                               throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getStepAttributeString

        String getStepAttributeString​(org.pentaho.di.repository.ObjectId id_step,
                                      String code)
                               throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveStepAttribute

        void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation,
                               org.pentaho.di.repository.ObjectId id_step,
                               int nr,
                               String code,
                               String value)
                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveStepAttribute

        void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation,
                               org.pentaho.di.repository.ObjectId id_step,
                               String code,
                               String value)
                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveStepAttribute

        void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation,
                               org.pentaho.di.repository.ObjectId id_step,
                               int nr,
                               String code,
                               boolean value)
                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveStepAttribute

        void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation,
                               org.pentaho.di.repository.ObjectId id_step,
                               String code,
                               boolean value)
                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveStepAttribute

        void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation,
                               org.pentaho.di.repository.ObjectId id_step,
                               int nr,
                               String code,
                               long value)
                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveStepAttribute

        void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation,
                               org.pentaho.di.repository.ObjectId id_step,
                               String code,
                               long value)
                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveStepAttribute

        void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation,
                               org.pentaho.di.repository.ObjectId id_step,
                               int nr,
                               String code,
                               double value)
                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveStepAttribute

        void saveStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation,
                               org.pentaho.di.repository.ObjectId id_step,
                               String code,
                               double value)
                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • countNrStepAttributes

        int countNrStepAttributes​(org.pentaho.di.repository.ObjectId id_step,
                                  String code)
                           throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • countNrJobEntryAttributes

        int countNrJobEntryAttributes​(org.pentaho.di.repository.ObjectId id_jobentry,
                                      String code)
                               throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getJobEntryAttributeBoolean

        boolean getJobEntryAttributeBoolean​(org.pentaho.di.repository.ObjectId id_jobentry,
                                            String code)
                                     throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getJobEntryAttributeBoolean

        boolean getJobEntryAttributeBoolean​(org.pentaho.di.repository.ObjectId id_jobentry,
                                            int nr,
                                            String code)
                                     throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getJobEntryAttributeBoolean

        boolean getJobEntryAttributeBoolean​(org.pentaho.di.repository.ObjectId id_jobentry,
                                            String code,
                                            boolean def)
                                     throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getJobEntryAttributeInteger

        long getJobEntryAttributeInteger​(org.pentaho.di.repository.ObjectId id_jobentry,
                                         String code)
                                  throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getJobEntryAttributeInteger

        long getJobEntryAttributeInteger​(org.pentaho.di.repository.ObjectId id_jobentry,
                                         int nr,
                                         String code)
                                  throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getJobEntryAttributeString

        String getJobEntryAttributeString​(org.pentaho.di.repository.ObjectId id_jobentry,
                                          String code)
                                   throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getJobEntryAttributeString

        String getJobEntryAttributeString​(org.pentaho.di.repository.ObjectId id_jobentry,
                                          int nr,
                                          String code)
                                   throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveJobEntryAttribute

        void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job,
                                   org.pentaho.di.repository.ObjectId id_jobentry,
                                   int nr,
                                   String code,
                                   String value)
                            throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveJobEntryAttribute

        void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job,
                                   org.pentaho.di.repository.ObjectId id_jobentry,
                                   String code,
                                   String value)
                            throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveJobEntryAttribute

        void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job,
                                   org.pentaho.di.repository.ObjectId id_jobentry,
                                   int nr,
                                   String code,
                                   boolean value)
                            throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveJobEntryAttribute

        void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job,
                                   org.pentaho.di.repository.ObjectId id_jobentry,
                                   String code,
                                   boolean value)
                            throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveJobEntryAttribute

        void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job,
                                   org.pentaho.di.repository.ObjectId id_jobentry,
                                   int nr,
                                   String code,
                                   long value)
                            throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveJobEntryAttribute

        void saveJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job,
                                   org.pentaho.di.repository.ObjectId id_jobentry,
                                   String code,
                                   long value)
                            throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadDatabaseMetaFromStepAttribute

        org.pentaho.di.core.database.DatabaseMeta loadDatabaseMetaFromStepAttribute​(org.pentaho.di.repository.ObjectId id_step,
                                                                                    String code,
                                                                                    List<org.pentaho.di.core.database.DatabaseMeta> databases)
                                                                             throws org.pentaho.di.core.exception.KettleException
        This method is introduced to avoid having to go over an integer/string/whatever in the interface and the step code.
        Parameters:
        id_step -
        code -
        Returns:
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveDatabaseMetaStepAttribute

        void saveDatabaseMetaStepAttribute​(org.pentaho.di.repository.ObjectId id_transformation,
                                           org.pentaho.di.repository.ObjectId id_step,
                                           String code,
                                           org.pentaho.di.core.database.DatabaseMeta database)
                                    throws org.pentaho.di.core.exception.KettleException
        This method saves the object ID of the database object (if not null) in the step attributes
        Parameters:
        id_transformation -
        id_step -
        code -
        database -
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadDatabaseMetaFromJobEntryAttribute

        org.pentaho.di.core.database.DatabaseMeta loadDatabaseMetaFromJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_jobentry,
                                                                                        String nameCode,
                                                                                        String idCode,
                                                                                        List<org.pentaho.di.core.database.DatabaseMeta> databases)
                                                                                 throws org.pentaho.di.core.exception.KettleException
        This method is introduced to avoid having to go over an integer/string/whatever in the interface and the job entry code.
        Parameters:
        id_step -
        code -
        Returns:
        Throws:
        org.pentaho.di.core.exception.KettleException
      • loadDatabaseMetaFromJobEntryAttribute

        org.pentaho.di.core.database.DatabaseMeta loadDatabaseMetaFromJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_jobentry,
                                                                                        String nameCode,
                                                                                        int nr,
                                                                                        String idCode,
                                                                                        List<org.pentaho.di.core.database.DatabaseMeta> databases)
                                                                                 throws org.pentaho.di.core.exception.KettleException
        This method is introduced to avoid having to go over an integer/string/whatever in the interface and the job entry code.
        Parameters:
        id_entry -
        nameCode -
        nr -
        idcode -
        databases -
        Returns:
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveDatabaseMetaJobEntryAttribute

        void saveDatabaseMetaJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job,
                                               org.pentaho.di.repository.ObjectId id_jobentry,
                                               String nameCode,
                                               String idCode,
                                               org.pentaho.di.core.database.DatabaseMeta database)
                                        throws org.pentaho.di.core.exception.KettleException
        This method saves the object ID of the database object (if not null) in the job entry attributes
        Parameters:
        id_job -
        id_jobentry -
        idCode -
        database -
        Throws:
        org.pentaho.di.core.exception.KettleException
      • saveDatabaseMetaJobEntryAttribute

        void saveDatabaseMetaJobEntryAttribute​(org.pentaho.di.repository.ObjectId id_job,
                                               org.pentaho.di.repository.ObjectId id_jobentry,
                                               int nr,
                                               String nameCode,
                                               String idCode,
                                               org.pentaho.di.core.database.DatabaseMeta database)
                                        throws org.pentaho.di.core.exception.KettleException
        This method saves the object ID of the database object (if not null) in the job entry attributes
        Parameters:
        id_job -
        id_jobentry -
        nr -
        code -
        database -
        Throws:
        org.pentaho.di.core.exception.KettleException
      • undeleteObject

        void undeleteObject​(org.pentaho.di.repository.RepositoryElementMetaInterface repositoryObject)
                     throws org.pentaho.di.core.exception.KettleException
        Removes he deleted flag from a repository element in the repository. If it wasn't deleted, it remains untouched.
        Parameters:
        element - the repository element to restore
        Throws:
        org.pentaho.di.core.exception.KettleException - get throws in case something goes horribly wrong.
      • getServiceInterfaces

        List<Class<? extends IRepositoryService>> getServiceInterfaces()
                                                                throws org.pentaho.di.core.exception.KettleException
        Retrieves the current list of of IRepository Services.
        Returns:
        List of repository services
        Throws:
        org.pentaho.di.core.exception.KettleException - in case something goes horribly wrong.
      • getService

        IRepositoryService getService​(Class<? extends IRepositoryService> clazz)
                               throws org.pentaho.di.core.exception.KettleException
        Retrieves a given repository service
        Parameters:
        service - class name
        Returns:
        repository service
        Throws:
        org.pentaho.di.core.exception.KettleException - in case something goes horribly wrong.
      • hasService

        boolean hasService​(Class<? extends IRepositoryService> clazz)
                    throws org.pentaho.di.core.exception.KettleException
        Checks whether a given repository service is available or not
        Parameters:
        repository - service class that needs to be checked for support
        Throws:
        org.pentaho.di.core.exception.KettleException - in case something goes horribly wrong.
      • getObjectInformation

        RepositoryObject getObjectInformation​(org.pentaho.di.repository.ObjectId objectId,
                                              org.pentaho.di.repository.RepositoryObjectType objectType)
                                       throws org.pentaho.di.core.exception.KettleException
        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:
        org.pentaho.di.core.exception.KettleException - In case there was a loading problem.
      • getConnectMessage

        String getConnectMessage()
        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
      • getJobsUsingDatabase

        String[] getJobsUsingDatabase​(org.pentaho.di.repository.ObjectId id_database)
                               throws org.pentaho.di.core.exception.KettleException
        Get the repository version.
        Returns:
        The repository version as a string
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getTransformationsUsingDatabase

        String[] getTransformationsUsingDatabase​(org.pentaho.di.repository.ObjectId id_database)
                                          throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getImporter

        IRepositoryImporter getImporter()
        Returns:
        the importer that will handle imports into this repository
      • getExporter

        IRepositoryExporter getExporter()
                                 throws org.pentaho.di.core.exception.KettleException
        Returns:
        the exporter that will handle exports from this repository
        Throws:
        org.pentaho.di.core.exception.KettleException
      • getMetaStore

        org.pentaho.metastore.api.IMetaStore getMetaStore()
        Returns:
        the Metastore that is implemented in this Repository. Return null if this repository doesn't implement a Metastore.
      • getUnderlyingRepository

        org.pentaho.platform.api.repository2.unified.IUnifiedRepository getUnderlyingRepository()
        Returns:
        repository for connect to server