com.metamatrix.admin.server
Class ServerAdminImpl

java.lang.Object
  com.metamatrix.admin.server.ServerAdminImpl

All Implemented Interfaces:

ServerAdmin, ServerConfigAdmin, ServerMonitoringAdmin, ServerRuntimeStateAdmin, ServerSecurityAdmin, Admin, ConfigurationAdmin, MonitoringAdmin, RuntimeStateAdmin, SecurityAdmin

public class ServerAdminImpl
extends java.lang.Object
implements ServerAdmin

Since:

4.3

Field Summary

protected static int

SERVICE_WAIT_INTERVAL How often to poll for services starting/stopping

Constructor Summary

ServerAdminImpl(ClusteredRegistryState registry, HostManagement hostManagement)
xtor

Method Summary

void	addAuthorizationProvider(java.lang.String domainprovidername, java.lang.String providertypename, java.util.Properties properties)
void	addConnectorArchive(byte[] archiveContents, AdminOptions options) Add Connector Type and all the required extension modules required by the this connector type into the system from the given file byte stream which is encoded inthe Connector Archive format.
ConnectorBinding	addConnectorBinding(java.lang.String name, char[] xmlFile, AdminOptions options) Import a ConnectorBinding into the Configuration.
ConnectorBinding	addConnectorBinding(java.lang.String connectorBindingIdentifier, java.lang.String connectorTypeIdentifier, java.util.Properties props, AdminOptions options) Deploy a ConnectorBinding to Configuration
void	addConnectorType(java.lang.String name, char[] cdkFile) Add Connector Type, will import Connector Type from a file
void	addExtensionModule(java.lang.String type, java.lang.String sourceName, byte[] source, java.lang.String description) Adds an ExtensionModule to the end of the list of modules.
void	addHost(java.lang.String hostName, java.util.Properties properties) Add a Host with Properties to MetaMatrix System
void	addProcess(java.lang.String processIdentifier, java.util.Properties properties) Add Process to specified host in the processIdentifier
void	addUDF(byte[] modelFileContents, java.lang.String classpath) Add User Defined Function model to the system.
VDB	addVDB(java.lang.String name, byte[] vdbFile, AdminOptions options) Import a VDB file.
void	assignBindingsToModel(java.lang.String[] connectorBindingNames, java.lang.String vdbName, java.lang.String vdbVersion, java.lang.String modelName) Assign ConnectorBindings to a VDB's Model.
void	assignBindingToModel(java.lang.String connectorBindingName, java.lang.String vdbName, java.lang.String vdbVersion, java.lang.String modelName) Assign a ConnectorBinding to a VDB's Model
void	assignRoleToGroup(java.lang.String roleIdentifier, java.lang.String groupIdentifier) Assign to the given Group the given Administrative Role.
boolean	authenticateUser(java.lang.String username, char[] credentials, java.io.Serializable trustePayload, java.lang.String applicationName) Authenticate a user with the specified user name and credentials for use with the specified application.
void	bounceSystem(boolean waitUntilDone) Stop and restart the entire system.
void	cancelRequest(java.lang.String identifier) Cancel Request
void	cancelSourceRequest(java.lang.String identifier) Cancel Source Request
void	changeVDBStatus(java.lang.String name, java.lang.String version, int status) Change the status of a Deployed VDB
void	clearCache(java.lang.String cacheIdentifier) Clear the cache or caches specified by the cacheIdentifier.
void	close() Do nothing: this is implemented in ServerAdminClientInterceptor on the client-side.
void	deassignBindingFromModel(java.lang.String connectorBindingName, java.lang.String vdbName, java.lang.String vdbVersion, java.lang.String modelName) Deassign a ConnectorBinding from a VDB's Model
void	deassignBindingsFromModel(java.lang.String[] connectorBindingNames, java.lang.String vdbName, java.lang.String vdbVersion, java.lang.String modelName) Deassign ConnectorBindings from a VDB's Model.
void	deleteConnectorBinding(java.lang.String connectorBindingIdentifier) Delete the ConnectorBinding from the Configuration
void	deleteConnectorType(java.lang.String name) Delete Connector Type from Next Configuration
void	deleteExtensionModule(java.lang.String sourceName) Deletes an ExtensionModule from the list of modules.
void	deleteHost(java.lang.String identifier) Delete Host in Configuration
void	deleteProcess(java.lang.String identifier) Delete Process in Configuration
void	deleteUDF() Delete the User Defined Function model.
void	deleteVDB(java.lang.String vdbName, java.lang.String version) Delete the VDB with the given name and version
void	disableHost(java.lang.String identifier) Disable Host in Configuration
void	disableProcess(java.lang.String identifier) Disable Process in Configuration
void	enableHost(java.lang.String identifier) Enable Host in Configuration
void	enableProcess(java.lang.String identifier) Enable Process in Configuration
char[]	exportConfiguration() Export Configuration to character Array in XML format
byte[]	exportConnectorArchive(java.lang.String connectorTypeIdentifier) Export Connector Archive, which is bundled connector type with its xml properties file and all the extension modules required by the this connector type
char[]	exportConnectorBinding(java.lang.String connectorBindingIdentifier) Export a ConnectorBinding to character Array in XML format
char[]	exportConnectorType(java.lang.String connectorTypeIdentifier) Export Connector Type to character array
char[]	exportDataRoles(java.lang.String vdbName, java.lang.String vdbVersion) Export the data roles defined for the given vdb from the current system
byte[]	exportExtensionModule(java.lang.String sourceName) Export an ExtensionModule to byte array
byte[]	exportLogs() Export the server logs to a byte[].
byte[]	exportVDB(java.lang.String name, java.lang.String version) Export VDB to byte array
void	extensionModuleModified(java.lang.String name) Indicates that an extension module has changed
ScriptsContainer	generateMaterializationScripts(java.lang.String vdbName, java.lang.String vdbVersion, java.lang.String metamatrixUserName, java.lang.String metamatrixUserPwd, java.lang.String materializationUserName, java.lang.String materializationUserPwd) Generate the scripts necessary for loading or refreshing a VDB with Materialized Views.
protected AuthorizationServiceInterface	getAuthorizationServiceProxy()
java.util.Properties	getBootstrapProperties() Return the bootstrap properties used to configure initialize the system.
java.util.Collection	getCaches(java.lang.String identifier) Get the Caches that correspond to the specified identifier pattern
byte[]	getClusterKey() Retrieves the cluster key that authenticates and secures intra-cluster communication.
protected ConfigurationServiceInterface	getConfigurationServiceProxy()
java.util.Collection	getConnectionPoolStats(java.lang.String identifier) Get the Connection Pool Stats that correspond to the specified identifier pattern.
java.util.Collection	getConnectorBindings(java.lang.String identifier) Get the Connector Bindings that correspond to the specified identifier pattern.
java.util.Collection	getConnectorBindingsInVDB(java.lang.String identifier)
java.util.Collection<ConnectorBinding>	getConnectorBindingsInVDB(java.lang.String vdbName, java.lang.String vdbVersion) Get all the Connector Bindings for the given VDB identifier pattern
java.util.Collection<PropertyDefinition>	getConnectorTypePropertyDefinitions(java.lang.String connectorTypeIdentifier) Get all of the available Configuration Properties for the specified AdminObject, and details about them.
java.util.Collection	getConnectorTypes(java.lang.String identifier) Get the Connector Types that correspond to the specified identifier pattern.
java.util.List<java.lang.String>	getDomainNames() Returns the active authorization provider domain names, in authentication order.
java.util.Collection	getDQPs(java.lang.String identifier) Get the DQPs that correspond to the specified identifer pattern.
java.util.Collection	getExtensionModules(java.lang.String identifier) Get the Extension Modules that correspond to the specified identifier pattern
protected ExtensionModuleManager	getExtensionSourceManager()
java.util.Collection	getGroups(java.lang.String groupIdentifier) Get the group denoted by the given groupIdentifier.
java.util.Collection<Group>	getGroupsForDomain(java.lang.String domainName) Return the Groups for a given domain.
java.util.Collection	getGroupsForUser(java.lang.String userIdentifier) Get the group memberships for the given user.
java.util.Collection	getHosts(java.lang.String identifier) Get the hosts that correspond to the specified identifier pattern.
LogConfiguration	getLogConfiguration() Get the LogConfiguration
protected MembershipServiceInterface	getMembershipServiceProxy()
java.util.Collection	getProcesses(java.lang.String identifier) Get the processes that correspond to the specified identifier pattern.
java.util.Collection	getPropertyDefinitions(java.lang.String identifier, java.lang.String className)
protected QueryServiceInterface	getQueryServiceProxy()
java.util.Collection	getQueueWorkerPools(java.lang.String identifier) Get the Queue Worker Pools that correspond to the specified identifier pattern.
java.util.Collection	getRequests(java.lang.String identifier) Get the Requests that correspond to the specified identifier pattern
java.util.Collection	getResources(java.lang.String identifier) Get the Resources that correspond to the specified identifer pattern.
java.util.Collection	getRolesForGroup(java.lang.String groupIdentifier) Get the Collection of administrative role names possessed by the given group, if any.
java.util.Collection	getRolesForUser(java.lang.String userIdentifier) Get the Collection of administrative role names possessed by the given user, if any.
protected RuntimeStateAdminAPIHelper	getRuntimeStateAdminAPIHelper()
java.util.Collection	getServices(java.lang.String identifier) Get the Services that correspond to the specified identifer pattern.
java.util.Collection	getSessions(java.lang.String identifier) Get the Sessions that correspond to the specified identifier pattern
protected SessionServiceInterface	getSessionServiceProxy()
java.util.Collection	getSourceRequests(java.lang.String identifier) Get the Source Request that correspond to the specified identifier pattern
SystemObject	getSystem()
java.util.Collection<Transaction>	getTransactions() Get all transaction matching the identifier.
java.util.Collection	getVDBs(java.lang.String identifier) Get the VDBs that correspond to the specified identifier pattern.
void	importConfiguration(char[] fileData) Import the Configuration from a character array in XML format.
java.lang.String	importDataRoles(java.lang.String vdbName, java.lang.String vdbVersion, char[] data, AdminOptions options) Import the data Roles for given vdb and version into the connected server
void	removeRoleFromGroup(java.lang.String roleIdentifier, java.lang.String grouplIdentifier) Remove an administrative role from the given Group.
void	restart() Restart System
void	setConnectorBindingProperty(java.lang.String deployedName, java.lang.String propertyName, java.lang.String propertyValue) Set/update the property for the Connector Binding identified by the given deployed name.
void	setLogConfiguration(LogConfiguration config) Set the LogConfiguration in the MetaMatrix Server
void	setLogListener(EmbeddedLogger listener) Set the log listener to install into MM Query.
void	setProcessProperty(java.lang.String processIdentifier, java.lang.String propertyName, java.lang.String propertyValue) Set a process level property.
void	setProperty(java.lang.String identifier, java.lang.String className, java.lang.String propertyName, java.lang.String propertyValue)
void	setSystemProperty(java.lang.String property, java.lang.String value)
void	shutdown(int millisToWait) Stop the MM Query.
void	startConnectorBinding(java.lang.String connectorBindingIdentifier) Start Connector Binding
void	startHost(java.lang.String hostName, boolean waitUntilDone) Start the Host for this cluster
void	startProcess(java.lang.String identifier, boolean waitUntilDone) Start a Process in the system.
void	stopConnectorBinding(java.lang.String connectorBindingIdentifier, boolean stopNow) Stop Connector Binding
void	stopHost(java.lang.String hostName, boolean stopNow, boolean waitUntilDone) Stop the Host for this cluster
void	stopProcess(java.lang.String identifier, boolean stopNow, boolean waitUntilDone) Stop Process running in the system.
void	stopSystem() Stop the entire system.
void	synchronizeSystem(boolean waitUntilDone) Synchronize the entire system.
void	terminateSession(java.lang.String identifier) Terminate the Session
void	terminateTransaction(java.lang.String transactionId, java.lang.String sessionId) Mark the given transaction as rollback only.
void	terminateTransaction(javax.transaction.xa.Xid transactionId) Mark the given global transaction as rollback only.
void	updateProperties(java.lang.String identifier, java.lang.String className, java.util.Properties properties)
void	updateSystemProperties(java.util.Properties properties)
protected void	waitForServicesToStart(java.util.Collection expectedServiceNames)
protected void	waitForServicesToStop(java.util.Collection expectedServiceNames)

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_WAIT_INTERVAL

