org.teiid.adminapi.jboss
Class Admin

java.lang.Object
  org.teiid.adminapi.TeiidAdmin
      org.teiid.adminapi.jboss.Admin

All Implemented Interfaces:

java.io.Serializable, Admin

public class Admin
extends TeiidAdmin

See Also:

Serialized Form

Nested Class Summary

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

Admin.Cache

Constructor Summary

Admin(org.jboss.deployers.spi.management.ManagementView view, org.jboss.deployers.spi.management.deploy.DeploymentManager deployMgr)

Method Summary

void	addDataRoleMapping(java.lang.String vdbName, int vdbVersion, java.lang.String policyName, java.lang.String role) 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 requestId) 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	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.
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 vdbVersion) Get the VDB
java.util.Set<VDB>	getVDBs() Get the VDBs that currently deployed in the system
WorkerPoolStatistics	getWorkManagerStats(java.lang.String identifier) Get the Work Manager stats that correspond to the specified identifier pattern.
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 policyName, java.lang.String role) Assign a Role name to the Data Role in a given VDB
void	terminateSession(java.lang.String sessionId) Terminate the Session
void	terminateTransaction(java.lang.String xid) Mark the given global transaction as rollback only.

Methods inherited from class org.teiid.adminapi.TeiidAdmin

getProcesses, setRuntimeProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

Admin

public Admin(org.jboss.deployers.spi.management.ManagementView view,
             org.jboss.deployers.spi.management.deploy.DeploymentManager deployMgr)

Method Detail

close

public void close()

Description copied from interface: Admin

Closes the admin connection

getTranslators

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

Description copied from interface: Admin

Get the translators that are available in the configuration

Returns:

Collection of Translator

Throws:

AdminException

getTranslator

public Translator getTranslator(java.lang.String deployedName)
                         throws AdminException

Description copied from interface: Admin

Get the translator by the given the deployed name.

Parameters:

deployedName - - name of the deployed translator

Returns:

null if not found

Throws:

AdminException

deployVDB

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

Description copied from interface: Admin

Deploy a VDB file.

Throws:

AdminException

deleteVDB

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

Description copied from interface: Admin

Delete the VDB with the given name and version

Throws:

AdminException

getVDB

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

Description copied from interface: Admin

Get the VDB

Returns:

Throws:

AdminException

getVDBs

public java.util.Set<VDB> getVDBs()
                           throws AdminException

Description copied from interface: Admin

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

getSessions

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

Description copied from interface: Admin

Get all the current Sessions.

Returns:

Collection of Session

Throws:

AdminException

terminateSession

public void terminateSession(java.lang.String sessionId)
                      throws AdminException

Description copied from interface: Admin

Terminate the Session

Throws:

AdminException

getRequests

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

Description copied from interface: Admin

Get the all Requests that are currently in process

Returns:

Collection of Request

Throws:

AdminException

getRequestsForSession

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

Description copied from interface: Admin

Get the Requests for the given session

Returns:

Collection of Request

Throws:

AdminException

cancelRequest

public void cancelRequest(java.lang.String sessionId,
                          long requestId)
                   throws AdminException

Description copied from interface: Admin

Cancel Request

Parameters:

sessionId - session Identifier for the request.

requestId - request Identifier

Throws:

AdminException

getCacheTypes

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

Description copied from interface: Admin

Get the Caches that correspond to the specified identifier pattern

Returns:

Collection of String

Throws:

AdminException

clearCache

public void clearCache(java.lang.String cacheType)
                throws AdminException

Description copied from interface: Admin

Clear the cache or caches specified by the cacheIdentifier.

Parameters:

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

Throws:

AdminException

getTransactions

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

Description copied from interface: Admin

Get all transaction matching the identifier.

Returns:

Throws:

AdminException

terminateTransaction

public void terminateTransaction(java.lang.String xid)
                          throws AdminException

Description copied from interface: Admin

Mark the given global transaction as rollback only.

Throws:

AdminException

getWorkManagerStats

public WorkerPoolStatistics getWorkManagerStats(java.lang.String identifier)
                                         throws AdminException

Description copied from interface: Admin

Get the Work Manager stats that correspond to the specified identifier pattern.

Parameters:

identifier - - an identifier for the queues QueueWorkerPool.

Returns:

Collection of QueueWorkerPool

Throws:

AdminException

getTemplatePropertyDefinitions

public java.util.Collection<PropertyDefinition> getTemplatePropertyDefinitions(java.lang.String templateName)
                                                                        throws AdminException

Description copied from interface: Admin

Get all of the available configuration Properties for the specified connector

Parameters:

templateName - - Name of the connector

Returns:

Throws:

AdminException

changeVDBConnectionType

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

Description copied from interface: Admin

Change the VDB.ConnectionType of the VDB.

Parameters:

vdbName - Name of the VDB

vdbVersion - Version of the VDB

Throws:

AdminException

assignToModel

public 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

Description copied from interface: Admin

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

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

Throws:

AdminException

addDataRoleMapping

public void addDataRoleMapping(java.lang.String vdbName,
                               int vdbVersion,
                               java.lang.String policyName,
                               java.lang.String role)
                        throws AdminException

Description copied from interface: Admin

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

Throws:

AdminException

removeDataRoleMapping

public void removeDataRoleMapping(java.lang.String vdbName,
                                  int vdbVersion,
                                  java.lang.String policyName,
                                  java.lang.String role)
                           throws AdminException

Description copied from interface: Admin

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

Throws:

AdminException

mergeVDBs

public void mergeVDBs(java.lang.String sourceVDBName,
                      int sourceVDBVersion,
                      java.lang.String targetVDBName,
                      int targetVDBVersion)
               throws AdminException

Description copied from interface: Admin

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.

Throws:

AdminException

createDataSource

public void createDataSource(java.lang.String deploymentName,
                             java.lang.String templateName,
                             java.util.Properties properties)
                      throws AdminException

Description copied from interface: Admin

Creates a JCA data source

Parameters:

deploymentName - - name of the source

templateName - - template of data source

properties - - properties

Throws:

AdminException

deleteDataSource

public void deleteDataSource(java.lang.String deployedName)
                      throws AdminException

Description copied from interface: Admin

Delete data source.

Throws:

AdminException

getDataSourceNames

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

Description copied from interface: Admin

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

Throws:

AdminException

getDataSourceTemplateNames

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

Description copied from interface: Admin

Get the Datasource templates available in the configuration.

Returns:

Set of template names.

Throws:

AdminException