Package org.teiid.adminapi

Interface Admin

    • Method Detail

      • removeSource

        @Deprecated
void removeSource​(String vdbName,
                  int vdbVersion,
                  String modelName,
                  String sourceName)
           throws AdminException
        Deprecated.
        Removes a Translator and Data source from a VDB's Model
        Parameters:
        vdbName - Name of the VDB
        vdbVersion - Version of the VDB
        modelName - Name of the Model
        sourceName - source name
        Throws:
        AdminException

      • removeSource

        void removeSource​(String vdbName,
                  String vdbVersion,
                  String modelName,
                  String sourceName)
           throws AdminException
        Removes a Translator and Data source from a VDB's Model
        Parameters:
        vdbName - Name of the VDB
        vdbVersion - Version of the VDB
        modelName - Name of the Model
        sourceName - source name
        Throws:
        AdminException

      • addSource

        @Deprecated
void addSource​(String vdbName,
               int vdbVersion,
               String modelName,
               String sourceName,
               String translatorName,
               String dsName)
        throws AdminException
        Deprecated.
        Adds a Translator and Data source to a VDB's Model
        Parameters:
        vdbName - Name of the VDB
        vdbVersion - Version of the VDB
        modelName - Name of the Model
        sourceName - source name
        translatorName -
        dsName - data source name that can found in the JNDI map.
        Throws:
        AdminException

      • addSource

        void addSource​(String vdbName,
               String vdbVersion,
               String modelName,
               String sourceName,
               String translatorName,
               String dsName)
        throws AdminException
        Adds a Translator and Data source to a VDB's Model
        Parameters:
        vdbName - Name of the VDB
        vdbVersion - Version of the VDB
        modelName - Name of the Model
        sourceName - source name
        translatorName -
        dsName - data source name that can found in the JNDI map.
        Throws:
        AdminException

      • updateSource

        @Deprecated
void updateSource​(String vdbName,
                  int vdbVersion,
                  String sourceName,
                  String translatorName,
                  String dsName)
           throws AdminException
        Deprecated.
        Update a source's Translator and Data source
        Parameters:
        vdbName - Name of the VDB
        vdbVersion - Version of the VDB
        sourceName - source name
        translatorName -
        dsName - data source name that can found in the JNDI map.
        Throws:
        AdminException

      • updateSource

        void updateSource​(String vdbName,
                  String vdbVersion,
                  String sourceName,
                  String translatorName,
                  String dsName)
           throws AdminException
        Update a source's Translator and Data source
        Parameters:
        vdbName - Name of the VDB
        vdbVersion - Version of the VDB
        sourceName - source name
        translatorName -
        dsName - data source name that can found in the JNDI map.
        Throws:
        AdminException

      • deploy

        void deploy​(String deployName,
            InputStream content,
            boolean persistent)
     throws AdminException
        Deploy a artifact (VDB, JAR, RAR files)
        Parameters:
        deployName - Name of the VDB file to save under
        content -
        persistent - the deployed artifact is persisted or not
        Throws:
        AdminException

      • getVDBs

        Collection<? extends VDB> getVDBs()
                           throws AdminException
        Get the VDBs that are currently deployed in the system
        Returns:
        Collection of VDBs. There could be multiple VDBs with the same name in the Collection but they will differ by VDB version.
        Throws:
        AdminException

      • restartVDB

        @Deprecated
void restartVDB​(String vdbName,
                int vdbVersion,
                String... models)
         throws AdminException
        Deprecated.
        Restart the VDB. This issues reload of the metadata.
        Parameters:
        vdbName -
        vdbVersion -
        models - names for which metadata needs to be reloaded, if null or not supplied all models reloaded
        Throws:
        AdminException

      • restartVDB

        void restartVDB​(String vdbName,
                String vdbVersion,
                String... models)
         throws AdminException
        Restart the VDB. This issues reload of the metadata.
        Parameters:
        vdbName -
        vdbVersion -
        models - names for which metadata needs to be reloaded, if null or not supplied all models reloaded
        Throws:
        AdminException

      • getTranslator

        Translator getTranslator​(String deployedName)
                  throws AdminException
        Get the translator by the given the deployed name.
        Parameters:
        deployedName - - name of the deployed translator
        Returns:
        null if not found
        Throws:
        AdminException

      • getTemplatePropertyDefinitions

        Collection<? extends PropertyDefinition> getTemplatePropertyDefinitions​(String templateName)
                                                                 throws AdminException
        Get all of the available configuration Properties for the specified connector
        Parameters:
        templateName - - Name of the connector
        Returns:
        Throws:
        AdminException

      • clearCache

        void clearCache​(String cacheType)
         throws AdminException
        Clear the cache or caches specified by the cacheIdentifier.
        Parameters:
        cacheType - Cache Type No wild cards currently supported, must be explicit
        Throws:
        AdminException

      • clearCache

        @Deprecated
