org.teiid.runtime

Class EmbeddedAdminImpl

java.lang.Object

org.teiid.runtime.EmbeddedAdminImpl

All Implemented Interfaces:

Admin

public class EmbeddedAdminImpl
extends Object
implements Admin

Nested Class Summary

Nested classes/interfaces inherited from interface org.teiid.adminapi.Admin

Admin.Cache, Admin.SchemaObjectType, Admin.TranlatorPropertyType

Constructor Summary

Constructors

Constructor and Description
EmbeddedAdminImpl(EmbeddedServer embeddedServer)

Method Summary

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	addDataRoleMapping(String vdbName, String vdbVersion, String dataRole, String mappedRoleName) Assign a Role name to the Data Role in a given VDB
void	addSource(String vdbName, int vdbVersion, String modelName, String sourceName, String translatorName, String dsName) Adds a Translator and Data source to a VDB's Model
void	addSource(String vdbName, String vdbVersion, String modelName, String sourceName, String translatorName, String dsName) Adds 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	changeVDBConnectionType(String vdbName, String 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	clearCache(String cacheType, String vdbName, String 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)
void	deploy(String deployName, InputStream content, boolean peristent) 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
Properties	getDataSource(String deployedName) Given the deployed name of the data source, this will return all the configuration properties used to create the datasource.
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.
List<String>	getDeployments() Get existing deployments on in the sysem
Collection<? extends EngineStatistics>	getEngineStats() Get the Engine Statistics for the given type
String	getQueryPlan(String sessionId, long executionId) Get the Query Plan for the given session with provided execution id.
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
String	getSchema(String vdbName, int vdbVersion, String modelName, EnumSet<Admin.SchemaObjectType> allowedTypes, String typeNamePattern) Retrieve the schema of the given model
String	getSchema(String vdbName, String vdbVersion, String modelName, EnumSet<Admin.SchemaObjectType> allowedTypes, String typeNamePattern) Retrieve the schema of the given model
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 PropertyDefinition>	getTranslatorPropertyDefinitions(String translatorName) Get all of the available configuration Properties for the specified translator
Collection<? extends PropertyDefinition>	getTranslatorPropertyDefinitions(String translatorName, Admin.TranlatorPropertyType type) Get all of the available configuration Properties for the specified translator
Collection<? extends Translator>	getTranslators() Get the translators that are available in the configuration
VDB	getVDB(String vdbName, int vdbVersion) Get the VDB
VDB	getVDB(String vdbName, String 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.
static String	prettyFormat(String input)
void	removeDataRoleMapping(String vdbName, int vdbVersion, String dataRole, String mappedRoleName) Remove a Role name to the Data Role in a given VDB
void	removeDataRoleMapping(String vdbName, String vdbVersion, String dataRole, String mappedRoleName) Remove a Role name to the Data Role in a given VDB
void	removeSource(String vdbName, int vdbVersion, String modelName, String sourceName) Removes a Translator and Data source from a VDB's Model
void	removeSource(String vdbName, String vdbVersion, String modelName, String sourceName) Removes a Translator and Data source from a VDB's Model
void	restart() Restart the Server
void	restartVDB(String vdbName, int vdbVersion, String... models) Restart the VDB.
void	restartVDB(String vdbName, String vdbVersion, String... models) Restart the 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	setAnyAuthenticatedForDataRole(String vdbName, String vdbVersion, String dataRole, boolean anyAuthenticated) Set the any authenticated flag on the Data Role in a given VDB
void	setProfileName(String name) Set the profile name.
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)
void	updateSource(String vdbName, int vdbVersion, String sourceName, String translatorName, String dsName) Update a source's Translator and Data source
void	updateSource(String vdbName, String vdbVersion, String sourceName, String translatorName, String dsName) Update a source's Translator and Data source

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmbeddedAdminImpl

public EmbeddedAdminImpl(EmbeddedServer embeddedServer)

Method Detail

setProfileName

public void setProfileName(String name)

Description copied from interface: Admin

Set the profile name. A null value will set the default profile name.

Specified by:

setProfileName in interface Admin

clearCache

public void clearCache(String cacheType,
                       String vdbName,
                       int vdbVersion)
                throws AdminException

Description copied from interface: Admin

Clear the cache of the given VDB for provided cache type

Specified by:

clearCache in interface Admin

Parameters:

cacheType - Cache Type No wild cards currently supported, must be explicit

vdbName - - Name of the VDB

vdbVersion - - VDB version

Throws:

AdminException

addDataRoleMapping

public void addDataRoleMapping(String vdbName,
                               int vdbVersion,
                               String dataRole,
                               String mappedRoleName)
                        throws AdminException

Description copied from interface: Admin

Assign a Role name to the Data Role in a given VDB

Specified by:

addDataRoleMapping in interface Admin

Throws:

AdminException

removeDataRoleMapping

public void removeDataRoleMapping(String vdbName,
                                  int vdbVersion,
                                  String dataRole,
                                  String mappedRoleName)
                           throws AdminException

Description copied from interface: Admin

Remove a Role name to the Data Role in a given VDB

Specified by:

removeDataRoleMapping in interface Admin

Throws:

AdminException

setAnyAuthenticatedForDataRole

public void setAnyAuthenticatedForDataRole(String vdbName,
                                           int vdbVersion,
                                           String dataRole,
                                           boolean anyAuthenticated)
                                    throws AdminException

Description copied from interface: Admin

Set the any authenticated flag on the Data Role in a given VDB

Specified by:

setAnyAuthenticatedForDataRole in interface Admin

Throws:

AdminException

changeVDBConnectionType

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

Description copied from interface: Admin

Change the VDB.ConnectionType of the VDB.

Specified by:

changeVDBConnectionType in interface Admin

Parameters:

vdbName - Name of the VDB

vdbVersion - Version of the VDB

Throws:

AdminException

updateSource

public void updateSource(String vdbName,
                         int vdbVersion,
                         String sourceName,
                         String translatorName,
                         String dsName)
                  throws AdminException

Description copied from interface: Admin

Update a source's Translator and Data source

Specified by:

updateSource in interface Admin

Parameters:

vdbName - Name of the VDB

vdbVersion - Version of the VDB

sourceName - source name

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

Throws:

AdminException

addSource

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

Description copied from interface: Admin

Adds a Translator and Data source to a VDB's Model

Specified by:

addSource in interface Admin

Parameters:

vdbName - Name of the VDB

vdbVersion - Version of the VDB

modelName - Name of the Model

sourceName - source name

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

Throws:

AdminException

getVDB

public VDB getVDB(String vdbName,
                  int vdbVersion)
           throws AdminException

Description copied from interface: Admin

Get the VDB

Specified by:

getVDB in interface Admin

Returns:

Throws:

AdminException

removeSource

public void removeSource(String vdbName,
                         int vdbVersion,
                         String modelName,
                         String sourceName)
                  throws AdminException

Description copied from interface: Admin

Removes a Translator and Data source from a VDB's Model

Specified by:

removeSource in interface Admin

Parameters:

vdbName - Name of the VDB

vdbVersion - Version of the VDB

modelName - Name of the Model

sourceName - source name

Throws:

AdminException

restartVDB

public void restartVDB(String vdbName,
                       int vdbVersion,
                       String... models)
                throws AdminException

Description copied from interface: Admin

Restart the VDB. This issues reload of the metadata.

Specified by:

restartVDB in interface Admin

models - names for which metadata needs to be reloaded, if null or not supplied all models reloaded

Throws:

AdminException

getSchema

public String getSchema(String vdbName,
                        int vdbVersion,
                        String modelName,
                        EnumSet<Admin.SchemaObjectType> allowedTypes,
                        String typeNamePattern)
                 throws AdminException

Description copied from interface: Admin

Retrieve the schema of the given model

Specified by:

getSchema in interface Admin

typeNamePattern - RegEx pattern to filter to names of tables, procedures that are being read. Null means no filter.

Throws:

AdminException

removeSource

public void removeSource(String vdbName,
                         String vdbVersion,
                         String modelName,
                         String sourceName)
                  throws AdminException

Description copied from interface: Admin

Removes a Translator and Data source from a VDB's Model

Specified by:

removeSource in interface Admin

Parameters:

vdbName - Name of the VDB

vdbVersion - Version of the VDB

modelName - Name of the Model

sourceName - source name

Throws:

AdminException

addSource

public void addSource(String vdbName,
                      String vdbVersion,
                      String modelName,
                      String sourceName,
                      String translatorName,
                      String dsName)
               throws AdminException

Description copied from interface: Admin

Adds a Translator and Data source to a VDB's Model

Specified by:

addSource in interface Admin

Parameters:

vdbName - Name of the VDB

vdbVersion - Version of the VDB

modelName - Name of the Model

sourceName - source name

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

Throws:

AdminException

updateSource

public void updateSource(String vdbName,
                         String vdbVersion,
                         String sourceName,
                         String translatorName,
                         String dsName)
                  throws AdminException

Description copied from interface: Admin

Update a source's Translator and Data source

Specified by:

updateSource in interface Admin

Parameters:

vdbName - Name of the VDB

vdbVersion - Version of the VDB

sourceName - source name

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

Throws:

AdminException

changeVDBConnectionType

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

Description copied from interface: Admin

Change the VDB.ConnectionType of the VDB.

Specified by:

changeVDBConnectionType in interface Admin

Parameters:

vdbName - Name of the VDB

vdbVersion - Version of the VDB

Throws:

AdminException

deploy

public void deploy(String deployName,
                   InputStream content)
            throws AdminException

Description copied from interface: Admin

Deploy a artifact (VDB, JAR, RAR files)

Specified by:

deploy in interface Admin

Parameters:

deployName - Name of the VDB file to save under

Throws:

AdminException

deploy

public void deploy(String deployName,
                   InputStream content,
                   boolean peristent)
            throws AdminException

Description copied from interface: Admin

Deploy a artifact (VDB, JAR, RAR files)

Specified by:

deploy in interface Admin

Parameters:

deployName - Name of the VDB file to save under

peristent - the deployed artifact is persisted or not

Throws:

AdminException

undeploy

public void undeploy(String deployedName)
              throws AdminException

Description copied from interface: Admin

Undeploy artifact (VDB, JAR, RAR files)

Specified by:

undeploy in interface Admin

Throws:

AdminException

getVDBs

public Collection<? extends VDB> getVDBs()
                                  throws AdminException

Description copied from interface: Admin

Get the VDBs that currently deployed in the system

Specified by:

getVDBs in interface Admin

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

public VDB getVDB(String vdbName,
                  String vdbVersion)
           throws AdminException

Description copied from interface: Admin

Get the VDB

Specified by:

getVDB in interface Admin

Returns:

Throws:

AdminException

restartVDB

public void restartVDB(String vdbName,
                       String vdbVersion,
                       String... models)
                throws AdminException

Description copied from interface: Admin

Restart the VDB. This issues reload of the metadata.

Specified by:

restartVDB in interface Admin

models - names for which metadata needs to be reloaded, if null or not supplied all models reloaded

Throws:

AdminException

getTranslators

public Collection<? extends Translator> getTranslators()
                                                throws AdminException

Description copied from interface: Admin

Get the translators that are available in the configuration

Specified by:

getTranslators in interface Admin

Returns:

Collection of Translator

Throws:

AdminException

getTranslator

public Translator getTranslator(String deployedName)
                         throws AdminException

Description copied from interface: Admin

Get the translator by the given the deployed name.

Specified by:

getTranslator in interface Admin

Parameters:

deployedName - - name of the deployed translator

Returns:

null if not found

Throws:

AdminException

getWorkerPoolStats

public Collection<? extends WorkerPoolStatistics> getWorkerPoolStats()
                                                              throws AdminException

Description copied from interface: Admin

Get the Worker Pool statistics in runtime engine.

Specified by:

getWorkerPoolStats in interface Admin

Returns:

Collection of WorkerPoolStatistics

Throws:

AdminException

getCacheTypes

public Collection<String> getCacheTypes()
                                 throws AdminException

Description copied from interface: Admin

Get the Caches that correspond to the specified identifier pattern

Specified by:

getCacheTypes in interface Admin

Returns:

Collection of String

Throws:

AdminException

getSessions

public Collection<? extends Session> getSessions()
                                          throws AdminException

Description copied from interface: Admin

Get all the current Sessions.

Specified by:

getSessions in interface Admin

Returns:

Collection of Session

Throws:

AdminException

getRequests

public Collection<? extends Request> getRequests()
                                          throws AdminException

Description copied from interface: Admin

Get the all Requests that are currently in process

Specified by:

getRequests in interface Admin

Returns:

Collection of Request

Throws:

AdminException

getRequestsForSession

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

Description copied from interface: Admin

Get the Requests for the given session

Specified by:

getRequestsForSession in interface Admin

Returns:

Collection of Request

Throws:

AdminException

getTemplatePropertyDefinitions

public Collection<? extends PropertyDefinition> getTemplatePropertyDefinitions(String templateName)
                                                                        throws AdminException

Description copied from interface: Admin

Get all of the available configuration Properties for the specified connector

Specified by:

getTemplatePropertyDefinitions in interface Admin

Parameters:

templateName - - Name of the connector

Returns:

Throws:

AdminException

getTranslatorPropertyDefinitions

public Collection<? extends PropertyDefinition> getTranslatorPropertyDefinitions(String translatorName)
                                                                          throws AdminException

Description copied from interface: Admin

Get all of the available configuration Properties for the specified translator

Specified by:

getTranslatorPropertyDefinitions in interface Admin

Parameters:

translatorName - - Name of the translator

Returns:

Throws:

AdminException

See Also:

getTranslatorPropertyDefinitions

getTranslatorPropertyDefinitions

public Collection<? extends PropertyDefinition> getTranslatorPropertyDefinitions(String translatorName,
                                                                                 Admin.TranlatorPropertyType type)
                                                                          throws AdminException

Description copied from interface: Admin

Get all of the available configuration Properties for the specified translator

Specified by:

getTranslatorPropertyDefinitions in interface Admin

Parameters:

translatorName - - Name of the translator

type - - Type of property definition (import, override, extension-metadata)

Returns:

Throws:

AdminException

getTransactions

public Collection<? extends Transaction> getTransactions()
                                                  throws AdminException

Description copied from interface: Admin

Get all transaction matching the identifier.

Specified by:

getTransactions in interface Admin

Returns:

Throws:

AdminException

clearCache

public void clearCache(String cacheType)
                throws AdminException

Description copied from interface: Admin

Clear the cache or caches specified by the cacheIdentifier.

Specified by:

clearCache in interface Admin

Parameters:

cacheType - Cache Type No wild cards currently supported, must be explicit

Throws:

AdminException

clearCache

public void clearCache(String cacheType,
                       String vdbName,
                       String vdbVersion)
                throws AdminException

Description copied from interface: Admin

Clear the cache of the given VDB for provided cache type

Specified by:

clearCache in interface Admin

Parameters:

cacheType - Cache Type No wild cards currently supported, must be explicit

vdbName - - Name of the VDB

vdbVersion - - VDB version

Throws:

AdminException

getCacheStats

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

Description copied from interface: Admin

Get the Cache Statistics for the given type

Specified by:

getCacheStats in interface Admin

Parameters:

cacheType - Cache Type

Returns:

Collection of CacheStatistics

Throws:

AdminException

getEngineStats

public Collection<? extends EngineStatistics> getEngineStats()
                                                      throws AdminException

Description copied from interface: Admin

Get the Engine Statistics for the given type

Specified by:

getEngineStats in interface Admin

Returns:

Collection of EngineStatistics

Throws:

AdminException

terminateSession

public void terminateSession(String sessionId)
                      throws AdminException

Description copied from interface: Admin

Terminate the Session

Specified by:

terminateSession in interface Admin

Throws:

AdminException

cancelRequest

public void cancelRequest(String sessionId,
                          long executionId)
                   throws AdminException

Description copied from interface: Admin

Cancel Request

Specified by:

cancelRequest in interface Admin

Parameters:

sessionId - session Identifier for the request.

executionId - request Identifier

Throws:

AdminException

terminateTransaction

public void terminateTransaction(String transactionId)
                          throws AdminException

Description copied from interface: Admin

Mark the given global transaction as rollback only.

Specified by:

terminateTransaction in interface Admin

Throws:

AdminException

close

public void close()

Description copied from interface: Admin

Closes the admin connection

Specified by:

close in interface Admin

addDataRoleMapping

public void addDataRoleMapping(String vdbName,
                               String vdbVersion,
                               String dataRole,
                               String mappedRoleName)
                        throws AdminException

Description copied from interface: Admin

Assign a Role name to the Data Role in a given VDB

Specified by:

addDataRoleMapping in interface Admin

Throws:

AdminException

removeDataRoleMapping

public void removeDataRoleMapping(String vdbName,
                                  String vdbVersion,
                                  String dataRole,
                                  String mappedRoleName)
                           throws AdminException

Description copied from interface: Admin

Remove a Role name to the Data Role in a given VDB

Specified by:

removeDataRoleMapping in interface Admin

Throws:

AdminException

setAnyAuthenticatedForDataRole

public void setAnyAuthenticatedForDataRole(String vdbName,
                                           String vdbVersion,
                                           String dataRole,
                                           boolean anyAuthenticated)
                                    throws AdminException

Description copied from interface: Admin

Set the any authenticated flag on the Data Role in a given VDB

Specified by:

setAnyAuthenticatedForDataRole in interface Admin

Throws:

AdminException

createDataSource

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

Description copied from interface: Admin

Creates a JCA data source

Specified by:

createDataSource in interface Admin

Parameters:

deploymentName - - name of the source

templateName - - template of data source

properties - - properties

Throws:

AdminException

getDataSource

public Properties getDataSource(String deployedName)
                         throws AdminException

Description copied from interface: Admin

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.

Specified by:

getDataSource in interface Admin

Throws:

AdminException

deleteDataSource

public void deleteDataSource(String deployedName)
                      throws AdminException

Description copied from interface: Admin

Delete data source.

Specified by:

deleteDataSource in interface Admin

Throws:

AdminException

getDataSourceNames

public Collection<String> getDataSourceNames()
                                      throws AdminException

Description copied from interface: Admin

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

Specified by:

getDataSourceNames in interface Admin

Throws:

AdminException

getDataSourceTemplateNames

public Set<String> getDataSourceTemplateNames()
                                       throws AdminException

Description copied from interface: Admin

Get the Datasource templates available in the configuration.

Specified by:

getDataSourceTemplateNames in interface Admin

Returns:

Set of template names.

Throws:

AdminException

markDataSourceAvailable

public void markDataSourceAvailable(String jndiName)
                             throws AdminException

Description copied from interface: Admin

Tell the engine that the given source is available. Pending dynamic vdb metadata loads will be resumed.

Specified by:

markDataSourceAvailable in interface Admin

Throws:

AdminException

getSchema

public String getSchema(String vdbName,
                        String vdbVersion,
                        String modelName,
                        EnumSet<Admin.SchemaObjectType> allowedTypes,
                        String typeNamePattern)
                 throws AdminException

Description copied from interface: Admin

Retrieve the schema of the given model

Specified by:

getSchema in interface Admin

typeNamePattern - RegEx pattern to filter to names of tables, procedures that are being read. Null means no filter.

Throws:

AdminException

prettyFormat

public static String prettyFormat(String input)
                           throws TransformerException

Throws:

TransformerException

getQueryPlan

public String getQueryPlan(String sessionId,
                           long executionId)
                    throws AdminException

Description copied from interface: Admin

Get the Query Plan for the given session with provided execution id.

Specified by:

getQueryPlan in interface Admin

Returns:

Throws:

AdminException

restart

public void restart()

Description copied from interface: Admin

Restart the Server

Specified by:

restart in interface Admin

getDeployments

public List<String> getDeployments()
                            throws AdminException

Description copied from interface: Admin

Get existing deployments on in the sysem

Specified by:

getDeployments in interface Admin

Throws:

AdminException