protected static final int SERVICE_WAIT_INTERVAL

How often to poll for services starting/stopping

See Also:

Constant Field Values

Constructor Detail

ServerAdminImpl

public ServerAdminImpl(ClusteredRegistryState registry,
                       HostManagement hostManagement)

xtor

Since:

4.3

Method Detail

addAuthorizationProvider

public void addAuthorizationProvider(java.lang.String domainprovidername,
                                     java.lang.String providertypename,
                                     java.util.Properties properties)
                              throws AdminException

Specified by:

addAuthorizationProvider in interface ServerConfigAdmin

Parameters:

domainprovidername - is the name to be assigned to the newly created AuthenticationProvider

providertypename - is the type of provider to create. There are 3 installed provider types and they are:

• File Membership Domain Provider
• LDAP Membership Domain Provider
• Custom Membership Domain Provider

properties - are the settings specified by the providertype to be used

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

org.teiid.adminapi.ConfigurationAdmin#addAuthorizationProvider(java.lang.String, java.lang.String, java.util.Properties)

getCaches

public java.util.Collection getCaches(java.lang.String identifier)
                               throws AdminException

Description copied from interface: MonitoringAdmin

Get the Caches that correspond to the specified identifier pattern

Specified by:

getCaches in interface MonitoringAdmin

Parameters:

identifier - - an identifier for the cache in Cache

• "*" - for all different caches in the system
• "name*" - for all the caches that begin with given name
• "name" - for a single cache in the system

Returns:

Collection of Cache

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

MonitoringAdmin.getCaches(java.lang.String)

getConnectorBindings

public java.util.Collection getConnectorBindings(java.lang.String identifier)
                                          throws AdminException

Description copied from interface: MonitoringAdmin

Get the Connector Bindings that correspond to the specified identifier pattern.

Specified by:

getConnectorBindings in interface MonitoringAdmin

Parameters:

identifier - the unique identifier pattern of ConnectorBinding

• "*" - for all connector bindings in the system
• "name*" - for all connector bindings that begin with given name
• "name" - for single connector binding by the given name

Returns:

Collection of ConnectorBinding

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

MonitoringAdmin.getConnectorBindings(java.lang.String)

getConnectorBindingsInVDB

public java.util.Collection getConnectorBindingsInVDB(java.lang.String identifier)
                                               throws AdminException

Throws:

AdminException

Since:

4.3

See Also:

org.teiid.adminapi.MonitoringAdmin#getConnectorBindingsInVDB(java.lang.String)

getConnectorTypes

public java.util.Collection getConnectorTypes(java.lang.String identifier)
                                       throws AdminException

Description copied from interface: MonitoringAdmin

Get the Connector Types that correspond to the specified identifier pattern.

Specified by:

getConnectorTypes in interface MonitoringAdmin

Parameters:

identifier - the unique identifier for for a ConnectorType

• "*" - for all connector types in the system
• "name*" - for all the connector types that begin with given name
• "name" - for the single connector type identified by name

Returns:

Collection of ConnectorType

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

