com.metamatrix.admin.server
Class ServerConfigAdminImpl

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

All Implemented Interfaces:

CoreConfigAdmin, ServerConfigAdmin

public class ServerConfigAdminImpl
extends AbstractAdminImpl
implements ServerConfigAdmin

Since:

4.3

Field Summary

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

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	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
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)
java.util.Collection	getConnectorBindingsToConfigure(java.lang.String resourceIdentfier) Get the ConnectorBindings that correspond to the specified identifir pattern.
LogConfiguration	getLogConfiguration() Get the LogConfiguration
protected java.util.Collection	getModels(VirtualDatabaseID vdbId)
protected ServiceComponentDefn	getServiceByID(ServiceComponentDefnID serviceID)
protected ServiceComponentDefn	getServiceByName(java.lang.String serviceName)
java.util.Collection	getServicesToConfigure(java.lang.String resourceIdentfier) Get the Services that correspond to the specified identifier pattern.
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	setLogConfiguration(LogConfiguration adminLogConfig) Set the LogConfiguration in the MetaMatrix Server
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) Set system-wide property.
protected void	setVDBState(VirtualDatabaseID vdbID, int siState)
void	updateProperties(java.lang.String identifier, java.lang.String className, java.util.Properties properties) Supported classes are Host, ConnectorBinding, SystemObject, ProcessObject
void	updateSystemProperties(java.util.Properties properties) Set several system-wide properties.

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

convertPropertyDefinitions, convertPropertyDefinitions, convertPropertyDefinitions, convertToAdminVDB, getAdminObjects, getAuthorizationServiceProxy, getConfigurationModel, getConfigurationServiceProxy, getConnectorBindingNamesFromUUIDs, getConnectorBindingNamesMapFromUUIDs, getExtensionSourceManager, getMembershipServiceProxy, getName, 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: CoreConfigAdmin

Deploy a ConnectorBinding to Configuration

Specified by:

addConnectorBinding in interface CoreConfigAdmin

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:

CoreConfigAdmin.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: CoreConfigAdmin

Import a ConnectorBinding into the Configuration.

Specified by:

addConnectorBinding in interface CoreConfigAdmin

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:

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

addConnectorType

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

Description copied from interface: CoreConfigAdmin

Add Connector Type, will import Connector Type from a file

Specified by:

addConnectorType in interface CoreConfigAdmin

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:

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

addConnectorArchive

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

Description copied from interface: CoreConfigAdmin

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 CoreConfigAdmin

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:

