Package org.pentaho.di.shared

Interface SharedObjectsManagementInterface<T extends org.pentaho.di.shared.SharedObjectInterface<T> & org.pentaho.di.repository.RepositoryElementInterface>

All Known Subinterfaces:
ClusterSchemaManagementInterface, DatabaseManagementInterface, PartitionSchemaManagementInterface, SlaveServerManagementInterface
All Known Implementing Classes:
BaseSharedObjectsManager, ChangeTrackingClusterSchemaManager, ChangeTrackingDatabaseManager, ChangeTrackingPartitionSchemaManager, ChangeTrackingSharedObjectManager, ChangeTrackingSlaveServerManager, ClusterSchemaManager, DatabaseConnectionManager, PartitionSchemaManager, PassthroughClusterSchemaManager, PassthroughDbConnectionManager, PassthroughManager, PassthroughPartitionSchemaManager, PassthroughSlaveServerManager, SlaveServerManager, VariableSharingClusterSchemaManager, VariableSharingDatabaseManager, VariableSharingSharedObjectManager, VariableSharingSlaveServerManager
public interface SharedObjectsManagementInterface<T extends org.pentaho.di.shared.SharedObjectInterface<T> & org.pentaho.di.repository.RepositoryElementInterface>
This is the management interface used by the UI to perform CRUD operation for all shared objects. The implementors of this interface will be scoped based on the bowl and can be retrieved using bowl's getManager()

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(T sharedObjectInterface)
    Add the SharedObject to global or project specific file store(shared.xml) depending on the bowl
    void
    clear()
    Removes all sharedObjects for a type
    T
    get(String name)
    Get a single SharedObject by name.
    List<T>
    getAll()
    Get the list of SharedObjects based on the current bowl
    void
    remove(String sharedObjectName)
    Remove the provided database
    void
    remove(T sharedObjectInterface)
    Remove the SharedObject

  • Method Details

    • add

      void add(T sharedObjectInterface) throws org.pentaho.di.core.exception.KettleException
      Add the SharedObject to global or project specific file store(shared.xml) depending on the bowl
      Parameters:
      sharedObjectInterface -
      Throws:
      org.pentaho.di.core.exception.KettleException

    • getAll

      List<T> getAll() throws org.pentaho.di.core.exception.KettleException
      Get the list of SharedObjects based on the current bowl
      Returns:
      List Returns the list of DatabaseMeta
      Throws:
      org.pentaho.di.core.exception.KettleException

    • get

      T get(String name) throws org.pentaho.di.core.exception.KettleException
      Get a single SharedObject by name.
      Parameters:
      name - name of the SharedObject
      Returns:
      SharedObjectInterface SharedObject instance
      Throws:
      org.pentaho.di.core.exception.KettleException

    • remove

      void remove(T sharedObjectInterface) throws org.pentaho.di.core.exception.KettleException
      Remove the SharedObject
      Parameters:
      sharedObjectInterface - SharedObject to remove
      Throws:
      org.pentaho.di.core.exception.KettleException

    • remove

      void remove(String sharedObjectName) throws org.pentaho.di.core.exception.KettleException
      Remove the provided database
      Parameters:
      sharedObjectName - name of the SharedObject to remove
      Throws:
      org.pentaho.di.core.exception.KettleException

    • clear

      void clear() throws org.pentaho.di.core.exception.KettleException
      Removes all sharedObjects for a type
      Throws:
      org.pentaho.di.core.exception.KettleException