MonitoringAdmin.getConnectorTypes(java.lang.String)

getDQPs

public java.util.Collection getDQPs(java.lang.String identifier)
                             throws AdminException

Description copied from interface: ServerMonitoringAdmin

Get the DQPs that correspond to the specified identifer pattern.

Specified by:

getDQPs in interface ServerMonitoringAdmin

Parameters:

identifier - the unique identifier for for a DQP in the system or "WILDCARD" if all Resources are desired.

Returns:

Collection of DQP

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerMonitoringAdmin.getDQPs(java.lang.String)

getExtensionModules

public java.util.Collection getExtensionModules(java.lang.String identifier)
                                         throws AdminException

Description copied from interface: MonitoringAdmin

Get the Extension Modules that correspond to the specified identifier pattern

Specified by:

getExtensionModules in interface MonitoringAdmin

Parameters:

identifier - - the unique identifier for ExtensionModule

• "*" - for all extension modules in the system
• "name*" - for all the extension modules in that begin with given name
• "name" - for a single extension module identified by given name

Returns:

Collection of ExtensionModule

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

MonitoringAdmin.getExtensionModules(java.lang.String)

getHosts

public java.util.Collection getHosts(java.lang.String identifier)
                              throws AdminException

Description copied from interface: ServerMonitoringAdmin

Get the hosts that correspond to the specified identifier pattern.

Specified by:

getHosts in interface ServerMonitoringAdmin

Parameters:

identifier - the unique identifier for for a Host in the system or "WILDCARD" if all hosts are desired.

Returns:

Collection of Host

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerMonitoringAdmin.getHosts(java.lang.String)

getProcesses

public java.util.Collection getProcesses(java.lang.String identifier)
                                  throws AdminException

Description copied from interface: ServerMonitoringAdmin

Get the processes that correspond to the specified identifier pattern.

Specified by:

getProcesses in interface ServerMonitoringAdmin

Specified by:

getProcesses in interface MonitoringAdmin

Parameters:

identifier - the unique identifier for for a ProcessObject in the system or "WILDCARD" if all Processes are desired.

Returns:

Collection of ProcessObject

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerMonitoringAdmin.getProcesses(java.lang.String)

getQueueWorkerPools

public java.util.Collection getQueueWorkerPools(java.lang.String identifier)
                                         throws AdminException

Description copied from interface: MonitoringAdmin

Get the Queue Worker Pools that correspond to the specified identifier pattern.

Specified by:

getQueueWorkerPools in interface MonitoringAdmin

Parameters:

identifier - - an identfier for the queues QueueWorkerPool

• "*" - for all Queue workers in the system
• "name*" - for all the Queue workers in that begin with given name
• "name" - for a single queue in the system

for example, In MM Query - "dqp" will return the Stats for MM Query Worker Pool. Also any Connector Binding name will return the stats for that connector binding.

Returns:

Collection of QueueWorkerPool

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

MonitoringAdmin.getQueueWorkerPools(java.lang.String)

getRequests

public java.util.Collection getRequests(java.lang.String identifier)
                                 throws AdminException

Description copied from interface: MonitoringAdmin

Get the Requests that correspond to the specified identifier pattern

Specified by:

getRequests in interface MonitoringAdmin

Parameters:

identifier - - An Identifier for Request

• "*" - for all current in process requests of the system
• "number* or number<AdminObject.DELIMITER_CHAR>*" - for all the sessions that begin with given number, or all the requests for particular session etc.
• "number<AdminObject.DELIMITER_CHAR>number" - for a single request in the system

Returns:

Collection of Request

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

MonitoringAdmin.getRequests(java.lang.String)

getResources

public java.util.Collection getResources(java.lang.String identifier)
                                  throws AdminException

Description copied from interface: ServerMonitoringAdmin

Get the Resources that correspond to the specified identifer pattern.

Specified by:

getResources in interface ServerMonitoringAdmin

Parameters:

identifier - the unique resourceIdentifier for for a Resource in the system or "WILDCARD" if all Resources are desired.

Returns:

Collection of Resource

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerMonitoringAdmin.getResources(java.lang.String)

getSessions

public java.util.Collection getSessions(java.lang.String identifier)
                                 throws AdminException

Description copied from interface: MonitoringAdmin

Get the Sessions that correspond to the specified identifier pattern

Specified by:

getSessions in interface MonitoringAdmin

Parameters:

identifier - - an unique identifier for Session

• "*" - for all current sessions of the system
• "number*" - for all the sessions that begin with given number
• "number" - for a single current session in the system

Returns:

Collection of Session

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

MonitoringAdmin.getSessions(java.lang.String)

getSourceRequests

public java.util.Collection getSourceRequests(java.lang.String identifier)
                                       throws AdminException

Description copied from interface: MonitoringAdmin

Get the Source Request that correspond to the specified identifier pattern

Specified by:

getSourceRequests in interface MonitoringAdmin

Parameters:

identifier - An Identifier for Request

• "*" - for all current in process requests of the system
• "number* or number<AdminObject.DELIMITER_CHAR>* or number.number.*" - for all the sessions that begin with given number, or all the requests for particular session etc.
• "number<AdminObject.DELIMITER_CHAR>number<AdminObject.DELIMITER_CHAR>number" - for a single source request in the system

Returns:

Collection of Request

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

MonitoringAdmin.getSourceRequests(java.lang.String)

getSystem

public SystemObject getSystem()
                       throws AdminException

Throws:

AdminException

Since:

4.3

See Also:

com.metamatrix.admin.api.server.ServerMonitoringAdmin#getSystem()

getVDBs

public java.util.Collection getVDBs(java.lang.String identifier)
                             throws AdminException

Description copied from interface: MonitoringAdmin

Get the VDBs that correspond to the specified identifier pattern.

Specified by:

getVDBs in interface MonitoringAdmin

Parameters:

identifier - the unique identifier for for a VDB in the system

• "*" - for all VDBs in the system
• "name" or "name*" - for all the VDBs that begin with given name
• "name<AdminObject.DELIMITER_CHAR>version" - for single VDB

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 - if there's a system error.

Since:

4.3

See Also:

MonitoringAdmin.getVDBs(java.lang.String)

getPropertyDefinitions

public java.util.Collection getPropertyDefinitions(java.lang.String identifier,
                                                   java.lang.String className)
                                            throws AdminException

Throws:

AdminException

Since:

4.3

See Also:

org.teiid.adminapi.MonitoringAdmin#getPropertyDefinitions(java.lang.String, java.lang.String)

exportLogs

public byte[] exportLogs()
                  throws AdminException

Description copied from interface: ServerMonitoringAdmin

Export the server logs to a byte[]. The bytes contain the contents of a .zip file containing the logs.

Specified by:

exportLogs in interface ServerMonitoringAdmin

Returns:

the logs, as a byte[].

Throws:

AdminException

Since:

4.3

See Also:

ServerMonitoringAdmin.exportLogs()

addConnectorBinding

public ConnectorBinding addConnectorBinding(java.lang.String connectorBindingIdentifier,
                                            java.lang.String connectorTypeIdentifier,
                                            java.util.Properties props,
                                            AdminOptions options)
                                     throws AdminException

Description copied from interface: ConfigurationAdmin

Deploy a ConnectorBinding to Configuration

Specified by:

addConnectorBinding in interface ConfigurationAdmin

Parameters:

connectorBindingIdentifier - is the Connector Binding name that will be added to Configuration

connectorTypeIdentifier - Name of the Connector Type

props - Name & Value pair need to deploy the Connector Binding

options - The perferred options when executing this method. There are choices about what to do when a connector binding with the given identifier already exists in the system. See the interface AdminOptions.OnConflict for details.

Another option is to ignore a binding connection password decrypt error, when adding a connector binding whose password was encrypted with a different keystore, so that the new password property can be set after the connector binding has been added.

