Package org.pentaho.di.core.osgi.api

Interface NamedClusterServiceOsgi

public interface NamedClusterServiceOsgi
Created by tkafalas on 7/6/2017.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close(org.pentaho.metastore.api.IMetaStore metastore)
    If the metastore object temporary and should not be kept active indefinitely, this method will release all resources associated with the metastore.
    boolean
    contains(String clusterName, org.pentaho.metastore.api.IMetaStore metastore)
    This method checks if the NamedCluster exists in the metastore
    void
    create(NamedClusterOsgi namedCluster, org.pentaho.metastore.api.IMetaStore metastore)
    Saves a named cluster in the provided IMetaStore
    void
    delete(String clusterName, org.pentaho.metastore.api.IMetaStore metastore)
    Deletes a NamedCluster from the provided IMetaStore
    NamedClusterOsgi
    getClusterTemplate()
    This method returns the named cluster template used to configure new NamedClusters.
    NamedClusterOsgi
    getNamedClusterByName(String namedCluster, org.pentaho.metastore.api.IMetaStore metastore)
     
    Map<String,Object>
    getProperties()
    This method load the properties for named cluster from /etc/config folder
    List<NamedClusterOsgi>
    list(org.pentaho.metastore.api.IMetaStore metastore)
    This method lists the NamedCluster in the given IMetaStore
    List<String>
    listNames(org.pentaho.metastore.api.IMetaStore metastore)
    This method returns the list of NamedCluster names in the IMetaStore
    NamedClusterOsgi
    read(String clusterName, org.pentaho.metastore.api.IMetaStore metastore)
    Reads a NamedCluster from the provided IMetaStore
    void
    setClusterTemplate(NamedClusterOsgi clusterTemplate)
    This method will set the cluster template used when creating new NamedClusters
    void
    update(NamedClusterOsgi namedCluster, org.pentaho.metastore.api.IMetaStore metastore)
    Updates a NamedCluster in the provided IMetaStore

  • Method Details

    • getClusterTemplate

      NamedClusterOsgi getClusterTemplate()
      This method returns the named cluster template used to configure new NamedClusters.

      Note that this method returns a clone (deep) of the template.

      Returns:
      the NamedCluster template

    • setClusterTemplate

      void setClusterTemplate(NamedClusterOsgi clusterTemplate)
      This method will set the cluster template used when creating new NamedClusters
      Parameters:
      clusterTemplate - the NamedCluster template to set

    • create

      void create(NamedClusterOsgi namedCluster, org.pentaho.metastore.api.IMetaStore metastore) throws org.pentaho.metastore.api.exceptions.MetaStoreException
      Saves a named cluster in the provided IMetaStore
      Parameters:
      namedCluster - the NamedCluster to save
      metastore - the IMetaStore to operate with
      Throws:
      org.pentaho.metastore.api.exceptions.MetaStoreException

    • read

      NamedClusterOsgi read(String clusterName, org.pentaho.metastore.api.IMetaStore metastore) throws org.pentaho.metastore.api.exceptions.MetaStoreException
      Reads a NamedCluster from the provided IMetaStore
      Parameters:
      clusterName - the name of the NamedCluster to load
      metastore - the IMetaStore to operate with
      Returns:
      the NamedCluster that was loaded
      Throws:
      org.pentaho.metastore.api.exceptions.MetaStoreException

    • update

      void update(NamedClusterOsgi namedCluster, org.pentaho.metastore.api.IMetaStore metastore) throws org.pentaho.metastore.api.exceptions.MetaStoreException
      Updates a NamedCluster in the provided IMetaStore
      Parameters:
      namedCluster - the NamedCluster to update
      metastore - the IMetaStore to operate with
      Throws:
      org.pentaho.metastore.api.exceptions.MetaStoreException

    • delete

      void delete(String clusterName, org.pentaho.metastore.api.IMetaStore metastore) throws org.pentaho.metastore.api.exceptions.MetaStoreException
      Deletes a NamedCluster from the provided IMetaStore
      Parameters:
      clusterName - the NamedCluster to delete
      metastore - the IMetaStore to operate with
      Throws:
      org.pentaho.metastore.api.exceptions.MetaStoreException

    • list

      List<NamedClusterOsgi> list(org.pentaho.metastore.api.IMetaStore metastore) throws org.pentaho.metastore.api.exceptions.MetaStoreException
      This method lists the NamedCluster in the given IMetaStore
      Parameters:
      metastore - the IMetaStore to operate with
      Returns:
      the list of NamedClusters in the provided IMetaStore
      Throws:
      org.pentaho.metastore.api.exceptions.MetaStoreException

    • listNames

      List<String> listNames(org.pentaho.metastore.api.IMetaStore metastore) throws org.pentaho.metastore.api.exceptions.MetaStoreException
      This method returns the list of NamedCluster names in the IMetaStore
      Parameters:
      metastore - the IMetaStore to operate with
      Returns:
      the list of NamedCluster names (Strings)
      Throws:
      org.pentaho.metastore.api.exceptions.MetaStoreException

    • contains

      boolean contains(String clusterName, org.pentaho.metastore.api.IMetaStore metastore) throws org.pentaho.metastore.api.exceptions.MetaStoreException
      This method checks if the NamedCluster exists in the metastore
      Parameters:
      clusterName - the name of the NamedCluster to check
      metastore - the IMetaStore to operate with
      Returns:
      true if the NamedCluster exists in the given metastore
      Throws:
      org.pentaho.metastore.api.exceptions.MetaStoreException

    • getNamedClusterByName

      NamedClusterOsgi getNamedClusterByName(String namedCluster, org.pentaho.metastore.api.IMetaStore metastore)

    • getProperties

      Map<String,Object> getProperties()
      This method load the properties for named cluster from /etc/config folder
      Returns:
      map with properties for named cluster

    • close

      void close(org.pentaho.metastore.api.IMetaStore metastore)
      If the metastore object temporary and should not be kept active indefinitely, this method will release all resources associated with the metastore.
      Parameters:
      metastore - the IMetaStore being disposed.