void clearCache​(String cacheType,
                String vdbName,
                int vdbVersion)
         throws AdminException
        Deprecated.
        Clear the cache of the given VDB for provided cache type
        Parameters:
        cacheType - Cache Type No wild cards currently supported, must be explicit
        vdbName - - Name of the VDB
        vdbVersion - - VDB version
        Throws:
        AdminException

      • clearCache

        void clearCache​(String cacheType,
                String vdbName,
                String vdbVersion)
         throws AdminException
        Clear the cache of the given VDB for provided cache type
        Parameters:
        cacheType - Cache Type No wild cards currently supported, must be explicit
        vdbName - - Name of the VDB
        vdbVersion - - VDB version
        Throws:
        AdminException

      • terminateSession

        void terminateSession​(String sessionId)
               throws AdminException
        Terminate the Session
        Parameters:
        sessionId - Session Identifier Session. No wild cards currently supported, must be explicit
        Throws:
        AdminException

      • cancelRequest

        void cancelRequest​(String sessionId,
                   long executionId)
            throws AdminException
        Cancel Request
        Parameters:
        sessionId - session Identifier for the request.
        executionId - request Identifier
        Throws:
        AdminException

      • terminateTransaction

        void terminateTransaction​(String transactionId)
                   throws AdminException
        Mark the given global transaction as rollback only.
        Parameters:
        transactionId -
        Throws:
        AdminException

      • close

        void close()
        Closes the admin connection

      • addDataRoleMapping

        @Deprecated
void addDataRoleMapping​(String vdbName,
                        int vdbVersion,
                        String dataRole,
                        String mappedRoleName)
                 throws AdminException
        Deprecated.
        Assign a Role name to the Data Role in a given VDB
        Parameters:
        vdbName -
        vdbVersion -
        dataRole -
        mappedRoleName -
        Throws:
        AdminException

      • addDataRoleMapping

        void addDataRoleMapping​(String vdbName,
                        String vdbVersion,
                        String dataRole,
                        String mappedRoleName)
                 throws AdminException
        Assign a Role name to the Data Role in a given VDB
        Parameters:
        vdbName -
        vdbVersion -
        dataRole -
        mappedRoleName -
        Throws:
        AdminException

      • removeDataRoleMapping

        @Deprecated
void removeDataRoleMapping​(String vdbName,
                           int vdbVersion,
                           String dataRole,
                           String mappedRoleName)
                    throws AdminException
        Deprecated.
        Remove a Role name to the Data Role in a given VDB
        Parameters:
        vdbName -
        vdbVersion -
        dataRole -
        mappedRoleName -
        Throws:
        AdminException

      • removeDataRoleMapping

        void removeDataRoleMapping​(String vdbName,
                           String vdbVersion,
                           String dataRole,
                           String mappedRoleName)
                    throws AdminException
        Remove a Role name to the Data Role in a given VDB
        Parameters:
        vdbName -
        vdbVersion -
        dataRole -
        mappedRoleName -
        Throws:
        AdminException

      • setAnyAuthenticatedForDataRole

        @Deprecated