Returns:

the ConnectorBinding representing the current property values and runtime state. Note that if this is a system with multiple Processes, this method may actually create multiple deployed Connector Bindings (one for each process). This method will return one of them, arbitrarily.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.addConnectorBinding(java.lang.String, java.lang.String, java.util.Properties, AdminOptions)

addConnectorBinding

public ConnectorBinding addConnectorBinding(java.lang.String name,
                                            char[] xmlFile,
                                            AdminOptions options)
                                     throws AdminException

Description copied from interface: ConfigurationAdmin

Import a ConnectorBinding into the Configuration.

Specified by:

addConnectorBinding in interface ConfigurationAdmin

Parameters:

name - is the Connector Binding name that will be added to Configuration

xmlFile - contents of XML file that will be sent to the server.

options - The perferred options when executing this method. There are choices about what to do when a connector binding with the given identifier already exists in the system. See the interface AdminOptions.OnConflict for details.

Another option is to ignore a binding connection password decrypt error, when adding a connector binding whose password was encrypted with a different keystore, so that the new password property can be set after the connector binding has been added.

Returns:

the ConnectorBinding representing the current property values and runtime state. Note that if this is a system with multiple Processes, this method may actually create multiple deployed Connector Bindings (one for each process). This method will return one of them, arbitrarily.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.addConnectorBinding(java.lang.String, char[], AdminOptions)

addConnectorType

public void addConnectorType(java.lang.String name,
                             char[] cdkFile)
                      throws AdminException

Description copied from interface: ConfigurationAdmin

Add Connector Type, will import Connector Type from a file

Specified by:

addConnectorType in interface ConfigurationAdmin

Parameters:

name - of the Connector Type to add

cdkFile - contents of File from Client

Throws:

MetaMatrixProcessingException

MetaMatrixComponentException

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.addConnectorType(java.lang.String, char[])

addConnectorArchive

public void addConnectorArchive(byte[] archiveContents,
                                AdminOptions options)
                         throws AdminException

Description copied from interface: ConfigurationAdmin

Add Connector Type and all the required extension modules required by the this connector type into the system from the given file byte stream which is encoded inthe Connector Archive format.

Specified by:

addConnectorArchive in interface ConfigurationAdmin

Parameters:

archiveContents - contents of File

options - resolution option in case of conflict in the connector type

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.addConnectorArchive(byte[], org.teiid.adminapi.AdminOptions)

addExtensionModule

public void addExtensionModule(java.lang.String type,
                               java.lang.String sourceName,
                               byte[] source,
                               java.lang.String description)
                        throws AdminException

Description copied from interface: ConfigurationAdmin

Adds an ExtensionModule to the end of the list of modules.
All caches (of Class objects) are cleared.

Specified by:

addExtensionModule in interface ConfigurationAdmin

Parameters:

type - one of the known types of extension file

sourceName - name (e.g. filename) of extension module

source - actual contents of module

description - (optional) description of the extension module - may be null

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

com.metamatrix.admin.api.server.ServerConfigAdmin#addExtensionModule(java.lang.String, java.lang.String, byte[], java.lang.String, boolean)

addHost

public void addHost(java.lang.String hostName,
                    java.util.Properties properties)
             throws AdminException

Description copied from interface: ServerConfigAdmin

Add a Host with Properties to MetaMatrix System

Specified by:

addHost in interface ServerConfigAdmin

Parameters:

hostName - Name of Host to add

properties - name,value

Throws:

MetaMatrixComponentException

MetaMatrixProcessingException

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerConfigAdmin.addHost(java.lang.String, java.util.Properties)

addProcess

public void addProcess(java.lang.String processIdentifier,
                       java.util.Properties properties)
                throws AdminException

Description copied from interface: ServerConfigAdmin

Add Process to specified host in the processIdentifier

Specified by:

addProcess in interface ServerConfigAdmin

Parameters:

processIdentifier - Process Identifiers is Host Name.Process Name e.g. "myhost.MetaMatrixProcess"

Throws:

MetaMatrixComponentException

MetaMatrixProcessingException

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerConfigAdmin.addProcess(java.lang.String, java.util.Properties)

addVDB

public VDB addVDB(java.lang.String name,
                  byte[] vdbFile,
                  AdminOptions options)
           throws AdminException

Description copied from interface: ConfigurationAdmin

Import a VDB file.
A VDB file with internal definitions. Thise is the default VDB export configuration begining with MetaMatrix version 4.3.

Specified by:

addVDB in interface ConfigurationAdmin

Parameters:

name - VDB Name

vdbFile - byte array of the VDB Archive

options - The perferred options when executing this method. There are choices about what to do when a connector binding with the given identifier already exists in the system.

Returns:

the VDB representing the current property values and runtime state.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

com.metamatrix.admin.api.server.ServerConfigAdmin#addVDB(java.lang.String, java.lang.String, byte[], char[])

changeVDBStatus

public void changeVDBStatus(java.lang.String name,
                            java.lang.String version,
                            int status)
                     throws AdminException

Description copied from interface: RuntimeStateAdmin

Change the status of a Deployed VDB

Specified by:

changeVDBStatus in interface RuntimeStateAdmin

Parameters:

name - Name of the Virtual Database

version - Version of the Virtual Database

status - Active, InActive, Delete

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

com.metamatrix.admin.api.server.ServerConfigAdmin#changeVDBStatus(java.lang.String, java.lang.String, int)

disableHost

public void disableHost(java.lang.String identifier)
                 throws AdminException

Description copied from interface: ServerConfigAdmin

Disable Host in Configuration

Specified by:

disableHost in interface ServerConfigAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerConfigAdmin.disableHost(java.lang.String)

disableProcess

public void disableProcess(java.lang.String identifier)
                    throws AdminException

Description copied from interface: ServerConfigAdmin

Disable Process in Configuration

Specified by:

disableProcess in interface ServerConfigAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerConfigAdmin.disableProcess(java.lang.String)

enableHost

public void enableHost(java.lang.String identifier)
                throws AdminException

Description copied from interface: ServerConfigAdmin

Enable Host in Configuration

Specified by:

enableHost in interface ServerConfigAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerConfigAdmin.enableHost(java.lang.String)

enableProcess

public void enableProcess(java.lang.String identifier)
                   throws AdminException

Description copied from interface: ServerConfigAdmin

Enable Process in Configuration

Specified by:

enableProcess in interface ServerConfigAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerConfigAdmin.enableProcess(java.lang.String)

getLogConfiguration

public LogConfiguration getLogConfiguration()
                                     throws AdminException

Description copied from interface: ConfigurationAdmin

Get the LogConfiguration

Specified by:

getLogConfiguration in interface ConfigurationAdmin

Returns:

LogConfiguration object

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.getLogConfiguration()

setLogConfiguration

public void setLogConfiguration(LogConfiguration config)
                         throws AdminException

Description copied from interface: ConfigurationAdmin

Set the LogConfiguration in the MetaMatrix Server

Specified by:

setLogConfiguration in interface ConfigurationAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.setLogConfiguration(org.teiid.adminapi.LogConfiguration)

setSystemProperty

public void setSystemProperty(java.lang.String property,
                              java.lang.String value)
                       throws AdminException

Throws:

AdminException

Since:

4.3

See Also:

com.metamatrix.admin.api.server.ServerConfigAdmin#setSystemProperty(java.lang.String, java.lang.String)

updateSystemProperties

public void updateSystemProperties(java.util.Properties properties)
                            throws AdminException

Throws:

AdminException

Since:

4.3

See Also:

org.teiid.adminapi.ConfigurationAdmin#updateSystemProperties(java.util.Properties)

cancelRequest

public void cancelRequest(java.lang.String identifier)
                   throws AdminException

Description copied from interface: RuntimeStateAdmin

Cancel Request

