com.metamatrix.admin.server
Class ServerConfigAdminImpl

java.lang.Object
  com.metamatrix.admin.server.AbstractAdminImpl
      com.metamatrix.admin.server.ServerConfigAdminImpl

All Implemented Interfaces:

ServerConfigAdmin, ConfigurationAdmin

public class ServerConfigAdminImpl
extends AbstractAdminImpl
implements ServerConfigAdmin

Since:

4.3

Field Summary

Fields inherited from class com.metamatrix.admin.server.AbstractAdminImpl

OBJECT_TYPE_CACHE, OBJECT_TYPE_CONNECTION_POOL, OBJECT_TYPE_CONNECTOR_BINDING, OBJECT_TYPE_CONNECTOR_TYPE, OBJECT_TYPE_EXTENSION_MODULE, OBJECT_TYPE_GROUP, OBJECT_TYPE_LOG_CONFIGURATION, OBJECT_TYPE_MODEL, OBJECT_TYPE_PROCESS_OBJECT, OBJECT_TYPE_PROPERTY_DEFINITION, OBJECT_TYPE_QUEUE_WORKER_POOL, OBJECT_TYPE_REQUEST, OBJECT_TYPE_ROLE, OBJECT_TYPE_SESSION, OBJECT_TYPE_TRANSACTION, OBJECT_TYPE_VDB, OBJECTS_PACKAGE, parent, registry

Constructor Summary

ServerConfigAdminImpl(ServerAdminImpl parent, ClusteredRegistryState registry)

Method Summary

void	addAuthorizationProvider(java.lang.String domainprovidername, java.lang.String providertypename, java.util.Properties properties)
void	addConnectorArchive(byte[] contents, 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 connectorBindingName, char[] xmlFile, AdminOptions options) Import a ConnectorBinding into the Configuration.
ConnectorBinding	addConnectorBinding(java.lang.String connectorBindingName, java.lang.String connectorTypeIdentifier, java.util.Properties properties, 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 hostIdentifer, 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	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 processIdentifier) 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
byte[]	exportExtensionModule(java.lang.String identifier) Export an ExtensionModule to byte array
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 java.util.Collection	getBindingNamesToUpdate(java.util.Collection existingBindings, java.util.Collection newBindingNames, AdminOptions options) Check to see if any new connector bindings being added collide with existing bindings.
java.util.Properties	getBootstrapProperties() Return the bootstrap properties used to configure initialize the system.
byte[]	getClusterKey() Retrieves the cluster key that authenticates and secures intra-cluster communication.
protected java.util.List<ConnectorBinding>	getConnectorBindingsByName(java.lang.String[] bindingNames)
LogConfiguration	getLogConfiguration() Get the LogConfiguration
protected java.util.Collection	getModels(VirtualDatabaseID vdbId)
protected int	getNodeCount(java.lang.String identifier) Will return the number of nodes in an identifier based on the delimiter AdminObject.DELIMITER
protected ServiceComponentDefn	getServiceByID(ServiceComponentDefnID serviceID)
protected ServiceComponentDefn	getServiceByName(java.lang.String serviceName)
protected java.util.Collection	getVirtualDatabases()
void	importConfiguration(char[] fileData) Import the Configuration from a character array in XML format.
protected void	setConnectorBindingNames(VirtualDatabaseID vdbId, java.util.Map mapModelsToConnBinds)
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 adminLogConfig) 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) Supported classes are Host, ConnectorBinding, SystemObject, ProcessObject
void	setSystemProperty(java.lang.String propertyName, java.lang.String propertyValue)
protected void	setVDBState(VirtualDatabaseID vdbID, int siState)
void	updateProperties(java.lang.String identifier, java.lang.String className, java.util.Properties properties) Supported classes are ConnectorBinding, Service, SystemObject, ProcessObject
void	updateSystemProperties(java.util.Properties properties)

Methods inherited from class com.metamatrix.admin.server.AbstractAdminImpl

convertPropertyDefinitions, convertPropertyDefinitions, convertPropertyDefinitions, convertToAdminVDB, getAdminObjects, getAuthorizationServiceProxy, getConfigurationModel, getConfigurationServiceProxy, getConnectorBindingNamesFromUUIDs, getConnectorBindingNamesMapFromUUIDs, getDeployedComponent, getExtensionSourceManager, getMembershipServiceProxy, getName, getObjectType, getParent, getQueryServiceProxy, getRuntimeStateAdminAPIHelper, getSessionID, getSessionServiceProxy, getUserName, getVDBs, identifierMatches, identifierMatches, logDetail, shutDownConnectorBinding, throwProcessingException, validateSession

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerConfigAdminImpl

public ServerConfigAdminImpl(ServerAdminImpl parent,
                             ClusteredRegistryState registry)

Method Detail

addConnectorBinding

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

Description copied from interface: ConfigurationAdmin

Deploy a ConnectorBinding to Configuration

