org.teiid.adminapi

Interface Admin

public interface Admin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Admin.Cache

Method Summary

Methods

Modifier and Type	Method and Description
void	addDataRoleMapping(String vdbName, int vdbVersion, String dataRole, String mappedRoleName) Assign a Role name to the Data Role in a given VDB
void	assignToModel(String vdbName, int vdbVersion, String modelName, String sourceName, String translatorName, String dsName) Assign a Translator and Data source to a VDB's Model
void	cancelRequest(String sessionId, long executionId) Cancel Request
void	changeVDBConnectionType(String vdbName, int vdbVersion, VDB.ConnectionType type) Change the VDB.ConnectionType of the VDB.
void	clearCache(String cacheType) Clear the cache or caches specified by the cacheIdentifier.
void	clearCache(String cacheType, String vdbName, int vdbVersion) Clear the cache of the given VDB for provided cache type
void	close() Closes the admin connection
void	createDataSource(String deploymentName, String templateName, Properties properties) Creates a JCA data source
void	deleteDataSource(String deployedName) Delete data source.
void	deploy(String deployName, InputStream content) Deploy a artifact (VDB, JAR, RAR files)
Collection<? extends CacheStatistics>	getCacheStats(String cacheType) Get the Cache Statistics for the given type
Collection<String>	getCacheTypes() Get the Caches that correspond to the specified identifier pattern
Collection<String>	getDataSourceNames() Returns the all names of all the data sources available in the configuration.
Set<String>	getDataSourceTemplateNames() Get the Datasource templates available in the configuration.
Collection<? extends Request>	getRequests() Get the all Requests that are currently in process
Collection<? extends Request>	getRequestsForSession(String sessionId) Get the Requests for the given session
Collection<? extends Session>	getSessions() Get all the current Sessions.
Collection<? extends PropertyDefinition>	getTemplatePropertyDefinitions(String templateName) Get all of the available configuration Properties for the specified connector
Collection<? extends Transaction>	getTransactions() Get all transaction matching the identifier.
Translator	getTranslator(String deployedName) Get the translator by the given the deployed name.
Collection<? extends Translator>	getTranslators() Get the translators that are available in the configuration
VDB	getVDB(String vdbName, int vdbVersion) Get the VDB
Collection<? extends VDB>	getVDBs() Get the VDBs that currently deployed in the system
Collection<? extends WorkerPoolStatistics>	getWorkerPoolStats() Get the Worker Pool statistics in runtime engine.
void	markDataSourceAvailable(String jndiName) Tell the engine that the given source is available.
void	mergeVDBs(String sourceVDBName, int sourceVDBVersion, String targetVDBName, int targetVDBVersion) Merge the Source VDB into Target VDB.
void	removeDataRoleMapping(String vdbName, int vdbVersion, String dataRole, String mappedRoleName) Remove a Role name to the Data Role in a given VDB
void	setAnyAuthenticatedForDataRole(String vdbName, int vdbVersion, String dataRole, boolean anyAuthenticated) Set the any authenticated flag on the Data Role in a given VDB
void	terminateSession(String sessionId) Terminate the Session
void	terminateTransaction(String transactionId) Mark the given global transaction as rollback only.
void	undeploy(String deployedName) Undeploy artifact (VDB, JAR, RAR files)

Method Detail

assignToModel

void assignToModel(String vdbName,
                 int vdbVersion,
                 String modelName,
                 String sourceName,
                 String translatorName,
                 String dsName)
                   throws AdminException

Assign 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 to map Connection Factory

sourceName - sourceName for the model

translatorName -

dsName - data source name that can found in the JNDI map.

Throws:

AdminException

changeVDBConnectionType

void changeVDBConnectionType(String vdbName,
                           int vdbVersion,
                           VDB.ConnectionType type)
                             throws AdminException

Change the VDB.ConnectionType of the VDB.

Parameters:

vdbName - Name of the VDB

vdbVersion - Version of the VDB

type -

Throws:

AdminException

deploy

void deploy(String deployName,
          InputStream content)
            throws AdminException

Deploy a artifact (VDB, JAR, RAR files)

Parameters:

deployName - Name of the VDB file to save under

content -

Throws:

AdminException

undeploy

void undeploy(String deployedName)
              throws AdminException

Undeploy artifact (VDB, JAR, RAR files)

Parameters:

deployedName -

Throws:

AdminException

getVDBs

Collection<? extends VDB> getVDBs()
                                  throws AdminException

Get the VDBs that 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

getVDB

VDB getVDB(String vdbName,
         int vdbVersion)
           throws AdminException

Get the VDB

Parameters:

vdbName -

vbdVersion -

Returns:

Throws:

AdminException

getTranslators

Collection<? extends Translator> getTranslators()
                                                throws AdminException

Get the translators that are available in the configuration

Returns:

Collection of Translator

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

getWorkerPoolStats

Collection<? extends WorkerPoolStatistics> getWorkerPoolStats()
                                                              throws AdminException

Get the Worker Pool statistics in runtime engine.

Returns:

Collection of WorkerPoolStatistics

Throws:

AdminException

getCacheTypes

Collection<String> getCacheTypes()
                                 throws AdminException

Get the Caches that correspond to the specified identifier pattern

Returns:

Collection of String

Throws:

AdminException

getSessions

Collection<? extends Session> getSessions()
                                          throws AdminException

Get all the current Sessions.

Returns:

Collection of Session

Throws:

AdminException

getRequests

Collection<? extends Request> getRequests()
                                          throws AdminException

Get the all Requests that are currently in process

Returns:

Collection of Request

Throws:

AdminException

getRequestsForSession

Collection<? extends Request> getRequestsForSession(String sessionId)
                                                    throws AdminException

Get the Requests for the given session

Returns:

Collection of Request

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

getTransactions

Collection<? extends Transaction> getTransactions()
                                                  throws AdminException

Get all transaction matching the identifier.

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

void clearCache(String cacheType,
              String vdbName,
              int 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

getCacheStats

Collection<? extends CacheStatistics> getCacheStats(String cacheType)
                                                    throws AdminException

Get the Cache Statistics for the given type

Parameters:

cacheType - Cache Type

Returns:

Collection of CacheStatistics

Throws:

AdminException

terminateSession

void terminateSession(String sessionId)
                      throws AdminException

Terminate the Session

Parameters:

identifier - 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

void addDataRoleMapping(String vdbName,
                      int 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

void removeDataRoleMapping(String vdbName,
                         int 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

void setAnyAuthenticatedForDataRole(String vdbName,
                                  int 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

mergeVDBs

void mergeVDBs(String sourceVDBName,
             int sourceVDBVersion,
             String targetVDBName,
             int targetVDBVersion)
               throws AdminException

Merge the Source VDB into Target VDB. Both Source and Target VDBs must be present for this method to succeed. The changes will not be persistent between server restarts.

Parameters:

sourceVDBName -

sourceVDBVersion -

targetVDBName -

targetVDBVersion -

Throws:

AdminException

createDataSource

void createDataSource(String deploymentName,
                    String templateName,
                    Properties properties)
                      throws AdminException

Creates a JCA data source

Parameters:

deploymentName - - name of the source

templateName - - template of data source

properties - - properties

Throws:

AdminException

deleteDataSource

void deleteDataSource(String deployedName)
                      throws AdminException

Delete data source.

Parameters:

deployedName -

Throws:

AdminException

getDataSourceNames

Collection<String> getDataSourceNames()
                                      throws AdminException

Returns the all names of all the data sources available in the configuration.

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