Specified by:

cancelRequest in interface RuntimeStateAdmin

Parameters:

identifier - The request identifier defined by Request No wild cards currently supported, must be explicit

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

RuntimeStateAdmin.cancelRequest(java.lang.String)

cancelSourceRequest

public void cancelSourceRequest(java.lang.String identifier)
                         throws AdminException

Description copied from interface: RuntimeStateAdmin

Cancel Source Request

Specified by:

cancelSourceRequest in interface RuntimeStateAdmin

Parameters:

identifier - The request identifier defined by Request No wild cards currently supported, must be explicit

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

RuntimeStateAdmin.cancelSourceRequest(java.lang.String)

startConnectorBinding

public void startConnectorBinding(java.lang.String connectorBindingIdentifier)
                           throws AdminException

Description copied from interface: RuntimeStateAdmin

Start Connector Binding

Specified by:

startConnectorBinding in interface RuntimeStateAdmin

Parameters:

connectorBindingIdentifier - identifier for ConnectorBinding

• "*" - for all connector bindings in the system
• "name*" - for all connector bindings that begin with given name
• "name" - for single connector binding by the given name

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

RuntimeStateAdmin.startConnectorBinding(java.lang.String)

startHost

public void startHost(java.lang.String hostName,
                      boolean waitUntilDone)
               throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Start the Host for this cluster

Specified by:

startHost in interface ServerRuntimeStateAdmin

Parameters:

hostName - the unique identifier for for a Host in the system.

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.startHost(java.lang.String, boolean)

stopConnectorBinding

public void stopConnectorBinding(java.lang.String connectorBindingIdentifier,
                                 boolean stopNow)
                          throws AdminException

Description copied from interface: RuntimeStateAdmin

Stop Connector Binding

Specified by:

stopConnectorBinding in interface RuntimeStateAdmin

Parameters:

connectorBindingIdentifier - identifier for ConnectorBinding

• "*" - for all connector bindings in the system
• "name*" - for all connector bindings that begin with given name
• "name" - for single connector binding by the given name

stopNow - If true, stop the process forcefully. If false, wait until any pending work is done.

Throws:

AdminException - - if there's a system error.

Since:

4.3

See Also:

com.metamatrix.admin.api.RuntimeStateAdmin#stopConnectorBinding(java.lang.String, boolean)

stopHost

public void stopHost(java.lang.String hostName,
                     boolean stopNow,
                     boolean waitUntilDone)
              throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Stop the Host for this cluster

Specified by:

stopHost in interface ServerRuntimeStateAdmin

Parameters:

hostName - the unique identifier for for a Host in the system.

stopNow - If true, stop the host forcefully. If false, wait until any pending work is done.

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

com.metamatrix.admin.api.RuntimeStateAdmin#stopHost(java.lang.String, boolean, boolean)

stopProcess

public void stopProcess(java.lang.String identifier,
                        boolean stopNow,
                        boolean waitUntilDone)
                 throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Stop Process running in the system.

Specified by:

stopProcess in interface ServerRuntimeStateAdmin

Parameters:

identifier - the unique identifier for for a ProcessObject in the system.

stopNow - a boolean value indicating whether to halt the process immediately or let it finish processing first.

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

com.metamatrix.admin.api.RuntimeStateAdmin#stopProcess(java.lang.String, boolean, boolean)

startProcess

public void startProcess(java.lang.String identifier,
                         boolean waitUntilDone)
                  throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Start a Process in the system.

Specified by:

startProcess in interface ServerRuntimeStateAdmin

Parameters:

identifier - the unique identifier for for a ProcessObject in the system.

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.startProcess(java.lang.String, boolean)

stopSystem

public void stopSystem()
                throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Stop the entire system.

Specified by:

stopSystem in interface ServerRuntimeStateAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.stopSystem()

bounceSystem

public void bounceSystem(boolean waitUntilDone)
                  throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Stop and restart the entire system.

Specified by:

bounceSystem in interface ServerRuntimeStateAdmin

Parameters:

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished. NOTE: If waitUntilDone is true, this method will wait until the server is able to connect to, but it may not wait until non-essential services are available.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.bounceSystem(boolean)

synchronizeSystem

public void synchronizeSystem(boolean waitUntilDone)
                       throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Synchronize the entire system. Synchronization will attempt to make the runtime state match the configuration.

Specified by:

synchronizeSystem in interface ServerRuntimeStateAdmin

Parameters:

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.synchronizeSystem(boolean)

terminateSession

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

Description copied from interface: RuntimeStateAdmin

Terminate the Session

Specified by:

terminateSession in interface RuntimeStateAdmin

Parameters:

identifier - Session Identifier Session. No wild cards currently supported, must be explicit

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

RuntimeStateAdmin.terminateSession(java.lang.String)

clearCache

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

Description copied from interface: RuntimeStateAdmin

Clear the cache or caches specified by the cacheIdentifier.

Specified by:

clearCache in interface RuntimeStateAdmin

Parameters:

cacheIdentifier - Cache name identifier Cache. No wild cards currently supported, must be explicit

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

RuntimeStateAdmin.clearCache(java.lang.String)

setProperty

public void setProperty(java.lang.String identifier,
                        java.lang.String className,
                        java.lang.String propertyName,
                        java.lang.String propertyValue)
                 throws AdminException

Throws:

AdminException

Since:

4.3

See Also:

com.metamatrix.admin.api.server.ServerConfigAdmin#setProperty(java.lang.String, java.lang.String, java.lang.String)

updateProperties

public void updateProperties(java.lang.String identifier,
                             java.lang.String className,
                             java.util.Properties properties)
                      throws AdminException

Throws:

AdminException

Since:

4.3

See Also:

org.teiid.adminapi.ConfigurationAdmin#updateProperties(java.lang.String, java.lang.String, java.util.Properties)

deleteConnectorBinding

public void deleteConnectorBinding(java.lang.String connectorBindingIdentifier)
                            throws AdminException

Description copied from interface: ConfigurationAdmin

Delete the ConnectorBinding from the Configuration

Specified by:

deleteConnectorBinding in interface ConfigurationAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.deleteConnectorBinding(java.lang.String)

deleteConnectorType

public void deleteConnectorType(java.lang.String name)
                         throws AdminException

Description copied from interface: ConfigurationAdmin

Delete Connector Type from Next Configuration

Specified by:

deleteConnectorType in interface ConfigurationAdmin

Parameters:

name - String name of the Connector Type to delete

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.deleteConnectorType(java.lang.String)

deleteExtensionModule

public void deleteExtensionModule(java.lang.String sourceName)
                           throws AdminException

Description copied from interface: ConfigurationAdmin

Deletes an ExtensionModule from the list of modules.
All caches (of Class objects) are cleared.

Specified by:

deleteExtensionModule in interface ConfigurationAdmin

Parameters:

sourceName - name (e.g. filename) of extension module

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.deleteExtensionModule(java.lang.String)

deleteHost

public void deleteHost(java.lang.String identifier)
                throws AdminException

Description copied from interface: ServerConfigAdmin

Delete Host in Configuration

Note that this method may invalidate your connection to the Admin API, if you are connected to the host you are deleting. You may receive an exception on the next call to the API, and then it will recover. As a workaround, you can close your connection and obtain a new connection.

Specified by:

deleteHost in interface ServerConfigAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerConfigAdmin.deleteHost(java.lang.String)

deleteProcess

public void deleteProcess(java.lang.String identifier)
                   throws AdminException

Description copied from interface: ServerConfigAdmin

Delete Process in Configuration

Note that this method may invalidate your connection to the Admin API, if you are connected to the process you are deleting. You may receive an exception on the next call to the API, and then it will recover. As a workaround, you can close your connection and obtain a new connection.

Specified by:

deleteProcess in interface ServerConfigAdmin