Specified by:

addConnectorBinding in interface ConfigurationAdmin

Parameters:

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

connectorTypeIdentifier - Name of the Connector Type

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

Since:

4.3

See Also:

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

addConnectorBinding

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

Description copied from interface: ConfigurationAdmin

Import a ConnectorBinding into the Configuration.

Specified by:

addConnectorBinding in interface ConfigurationAdmin

Parameters:

connectorBindingName, - is nullable, indicates the name to assign to the importing ConnectorBinding. If it is null, then the name defined in the xmlFile will be used.

xmlFile - is an xml formatted file that defines the connector binding

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, - is nullable, indicates the name to assign to the connector type If name is null, then the name defined in the cdkFile will be used.

Throws:

MetaMatrixComponentException

MetaMatrixProcessingException

AdminException - if there's a system error.

Since:

4.3

See Also:

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

addConnectorArchive

public void addConnectorArchive(byte[] contents,
                                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:

contents - 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)

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:

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

provdertypename - is the type of provider to create.

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

Throws:

AdminException - if there's a system error.

Since:

5.6

See Also:

org.teiid.adminapi.ConfigurationAdmin#addAuthroizationProvider(String, String, Properties)

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)

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)

addHost

public void addHost(java.lang.String hostIdentifer,
                    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:

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

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, - is nullable, indicates the name to assign to the vdb If name is null, then use the name defined in the vdbFile.

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[])

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)

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)

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(char[])

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 identifier)
                             throws AdminException

Description copied from interface: ConfigurationAdmin

Export an ExtensionModule to byte array

Specified by:

exportExtensionModule in interface ConfigurationAdmin

Parameters:

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

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 adminLogConfig)
                         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 propertyName,
                              java.lang.String propertyValue)
                       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)

setProperty

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

Supported classes are Host, ConnectorBinding, SystemObject, ProcessObject

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

Supported classes are ConnectorBinding, Service, SystemObject, ProcessObject

Throws:

AdminException

Since:

4.3

See Also:

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

getConnectorBindingsByName

protected java.util.List<ConnectorBinding> getConnectorBindingsByName(java.lang.String[] bindingNames)
                                                               throws ConfigurationException,
                                                                      ServiceException,
                                                                      AdminProcessingException

Throws:

ConfigurationException

ServiceException

AdminProcessingException

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#deassignBindingFromModel(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:

ConfigurationAdmin.assignBindingsToModel(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#deassignBindingFromModel(String[], java.lang.String, java.lang.String, java.lang.String)

getVirtualDatabases

protected java.util.Collection getVirtualDatabases()
                                            throws VirtualDatabaseException

Throws:

VirtualDatabaseException

getModels

protected java.util.Collection getModels(VirtualDatabaseID vdbId)
                                  throws VirtualDatabaseException

Throws:

VirtualDatabaseException

setConnectorBindingNames

protected void setConnectorBindingNames(VirtualDatabaseID vdbId,
                                        java.util.Map mapModelsToConnBinds)
                                 throws VirtualDatabaseException

Throws:

VirtualDatabaseException

setVDBState

protected void setVDBState(VirtualDatabaseID vdbID,
                           int siState)
                    throws VirtualDatabaseException

Throws:

VirtualDatabaseException

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)

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 processIdentifier)
                   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:

processIdentifier - Process Identifer

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerConfigAdmin.deleteProcess(java.lang.String)

getServiceByName

protected ServiceComponentDefn getServiceByName(java.lang.String serviceName)
                                         throws ConfigurationException,
                                                InvalidSessionException,
                                                AuthorizationException,
                                                MetaMatrixComponentException

Throws:

ConfigurationException

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

getServiceByID

protected ServiceComponentDefn getServiceByID(ServiceComponentDefnID serviceID)
                                       throws InvalidSessionException,
                                              AuthorizationException,
                                              ConfigurationException,
                                              MetaMatrixComponentException

Throws:

InvalidSessionException

AuthorizationException

ConfigurationException

MetaMatrixComponentException

getBindingNamesToUpdate

protected java.util.Collection getBindingNamesToUpdate(java.util.Collection existingBindings,
                                                       java.util.Collection newBindingNames,
                                                       AdminOptions options)
                                                throws AdminException

Check to see if any new connector bindings being added collide with existing bindings. Binding collision is determined by connector binding name. Collision resolution is determined by examining the AdminOptions the user passed in.

Parameters:

existingBindings - Collection of ConnectorBinding that already exist in the system. Their names are used to determine collision with new binding names.

newBindingNames -

options - One of the AdminOptions.OnConflict options.

Returns:

The collection of total bindings to add or update.

Throws:

AdminException

Since:

4.3

getNodeCount

protected int getNodeCount(java.lang.String identifier)

Will return the number of nodes in an identifier based on the delimiter AdminObject.DELIMITER

Parameters:

identifier -

Returns:

the number of nodes

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

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

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

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.

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