CoreConfigAdmin.addConnectorArchive(byte[], com.metamatrix.admin.api.objects.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:

com.metamatrix.admin.api.core.CoreConfigAdmin#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: CoreConfigAdmin

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

Specified by:

addExtensionModule in interface CoreConfigAdmin

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: CoreConfigAdmin

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

Specified by:

deleteExtensionModule in interface CoreConfigAdmin

Parameters:

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

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreConfigAdmin.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: CoreConfigAdmin

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 CoreConfigAdmin

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: CoreConfigAdmin

Export Configuration to character Array in XML format

Specified by:

exportConfiguration in interface CoreConfigAdmin

Returns:

character array of Configuration

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreConfigAdmin.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 CoreConfigAdmin.exportConfiguration()

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

com.metamatrix.admin.api.core.CoreConfigAdmin#importConfiguration(char[])

exportConnectorBinding

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

Description copied from interface: CoreConfigAdmin

Export a ConnectorBinding to character Array in XML format

Specified by:

exportConnectorBinding in interface CoreConfigAdmin

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:

CoreConfigAdmin.exportConnectorBinding(java.lang.String)

exportConnectorType

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

Description copied from interface: CoreConfigAdmin

Export Connector Type to character array

Specified by:

exportConnectorType in interface CoreConfigAdmin

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:

CoreConfigAdmin.exportConnectorType(java.lang.String)

exportConnectorArchive

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

Description copied from interface: CoreConfigAdmin

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 CoreConfigAdmin

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:

CoreConfigAdmin.exportConnectorArchive(java.lang.String)

exportExtensionModule

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

Description copied from interface: CoreConfigAdmin

Export an ExtensionModule to byte array

Specified by:

exportExtensionModule in interface CoreConfigAdmin

Parameters:

identifier - unique identifier for the ExtensionModule.

Returns:

byte array of the extension module

Throws:

AdminException

Since:

4.3

See Also:

CoreConfigAdmin.exportExtensionModule(java.lang.String)

exportVDB

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

Description copied from interface: CoreConfigAdmin

Export VDB to byte array

Specified by:

exportVDB in interface CoreConfigAdmin

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:

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

getLogConfiguration

public LogConfiguration getLogConfiguration()
                                     throws AdminException

Description copied from interface: CoreConfigAdmin

Get the LogConfiguration

Specified by:

getLogConfiguration in interface CoreConfigAdmin

Returns:

LogConfiguration object

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreConfigAdmin.getLogConfiguration()

setLogConfiguration

public void setLogConfiguration(LogConfiguration adminLogConfig)
                         throws AdminException

Description copied from interface: CoreConfigAdmin

Set the LogConfiguration in the MetaMatrix Server

Specified by:

setLogConfiguration in interface CoreConfigAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreConfigAdmin.setLogConfiguration(com.metamatrix.admin.api.objects.LogConfiguration)

setSystemProperty

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

Description copied from interface: CoreConfigAdmin

Set system-wide property. This will be written to config_ns.xml

Specified by:

setSystemProperty in interface CoreConfigAdmin

Parameters:

propertyName - Name of the System Property

propertyValue - Value of the System Property

Throws:

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

Since:

4.3

See Also:

CoreConfigAdmin.setSystemProperty(java.lang.String, java.lang.String)

updateSystemProperties

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

Description copied from interface: CoreConfigAdmin

Set several system-wide properties. These will be written to config_ns.xml Any existing properties not specified will not be changed.

Specified by:

updateSystemProperties in interface CoreConfigAdmin

Parameters:

properties - Properties to set.

Throws:

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

Since:

4.3

See Also:

CoreConfigAdmin.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

Specified by:

setProperty in interface CoreConfigAdmin

Parameters:

identifier - The unique identifier for for an AdminObject.

className - The class name of the sub-interface of AdminObject you are setting the property for. All of these sub-interfaces are in package com.metamatrix.admin.api.objects. You may specify either the fully-qualified or unqualified classname. For example "ConnectorBinding" or "com.metamatrix.admin.api.objects.ConnectorBinding".

propertyName - String Property key

propertyValue - String value to update

Throws:

AdminException - if there's a system error.

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 Host, ConnectorBinding, SystemObject, ProcessObject

Specified by:

updateProperties in interface CoreConfigAdmin

Parameters:

identifier - The unique identifier for for an AdminObject.

className - The class name of the sub-interface of AdminObject you are setting the property for. All of these sub-interfaces are in package com.metamatrix.admin.api.objects. You may specify either the fully-qualified or unqualified classname. For example "ConnectorBinding" or "com.metamatrix.admin.api.objects.ConnectorBinding".

properties - Properties to set.

Throws:

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

Since:

4.3

See Also:

CoreConfigAdmin.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: CoreConfigAdmin

Assign a ConnectorBinding to a VDB's Model

Specified by:

assignBindingToModel in interface CoreConfigAdmin

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:

CoreConfigAdmin.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:

com.metamatrix.admin.api.core.CoreConfigAdmin#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

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:

com.metamatrix.admin.api.core.CoreConfigAdmin#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:

com.metamatrix.admin.api.core.CoreConfigAdmin#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: CoreConfigAdmin

Delete the ConnectorBinding from the Configuration

Specified by:

deleteConnectorBinding in interface CoreConfigAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreConfigAdmin.deleteConnectorBinding(java.lang.String)

deleteConnectorType

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

Description copied from interface: CoreConfigAdmin

Delete Connector Type from Next Configuration

Specified by:

deleteConnectorType in interface CoreConfigAdmin

Parameters:

name - String name of the Connector Type to delete

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreConfigAdmin.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)

getConnectorBindingsToConfigure

public java.util.Collection getConnectorBindingsToConfigure(java.lang.String resourceIdentfier)
                                                     throws AdminException

Description copied from interface: ServerConfigAdmin

Get the ConnectorBindings that correspond to the specified identifir pattern. These connectorbindings represent the unique instance to be configured and instantiated when the server starts up. To monitor the current state of a running connectorbinding, call CoreMonitoringAdmin.getConnectorBindings(String)

Specified by:

getConnectorBindingsToConfigure in interface ServerConfigAdmin

Returns:

Collection of ConnectorBinding

Throws:

AdminException - if there's a system error.

getServicesToConfigure

public java.util.Collection getServicesToConfigure(java.lang.String resourceIdentfier)
                                            throws AdminException

Description copied from interface: ServerConfigAdmin

Get the Services that correspond to the specified identifier pattern. These services represent the unique instance to be configured and instantiated when the server starts up. To monitor the current state of a running service, call ServerMonitoringAdmin.getServices(String)

Specified by:

getServicesToConfigure in interface ServerConfigAdmin

Returns:

Collection of Service

Throws:

AdminException - if there's a system error.

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

addUDF

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

Description copied from interface: CoreConfigAdmin

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 CoreConfigAdmin

Parameters:

modelFileContents - - UDF contents

classpath - - classpath for the UDF

Throws:

AdminException

See Also:

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

deleteUDF

public void deleteUDF()
               throws AdminException

Description copied from interface: CoreConfigAdmin

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 CoreConfigAdmin

Throws:

AdminException

See Also:

CoreConfigAdmin.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