com.metamatrix.admin.api.server
Interface ServerConfigAdmin

All Superinterfaces:

CoreConfigAdmin

All Known Subinterfaces:

ServerAdmin

All Known Implementing Classes:

ServerAdminImpl, ServerConfigAdminImpl

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

Interface that exposes MetaMatrix server configuration for administration.

Clients should not code directly to this interface but should instead use ServerAdmin.

Since:

4.3

Method Summary

void	addAuthorizationProvider(java.lang.String domainprovidername, java.lang.String providertypename, java.util.Properties properties)
void	addHost(java.lang.String hostIdentifier, 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	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	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	deleteHost(java.lang.String identifier) Delete Host in Configuration
void	deleteProcess(java.lang.String identifier) Delete Process in Configuration
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 hostIdentifier) Enable Host in Configuration
void	enableProcess(java.lang.String identifier) Enable Process in Configuration
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.
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.
java.util.Collection	getConnectorBindingsToConfigure(java.lang.String resourceIdentfier) Get the ConnectorBindings that correspond to the specified identifir pattern.
java.util.Collection	getServicesToConfigure(java.lang.String resourceIdentfier) Get the Services that correspond to the specified identifier pattern.
void	importConfiguration(char[] fileData) Import the Configuration from a character array in XML format.

Methods inherited from interface com.metamatrix.admin.api.core.CoreConfigAdmin

addConnectorArchive, addConnectorBinding, addConnectorBinding, addConnectorType, addExtensionModule, addUDF, addVDB, assignBindingToModel, deleteConnectorBinding, deleteConnectorType, deleteExtensionModule, deleteUDF, exportConfiguration, exportConnectorArchive, exportConnectorBinding, exportConnectorType, exportExtensionModule, exportVDB, getLogConfiguration, setLogConfiguration, setProperty, setSystemProperty, updateProperties, updateSystemProperties

Method Detail

generateMaterializationScripts

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

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.

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

addHost

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

Add a Host with Properties to MetaMatrix System

Parameters:

hostIdentifier - Name of Host to add

properties - name,value

Throws:

AdminException - if there's a system error.

Since:

4.3

enableHost

void enableHost(java.lang.String hostIdentifier)
                throws AdminException

Enable Host in Configuration

Parameters:

hostIdentifier -

Throws:

AdminException - if there's a system error.

Since:

4.3

disableHost

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

Disable Host in Configuration

Parameters:

identifier -

Throws:

AdminException - if there's a system error.

Since:

4.3

deleteHost

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

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.

Parameters:

identifier -

Throws:

AdminException - if there's a system error.

Since:

4.3

deleteProcess

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

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.

Parameters:

identifier - Process Identifer

Throws:

AdminException - if there's a system error.

Since:

4.3

enableProcess

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

Enable Process in Configuration

Parameters:

identifier -

Throws:

AdminException - if there's a system error.

Since:

4.3

disableProcess

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

Disable Process in Configuration

Parameters:

identifier -

Throws:

AdminException - if there's a system error.

Since:

4.3

addProcess

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

Add Process to specified host in the processIdentifier

Parameters:

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

properties -

Throws:

AdminException - if there's a system error.

Since:

4.3

importConfiguration

void importConfiguration(char[] fileData)
                         throws AdminException

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.

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

deassignBindingFromModel

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

Deassign a ConnectorBinding from 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 unmap Connector Binding

Throws:

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

Since:

4.3

assignBindingsToModel

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

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.

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:

4.3

deassignBindingsFromModel

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

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

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:

4.3

addAuthorizationProvider

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

Parameters:

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

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

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

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

Throws:

AdminException - if there's a system error.

Since:

5.5.2

getBootstrapProperties

java.util.Properties getBootstrapProperties()
                                            throws AdminException

Return the bootstrap properties used to configure initialize the system.

Returns:

Throws:

AdminException

Since:

6.0.0

getClusterKey

byte[] getClusterKey()
                     throws AdminException

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

Returns:

the cluster key or null if encryption is disabled

Throws:

AdminException

Since:

6.0.0

getServicesToConfigure

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

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)

Parameters:

resourceIdentifier - the unique identifier for for a Service in the system or "WILDCARD" if all Services are desired. NOTE: The Service is used for both monitoring and configuration. For a Service returned as part of configuration, the State will not be applicable. To find the state of a current running instance, call ServerMonitoringAdmin.getServices(String)

Returns:

Collection of Service

Throws:

AdminException - if there's a system error.

Since:

6.1

getConnectorBindingsToConfigure

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

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)

Parameters:

resourceIdentifier - the unique identifier for for a ConnectorBinding in the system or "WILDCARD" if all Services are desired. NOTE: The ConnectorBinding is used for both monitoring and configuration. For a Service returned as part of configuration, the State will not be applicable. To find the state of a current running instance, call ServerMonitoringAdmin#getConnectorBinding(String)

Returns:

Collection of ConnectorBinding

Throws:

AdminException - if there's a system error.

Since:

6.1