Parameters:

identifier - Process Identifer

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerConfigAdmin.deleteProcess(java.lang.String)

getSessionServiceProxy

protected SessionServiceInterface getSessionServiceProxy()
                                                  throws ServiceException

Throws:

ServiceException

getConfigurationServiceProxy

protected ConfigurationServiceInterface getConfigurationServiceProxy()
                                                              throws ServiceException

Throws:

ServiceException

getMembershipServiceProxy

protected MembershipServiceInterface getMembershipServiceProxy()
                                                        throws ServiceException

Throws:

ServiceException

getAuthorizationServiceProxy

protected AuthorizationServiceInterface getAuthorizationServiceProxy()
                                                              throws ServiceException

Throws:

ServiceException

getQueryServiceProxy

protected QueryServiceInterface getQueryServiceProxy()
                                              throws ServiceException

Throws:

ServiceException

getExtensionSourceManager

protected ExtensionModuleManager getExtensionSourceManager()

getRuntimeStateAdminAPIHelper

protected RuntimeStateAdminAPIHelper getRuntimeStateAdminAPIHelper()

getRolesForUser

public java.util.Collection getRolesForUser(java.lang.String userIdentifier)
                                     throws AdminException

Description copied from interface: ServerSecurityAdmin

Get the Collection of administrative role names possessed by the given user, if any.

Specified by:

getRolesForUser in interface ServerSecurityAdmin

Parameters:

userIdentifier - The unique identifier for the user. This is generally a user name. A user is a Principal and a Principal name is considered to be unique throughout the MetaMatrix system across all Membership domains. The WILDCARD cannot be used here.

Returns:

The Collection of Roles

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerSecurityAdmin.getRolesForUser(java.lang.String)

getGroupsForUser

public java.util.Collection getGroupsForUser(java.lang.String userIdentifier)
                                      throws AdminException

Description copied from interface: ServerSecurityAdmin

Get the group memberships for the given user.

Specified by:

getGroupsForUser in interface ServerSecurityAdmin

Specified by:

getGroupsForUser in interface SecurityAdmin

Parameters:

userIdentifier - The unique identifier for the user. This is generally a user name. A user is a Principal and a Principal name is considered to be unique throughout the MetaMatrix system across all Membership domains. The WILDCARD cannot be used here.

Returns:

The collection of groups in which the given user has membership.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerSecurityAdmin.getGroupsForUser(java.lang.String)

getGroups

public java.util.Collection getGroups(java.lang.String groupIdentifier)
                               throws AdminException

Description copied from interface: ServerSecurityAdmin

Get the group denoted by the given groupIdentifier.

Specified by:

getGroups in interface ServerSecurityAdmin

Specified by:

getGroups in interface SecurityAdmin

Parameters:

groupIdentifier - The unique identifier for the Group. This is generally a group name. A group is a Principal and a Principal name is considered to be unique throughout the MetaMatrix system across all Membership domains.
Note that by supplying the WILDCARD identifier, all all users in the system will retrieved.

Returns:

The Collection of groups.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerSecurityAdmin.getGroups(java.lang.String)

getRolesForGroup

public java.util.Collection getRolesForGroup(java.lang.String groupIdentifier)
                                      throws AdminException

Description copied from interface: ServerSecurityAdmin

Get the Collection of administrative role names possessed by the given group, if any.

Specified by:

getRolesForGroup in interface ServerSecurityAdmin

Specified by:

getRolesForGroup in interface SecurityAdmin

Parameters:

groupIdentifier - The unique identifier for the Group. This is group name. A user is a Principal and a Principal name is considered to be unique throughout the MetaMatrix system across all Membership domains. The WILDCARD cannot be used here.

Returns:

The Collection of Roles.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerSecurityAdmin.getRolesForGroup(java.lang.String)

assignBindingToModel

public void assignBindingToModel(java.lang.String connectorBindingName,
                                 java.lang.String vdbName,
                                 java.lang.String vdbVersion,
                                 java.lang.String modelName)
                          throws AdminException

Description copied from interface: ConfigurationAdmin

Assign a ConnectorBinding to a VDB's Model

Specified by:

assignBindingToModel in interface ConfigurationAdmin

Parameters:

connectorBindingName - Name of the ConnectorBinding

vdbName - Name of the VDB

vdbVersion - Version of the VDB

modelName - Name of the Model to map Connector Binding

Throws:

AdminException - if there's a system error or if there's a user input error.

Since:

4.3

See Also:

