org.teiid.adminapi
Interface Admin

public interface Admin

Nested Class Summary

static class

Admin.Cache

Method Summary

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

Method Detail

assignToModel

void assignToModel(java.lang.String vdbName,
                   int vdbVersion,
                   java.lang.String modelName,
                   java.lang.String sourceName,
                   java.lang.String translatorName,
                   java.lang.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(java.lang.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

deployVDB

void deployVDB(java.lang.String fileName,
               java.io.InputStream vdb)
               throws AdminException

Deploy a VDB file.

Parameters:

name - Name of the VDB file to save under

VDB - VDB.

Throws:

AdminException

deleteVDB

void deleteVDB(java.lang.String vdbName,
               int vdbVersion)
               throws AdminException

Delete the VDB with the given name and version

Parameters:

vdbName -

version -

Throws:

AdminException

getVDBs

java.util.Set<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(java.lang.String vdbName,
           int vbdVersion)
           throws AdminException

Get the VDB

Parameters:

vdbName -

vbdVersion -

Returns:

Throws:

AdminException

getTranslators

java.util.Collection<Translator> getTranslators()
                                                throws AdminException

Get the translators that are available in the configuration

Returns:

Collection of Translator

Throws:

AdminException

getTranslator

Translator getTranslator(java.lang.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

WorkerPoolStatistics getWorkerPoolStats()
                                        throws AdminException

Get the Worker Pool statistics in runtime engine.

Returns:

WorkerPoolStatistics

Throws:

AdminException

getCacheTypes

java.util.Collection<java.lang.String> getCacheTypes()
                                                     throws AdminException

Get the Caches that correspond to the specified identifier pattern

Returns:

Collection of String

Throws:

AdminException

getSessions

java.util.Collection<Session> getSessions()
                                          throws AdminException

Get all the current Sessions.

Returns:

Collection of Session

Throws:

AdminException

getRequests

java.util.Collection<Request> getRequests()
                                          throws AdminException

Get the all Requests that are currently in process

Returns:

Collection of Request

Throws:

AdminException

getRequestsForSession

java.util.Collection<Request> getRequestsForSession(java.lang.String sessionId)
                                                    throws AdminException

Get the Requests for the given session

Returns:

Collection of Request

Throws:

AdminException

getTemplatePropertyDefinitions

java.util.Collection<PropertyDefinition> getTemplatePropertyDefinitions(java.lang.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

java.util.Collection<Transaction> getTransactions()
                                                  throws AdminException

Get all transaction matching the identifier.

Returns:

Throws:

AdminException

clearCache

void clearCache(java.lang.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(java.lang.String cacheType,
                java.lang.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

CacheStatistics getCacheStats(java.lang.String cacheType)
                              throws AdminException

Get the Cache Statistics for the given type

Parameters:

cacheType - Cache Type

Returns:

CacheStatistics

Throws:

AdminException

terminateSession

void terminateSession(java.lang.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(java.lang.String sessionId,
                   long executionId)
                   throws AdminException

Cancel Request

Parameters:

sessionId - session Identifier for the request.

executionId - request Identifier

Throws:

AdminException

terminateTransaction

void terminateTransaction(java.lang.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(java.lang.String vdbName,
                        int vdbVersion,
                        java.lang.String dataRole,
                        java.lang.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(java.lang.String vdbName,
                           int vdbVersion,
                           java.lang.String dataRole,
                           java.lang.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(java.lang.String vdbName,
                                    int vdbVersion,
                                    java.lang.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(java.lang.String sourceVDBName,
               int sourceVDBVersion,
               java.lang.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(java.lang.String deploymentName,
                      java.lang.String templateName,
                      java.util.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(java.lang.String deployedName)
                      throws AdminException

Delete data source.

Parameters:

deployedName -

Throws:

AdminException

getDataSourceNames

java.util.Collection<java.lang.String> getDataSourceNames()
                                                          throws AdminException

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

Throws:

AdminException

getDataSourceTemplateNames

java.util.Set<java.lang.String> getDataSourceTemplateNames()
                                                           throws AdminException

Get the Datasource templates available in the configuration.

Returns:

Set of template names.

Throws:

AdminException

markDataSourceAvailable

void markDataSourceAvailable(java.lang.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