com.metamatrix.admin.api.core
Interface CoreConfigAdmin

All Known Subinterfaces:

Admin, EmbeddedAdmin, EmbeddedConfigAdmin, ServerAdmin, ServerConfigAdmin

All Known Implementing Classes:

DQPConfigAdminImpl, ServerAdminImpl, ServerConfigAdminImpl

@RolesAllowed(value="Admin.SystemAdmin")
public interface CoreConfigAdmin

This interface describes the methods to configure MetaMatrix.

As a core interface, this administration is common to both the MetaMatrix server and MM Query.

Since:

4.3

Method Summary

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 name, 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	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	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	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	deleteUDF() Delete the User Defined Function model.
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 sourceName) Export an ExtensionModule to byte array
byte[]	exportVDB(java.lang.String name, java.lang.String version) Export VDB to byte array
LogConfiguration	getLogConfiguration() Get the LogConfiguration
void	setLogConfiguration(LogConfiguration config) 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) Set a Property for an AdminObject
void	setSystemProperty(java.lang.String propertyName, java.lang.String propertyValue) Set system-wide property.
void	updateProperties(java.lang.String identifier, java.lang.String className, java.util.Properties properties) Set several properties for an AdminObject.
void	updateSystemProperties(java.util.Properties properties) Set several system-wide properties.

Method Detail

setSystemProperty

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

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

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

updateSystemProperties

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

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

Parameters:

properties - Properties to set.

Throws:

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

Since:

4.3

assignBindingToModel

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

Assign a ConnectorBinding to a VDB's Model

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

setProperty

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

Set a Property for an AdminObject

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

updateProperties

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

Set several properties for an AdminObject. Any existing properties not specified will not be changed.

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

addConnectorType

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

Add Connector Type, will import Connector Type from a file

Parameters:

name - of the Connector Type to add

cdkFile - contents of File from Client

Throws:

AdminException - if there's a system error.

Since:

4.3

addConnectorArchive

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

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.

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

deleteConnectorType

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

Delete Connector Type from Next Configuration

Parameters:

name - String name of the Connector Type to delete

Throws:

AdminException - if there's a system error.

Since:

4.3

addConnectorBinding

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

Deploy a ConnectorBinding to Configuration

Parameters:

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

Since:

4.3

addConnectorBinding

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

Import a ConnectorBinding into the Configuration.

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

deleteConnectorBinding

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

Delete the ConnectorBinding from the Configuration

Parameters:

connectorBindingIdentifier -

Throws:

AdminException - if there's a system error.

Since:

4.3

addVDB

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

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

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

getLogConfiguration

@RolesAllowed(value="Admin.ReadOnlyAdmin")
LogConfiguration getLogConfiguration()
                                     throws AdminException

Get the LogConfiguration

Returns:

LogConfiguration object

Throws:

AdminException - if there's a system error.

Since:

4.3

setLogConfiguration

void setLogConfiguration(LogConfiguration config)
                         throws AdminException

Set the LogConfiguration in the MetaMatrix Server

Parameters:

config -

Throws:

AdminException - if there's a system error.

Since:

4.3

addExtensionModule

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

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

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

deleteExtensionModule

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

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

Parameters:

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

Throws:

AdminException - if there's a system error.

exportExtensionModule

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

Export an ExtensionModule to byte array

Parameters:

sourceName - unique identifier for the ExtensionModule.

Returns:

byte array of the extension module

Throws:

AdminException

Since:

4.3

exportConfiguration

char[] exportConfiguration()
                           throws AdminException

Export Configuration to character Array in XML format

Returns:

character array of Configuration

Throws:

AdminException - if there's a system error.

Since:

4.3

exportConnectorBinding

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

Export a ConnectorBinding to character Array in XML format

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

exportConnectorType

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

Export Connector Type to character array

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

exportConnectorArchive

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

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

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

exportVDB

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

Export VDB to byte array

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

addUDF

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

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.

Parameters:

modelFileContents - - UDF contents

classpath - - classpath for the UDF

Throws:

AdminException

deleteUDF

void deleteUDF()
               throws AdminException

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

Throws:

AdminException