ConfigurationAdmin.assignBindingToModel(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

deassignBindingFromModel

public void deassignBindingFromModel(java.lang.String connectorBindingName,
                                     java.lang.String vdbName,
                                     java.lang.String vdbVersion,
                                     java.lang.String modelName)
                              throws AdminException

Description copied from interface: ServerConfigAdmin

Deassign a ConnectorBinding from a VDB's Model

Specified by:

deassignBindingFromModel in interface ServerConfigAdmin

Parameters:

connectorBindingName - Name of the ConnectorBinding

vdbName - Name of the VDB

vdbVersion - Version of the VDB

modelName - Name of the Model to unmap Connector Binding

Throws:

AdminException - if there's a system error or if there's a user input error.

Since:

5.0

See Also:

org.teiid.adminapi.ConfigurationAdmin#deassignBindingsFromModel(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

assignBindingsToModel

public void assignBindingsToModel(java.lang.String[] connectorBindingNames,
                                  java.lang.String vdbName,
                                  java.lang.String vdbVersion,
                                  java.lang.String modelName)
                           throws AdminException

Description copied from interface: ServerConfigAdmin

Assign ConnectorBindings to a VDB's Model. If the supplied model does not support MultiSource bindings, then only the first binding in the supplied array is assigned and the remainder are ignored.

Specified by:

assignBindingsToModel in interface ServerConfigAdmin

Specified by:

assignBindingsToModel in interface ConfigurationAdmin

Parameters:

connectorBindingNames - Names of the ConnectorBindings

vdbName - Name of the VDB

vdbVersion - Version of the VDB

modelName - Name of the Model to map Connector Bindings

Throws:

AdminException - if there's a system error or if there's a user input error.

Since:

5.0

See Also:

org.teiid.adminapi.ConfigurationAdmin#assignBindingToModel(String[], java.lang.String, java.lang.String, java.lang.String)

deassignBindingsFromModel

public void deassignBindingsFromModel(java.lang.String[] connectorBindingNames,
                                      java.lang.String vdbName,
                                      java.lang.String vdbVersion,
                                      java.lang.String modelName)
                               throws AdminException

Description copied from interface: ServerConfigAdmin

Deassign ConnectorBindings from a VDB's Model. Any of the supplied array of bindings are deassigned from the supplied model.

Specified by:

deassignBindingsFromModel in interface ServerConfigAdmin

Parameters:

connectorBindingNames - Names of the ConnectorBindings

vdbName - Name of the VDB

vdbVersion - Version of the VDB

modelName - Name of the Model to unmap Connector Bindings

Throws:

AdminException - if there's a system error or if there's a user input error.

Since:

5.0

See Also:

org.teiid.adminapi.ConfigurationAdmin#deassignBindingsFromModel(String[], java.lang.String, java.lang.String, java.lang.String)

importDataRoles

public java.lang.String importDataRoles(java.lang.String vdbName,
                                        java.lang.String vdbVersion,
                                        char[] data,
                                        AdminOptions options)
                                 throws AdminException

Description copied from interface: ServerSecurityAdmin

Import the data Roles for given vdb and version into the connected server

Specified by:

importDataRoles in interface ServerSecurityAdmin

Specified by:

importDataRoles in interface SecurityAdmin

Parameters:

vdbName - - target name of the VDB, the roles to be imported under

vdbVersion - - target version of the vdb, the roles to be imported under

data - - character data array containing the XML file which defines the roles

options - - options to overwrite in case the matching roles already exist.

Returns:

a report of the import

Throws:

AdminException

See Also:

ServerSecurityAdmin.importDataRoles(java.lang.String, java.lang.String, char[], org.teiid.adminapi.AdminOptions)

exportDataRoles

public char[] exportDataRoles(java.lang.String vdbName,
                              java.lang.String vdbVersion)
                       throws AdminException

Description copied from interface: ServerSecurityAdmin

Export the data roles defined for the given vdb from the current system

Specified by:

exportDataRoles in interface ServerSecurityAdmin

Specified by:

exportDataRoles in interface SecurityAdmin

Parameters:

vdbName - - Name of the vdb

vdbVersion - - version of the vdb

Returns:

- char[] stream containing the XML contents of the roles.

Throws:

AdminException

See Also:

ServerSecurityAdmin.exportDataRoles(java.lang.String, java.lang.String)

exportConfiguration

public char[] exportConfiguration()
                           throws AdminException

Description copied from interface: ConfigurationAdmin

Export Configuration to character Array in XML format

Specified by:

exportConfiguration in interface ConfigurationAdmin

Returns:

character array of Configuration

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.exportConfiguration()

importConfiguration

public void importConfiguration(char[] fileData)
                         throws AdminException

Description copied from interface: ServerConfigAdmin

Import the Configuration from a character array in XML format. NOTE: This imports the specified data to the "Next Startup" configuration. The server must be restarted for the new configuration to take effect.

Specified by:

importConfiguration in interface ServerConfigAdmin

Parameters:

fileData - Contents of configuration file, in XML format, as exported by ConfigurationAdmin.exportConfiguration()

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

org.teiid.adminapi.ConfigurationAdmin#importConfiguration()

exportConnectorBinding

public char[] exportConnectorBinding(java.lang.String connectorBindingIdentifier)
                              throws AdminException

Description copied from interface: ConfigurationAdmin

Export a ConnectorBinding to character Array in XML format

Specified by:

exportConnectorBinding in interface ConfigurationAdmin

Parameters:

connectorBindingIdentifier - the unique identifier for a ConnectorBinding.

Returns:

character Array in XML format

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.exportConnectorBinding(java.lang.String)

exportConnectorType

public char[] exportConnectorType(java.lang.String connectorTypeIdentifier)
                           throws AdminException

Description copied from interface: ConfigurationAdmin

Export Connector Type to character array

Specified by:

exportConnectorType in interface ConfigurationAdmin

Parameters:

connectorTypeIdentifier - the unique identifier for for a ConnectorType

Returns:

character Array in XML format

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.exportConnectorType(java.lang.String)

exportConnectorArchive

public byte[] exportConnectorArchive(java.lang.String connectorTypeIdentifier)
                              throws AdminException

Description copied from interface: ConfigurationAdmin

Export Connector Archive, which is bundled connector type with its xml properties file and all the extension modules required by the this connector type

Specified by:

exportConnectorArchive in interface ConfigurationAdmin

Parameters:

connectorTypeIdentifier - the unique identifier for for a ConnectorType

Returns:

byte array of the connector archive.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.exportConnectorArchive(java.lang.String)

exportExtensionModule

public byte[] exportExtensionModule(java.lang.String sourceName)
                             throws AdminException

Description copied from interface: ConfigurationAdmin

Export an ExtensionModule to byte array

Specified by:

exportExtensionModule in interface ConfigurationAdmin

Parameters:

sourceName - unique identifier for the ExtensionModule.

Returns:

byte array of the extension module

Throws:

AdminException

Since:

4.3

See Also:

ConfigurationAdmin.exportExtensionModule(java.lang.String)

exportVDB

public byte[] exportVDB(java.lang.String name,
                        java.lang.String version)
                 throws AdminException

Description copied from interface: ConfigurationAdmin

Export VDB to byte array

Specified by:

exportVDB in interface ConfigurationAdmin

Parameters:

name - identifier of the VDB

version - VDB version

Returns:

byte array of the MetaMatrix VDB Archive

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ConfigurationAdmin.exportVDB(java.lang.String, java.lang.String)

assignRoleToGroup

public void assignRoleToGroup(java.lang.String roleIdentifier,
                              java.lang.String groupIdentifier)
                       throws AdminException

Description copied from interface: ServerSecurityAdmin

Assign to the given Group the given Administrative Role.

Specified by:

assignRoleToGroup in interface ServerSecurityAdmin

Specified by:

assignRoleToGroup in interface SecurityAdmin

Parameters:

roleIdentifier - one of AdminRoles.

groupIdentifier - the unique identifier for the Principal. The WILDCARD cannot be used here.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerSecurityAdmin.assignRoleToGroup(java.lang.String, java.lang.String)

removeRoleFromGroup

public void removeRoleFromGroup(java.lang.String roleIdentifier,
                                java.lang.String grouplIdentifier)
                         throws AdminException

Description copied from interface: ServerSecurityAdmin

Remove an administrative role from the given Group.

Specified by:

removeRoleFromGroup in interface ServerSecurityAdmin

Specified by:

removeRoleFromGroup in interface SecurityAdmin

Parameters:

roleIdentifier - one of AdminRoles

grouplIdentifier - the unique identifier for the Principal. The WILDCARD cannot be used here.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerSecurityAdmin.removeRoleFromGroup(java.lang.String, java.lang.String)

close

public void close()

Do nothing: this is implemented in ServerAdminClientInterceptor on the client-side.

Specified by:

close in interface ServerAdmin

Since:

4.3

See Also:

ServerAdmin.close()

waitForServicesToStart

protected void waitForServicesToStart(java.util.Collection expectedServiceNames)
                               throws MetaMatrixComponentException

Throws:

MetaMatrixComponentException

waitForServicesToStop

protected void waitForServicesToStop(java.util.Collection expectedServiceNames)
                              throws MetaMatrixComponentException

Throws:

MetaMatrixComponentException

generateMaterializationScripts

public ScriptsContainer generateMaterializationScripts(java.lang.String vdbName,
                                                       java.lang.String vdbVersion,
                                                       java.lang.String metamatrixUserName,
                                                       java.lang.String metamatrixUserPwd,
                                                       java.lang.String materializationUserName,
                                                       java.lang.String materializationUserPwd)
                                                throws AdminException

Description copied from interface: ServerConfigAdmin

Generate the scripts necessary for loading or refreshing a VDB with Materialized Views.

This method requires that the VDB version exists in the system and that materialization model(s) have connector bindings bound to them.

Specified by:

generateMaterializationScripts in interface ServerConfigAdmin

Parameters:

vdbName - the name of the VDB containing that materialized views.

vdbVersion - the version of the VDB.

metamatrixUserName - the user that will be used to run the load transformation in MetaMatrix (Load).

metamatrixUserPwd - the MetaMatrix user's password.

materializationUserName - the user that will be used to log in directly to the Materialization database and run the DDL (Create, Truncate, Swap).

materializationUserPwd - the materialization user's password.

Returns:

The container of scripts that can be saved to a directory.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerConfigAdmin.generateMaterializationScripts(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

addUDF

public void addUDF(byte[] modelFileContents,
                   java.lang.String classpath)
            throws AdminException

Description copied from interface: ConfigurationAdmin

Add User Defined Function model to the system. If one is already deployed before this will replace the previous, otherwise add this as the new UDF model. Once the UDF is added the new UDF model is loaded.

Specified by:

addUDF in interface ConfigurationAdmin

Parameters:

modelFileContents - - UDF contents

classpath - - classpath for the UDF

Throws:

AdminException

See Also:

ConfigurationAdmin.addUDF(byte[], java.lang.String)

deleteUDF

public void deleteUDF()
               throws AdminException

Description copied from interface: ConfigurationAdmin

Delete the User Defined Function model. Note that this will not delete any supporting extension jar files added, those need to be deleted separately.

Specified by:

deleteUDF in interface ConfigurationAdmin

Throws:

AdminException

See Also:

ConfigurationAdmin.deleteUDF()

getBootstrapProperties

public java.util.Properties getBootstrapProperties()
                                            throws AdminException

Description copied from interface: ServerConfigAdmin

Return the bootstrap properties used to configure initialize the system.

Specified by:

getBootstrapProperties in interface ServerConfigAdmin

Returns:

Throws:

AdminException

getClusterKey

public byte[] getClusterKey()
                     throws AdminException

Description copied from interface: ServerConfigAdmin

Retrieves the cluster key that authenticates and secures intra-cluster communication.

Specified by:

getClusterKey in interface ServerConfigAdmin

Returns:

the cluster key or null if encryption is disabled

Throws:

AdminException

authenticateUser

public boolean authenticateUser(java.lang.String username,
                                char[] credentials,
                                java.io.Serializable trustePayload,
                                java.lang.String applicationName)
                         throws AdminException

Description copied from interface: ServerSecurityAdmin

Authenticate a user with the specified user name and credentials for use with the specified application. The application name may also be used by the Membership Service to determine the appropriate authentication mechanism.

Specified by:

authenticateUser in interface ServerSecurityAdmin

Specified by:

authenticateUser in interface SecurityAdmin

Parameters:

username - the user name that is to be authenticated

applicationName - the name of the application for which the user is authenticating

Returns:

true if the authentication is successful

Throws:

AdminException

getDomainNames

public java.util.List<java.lang.String> getDomainNames()
                                                throws AdminException

Description copied from interface: ServerSecurityAdmin

Returns the active authorization provider domain names, in authentication order.

Specified by:

getDomainNames in interface ServerSecurityAdmin

Specified by:

getDomainNames in interface SecurityAdmin

Returns:

List

Throws:

AdminException

getGroupsForDomain

public java.util.Collection<Group> getGroupsForDomain(java.lang.String domainName)
                                               throws AdminException

Description copied from interface: ServerSecurityAdmin

Return the Groups for a given domain. The domain name must be an specified exactly. See #getActiveDomainNames() for possible domain names.

Specified by:

getGroupsForDomain in interface ServerSecurityAdmin

Specified by:

getGroupsForDomain in interface SecurityAdmin

Returns:

Throws:

AdminException

getTransactions

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

Description copied from interface: MonitoringAdmin

Get all transaction matching the identifier.

Specified by:

getTransactions in interface MonitoringAdmin

Returns:

Throws:

AdminException

terminateTransaction

public void terminateTransaction(java.lang.String transactionId,
                                 java.lang.String sessionId)
                          throws AdminException

Description copied from interface: RuntimeStateAdmin

Mark the given transaction as rollback only.

Specified by:

terminateTransaction in interface RuntimeStateAdmin

Throws:

AdminException

terminateTransaction

public void terminateTransaction(javax.transaction.xa.Xid transactionId)
                          throws AdminException

Description copied from interface: RuntimeStateAdmin

Mark the given global transaction as rollback only.

Specified by:

terminateTransaction in interface RuntimeStateAdmin

Throws:

AdminException

getServices

public java.util.Collection getServices(java.lang.String identifier)
                                 throws AdminException

Description copied from interface: ServerMonitoringAdmin

Get the Services that correspond to the specified identifer pattern. These services represent what is defined for a given Host | Process;

Specified by:

getServices in interface ServerMonitoringAdmin

Returns:

Collection of Service

Throws:

AdminException - if there's a system error.

getConnectionPoolStats

public java.util.Collection getConnectionPoolStats(java.lang.String identifier)
                                            throws AdminException

Description copied from interface: MonitoringAdmin

Get the Connection Pool Stats that correspond to the specified identifier pattern. If the ConnectionPool represents an XA connection, there will be 2 ConnectionPools.

Specified by:

getConnectionPoolStats in interface MonitoringAdmin

Parameters:

identifier - - an identfier that corresponds to the ConnectorBinding that is running in a process ConnectionPool

• "*" - for all Connection Pools in the system
• "name*" - for all the Connection Pools that begin with given name
• "name" - for a single Connection Pool in the system

Returns:

Collection of ConnectionPool

Throws:

AdminException - if there's a system error.

extensionModuleModified

public void extensionModuleModified(java.lang.String name)
                             throws AdminException

Description copied from interface: ConfigurationAdmin

Indicates that an extension module has changed

Specified by:

extensionModuleModified in interface ConfigurationAdmin

Throws:

AdminException

restart

public void restart()
             throws AdminException

Description copied from interface: RuntimeStateAdmin

Restart System

Specified by:

restart in interface RuntimeStateAdmin

Throws:

AdminException - if there's a system error.

setLogListener

public void setLogListener(EmbeddedLogger listener)
                    throws AdminException

Description copied from interface: ConfigurationAdmin

Set the log listener to install into MM Query. This log listener will receive all log messages written by the MM Query at it's current log level and log contexts. Note: Logging changes are not persistent. This will be fixed in future versions.

Specified by:

setLogListener in interface ConfigurationAdmin

Parameters:

listener - The listener component

Throws:

AdminException - if there's a system error.

shutdown

public void shutdown(int millisToWait)
              throws AdminException

Description copied from interface: RuntimeStateAdmin

Stop the MM Query. If millisToWait is >0, then close to incoming queries, wait the time period for work to stop, then stop the MM Query. Otherwise, stop immediately, aborting all running queries.

Specified by:

shutdown in interface RuntimeStateAdmin

Parameters:

millisToWait - Milliseconds to wait (if >0) or <=0 for no wait before stopping

Throws:

AdminException

deleteVDB

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

Description copied from interface: ConfigurationAdmin

Delete the VDB with the given name and version

Specified by:

deleteVDB in interface ConfigurationAdmin

Throws:

AdminException

setConnectorBindingProperty

public void setConnectorBindingProperty(java.lang.String deployedName,
                                        java.lang.String propertyName,
                                        java.lang.String propertyValue)
                                 throws AdminException

Description copied from interface: ConfigurationAdmin

Set/update the property for the Connector Binding identified by the given deployed name.

Specified by:

setConnectorBindingProperty in interface ConfigurationAdmin

Throws:

AdminException

getConnectorTypePropertyDefinitions

public java.util.Collection<PropertyDefinition> getConnectorTypePropertyDefinitions(java.lang.String connectorTypeIdentifier)
                                                                             throws AdminException

Description copied from interface: MonitoringAdmin

Get all of the available Configuration Properties for the specified AdminObject, and details about them.

Specified by:

getConnectorTypePropertyDefinitions in interface MonitoringAdmin

Returns:

Throws:

AdminException

setProcessProperty

public void setProcessProperty(java.lang.String processIdentifier,
                               java.lang.String propertyName,
                               java.lang.String propertyValue)
                        throws AdminException

Description copied from interface: ConfigurationAdmin

Set a process level property.

Specified by:

setProcessProperty in interface ConfigurationAdmin

Parameters:

processIdentifier - - identifier for the process where the property needs to be set

propertyName - - name of the property

propertyValue - - value of the property

Throws:

AdminException

getConnectorBindingsInVDB

public java.util.Collection<ConnectorBinding> getConnectorBindingsInVDB(java.lang.String vdbName,
                                                                        java.lang.String vdbVersion)
                                                                 throws AdminException

Description copied from interface: MonitoringAdmin

Get all the Connector Bindings for the given VDB identifier pattern

Specified by:

getConnectorBindingsInVDB in interface MonitoringAdmin

Parameters:

vdbName - - Name of the VDB

vdbVersion - - version of the VDB

Returns:

Collection of ConnectorBinding

Throws:

AdminException - if there's a system error.