void setAnyAuthenticatedForDataRole​(String vdbName,
                                    int vdbVersion,
                                    String dataRole,
                                    boolean anyAuthenticated)
                             throws AdminException
        Deprecated.
        Set the any authenticated flag on the Data Role in a given VDB
        Parameters:
        vdbName -
        vdbVersion -
        dataRole -
        anyAuthenticated -
        Throws:
        AdminException

      • setAnyAuthenticatedForDataRole

        void setAnyAuthenticatedForDataRole​(String vdbName,
                                    String vdbVersion,
                                    String dataRole,
                                    boolean anyAuthenticated)
                             throws AdminException
        Set the any authenticated flag on the Data Role in a given VDB
        Parameters:
        vdbName -
        vdbVersion -
        dataRole -
        anyAuthenticated -
        Throws:
        AdminException

      • createDataSource

        void createDataSource​(String deploymentName,
                      String templateName,
                      Properties properties)
               throws AdminException
        Creates a JCA data source
        Use this method to create JDBC driver based connection, XA-datasource or Resource Adapter. Template Name defines the type of connection, if the template name is ends with "-xa" it is considered to be a XA based data source.
        Parameters:
        deploymentName - - This becomes the pool name, as well as the jndi name of the source
        templateName - - type of source. See getDataSourceNames() for all available types.
        properties - - All properties needed to create a data source, like connection-url, user, password to see all the properties use getTemplatePropertyDefinitions(String) to retrieve the full list. The transaction-support property can be set to LocalTransaction for sources that support local transactions.
        Throws:
        AdminException

      • getDataSource

        Properties getDataSource​(String deployedName)
                  throws AdminException
        Given the deployed name of the data source, this will return all the configuration properties used to create the datasource. If sensitive information like passwords are masked, they will NOT be decrypted. "driver-name" property on the returned properties defines the template name used to create this data source.
        Throws:
        AdminException

      • getDataSourceTemplateNames

        Set<String> getDataSourceTemplateNames()
                                throws AdminException
        Get the Datasource templates available in the configuration.
        Returns:
        Set of template names.
        Throws:
        AdminException

      • markDataSourceAvailable

        void markDataSourceAvailable​(String jndiName)
                      throws AdminException
        Tell the engine that the given source is available. Pending dynamic vdb metadata loads will be resumed.
        Parameters:
        jndiName -
        Throws:
        AdminException

      • getSchema

        @Deprecated
String getSchema​(String vdbName,
                 int vdbVersion,
                 String modelName,
                 EnumSet<Admin.SchemaObjectType> allowedTypes,
                 String typeNamePattern)
          throws AdminException
        Deprecated.
        Retrieve the schema of the given model
        Parameters:
        vdbName -
        vdbVersion -
        modelName -
        allowedTypes - EnumSet Type of schema objects to retrieve, null means ALL the schema object types
        typeNamePattern - RegEx pattern to filter to names of tables, procedures that are being read. Null means no filter.
        Throws:
        AdminException

      • getSchema

        String getSchema​(String vdbName,
                 String vdbVersion,
                 String modelName,
                 EnumSet<Admin.SchemaObjectType> allowedTypes,
                 String typeNamePattern)
          throws AdminException
        Retrieve the schema of the given model
        Parameters:
        vdbName -
        vdbVersion -
        modelName -
        allowedTypes - EnumSet Type of schema objects to retrieve, null means ALL the schema object types
        typeNamePattern - RegEx pattern to filter to names of tables, procedures that are being read. Null means no filter.
        Throws:
        AdminException

      • getQueryPlan

        String getQueryPlan​(String sessionId,
                    long executionId)
             throws AdminException
        Get the Query Plan for the given session with provided execution id.
        Parameters:
        sessionId -
        executionId -
        Returns:
        Throws:
        AdminException

      • restart

        void restart()
        Restart the Server

      • setProfileName

        void setProfileName​(String name)
        Set the profile name. A null value will set the default profile name.
        Parameters:
        name -

      • getVDBs

        Collection<? extends VDB> getVDBs​(boolean singleInstance)
                           throws AdminException
        Get the VDBs that are currently deployed in the system
        Parameters:
        singleInstance -
        - true to return the VDB list from only a single server instance, which is the same as getVDBs().
        - false to get all VDBs from all servers in the domain
        Returns:
        Collection of VDBs.
        Throws:
        AdminException

      • deployVDBZip

        void deployVDBZip​(URL url)
           throws AdminException
        Deploy a .vdb or .zip vdb. The deployment name will be taken from the url file name.
        Throws:
        AdminException