org.odpi.openmetadata.adminservices

Class OMAGServerAdminStoreServices

java.lang.Object

org.odpi.openmetadata.adminservices.OMAGServerAdminStoreServices

public class OMAGServerAdminStoreServices
extends Object

OMAGServerAdminStoreServices provides the capability to store and retrieve configuration documents. A configuration document provides the configuration information for a server. By default, a server's configuration document is stored in its own file. However, it is possible to override the default location using setConfigurationStoreConnection. This override affects all server instances in this process.

Constructor Summary

Constructors

Constructor and Description
OMAGServerAdminStoreServices()

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearConfigurationStoreConnection(String userId) Clear the connection object for the configuration store.
ConnectionResponse	getConfigurationStoreConnection(String userId) Return the connection object for the configuration store.
VoidResponse	setConfigurationStoreConnection(String userId, Connection connection) Override the default location of the configuration documents.

Methods inherited from class java.lang.Object

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

Constructor Detail

OMAGServerAdminStoreServices

public OMAGServerAdminStoreServices()

Method Detail

setConfigurationStoreConnection

public VoidResponse setConfigurationStoreConnection(String userId,
                                                    Connection connection)

Override the default location of the configuration documents.

Parameters:

userId - calling user.

connection - connection used to create and configure the connector that interacts with the real store.

Returns:

void response

getConfigurationStoreConnection

public ConnectionResponse getConfigurationStoreConnection(String userId)

Return the connection object for the configuration store. Null is returned if the server should use the default store.

Parameters:

userId - calling user

Returns:

connection response

clearConfigurationStoreConnection

public VoidResponse clearConfigurationStoreConnection(String userId)

Clear the connection object for the configuration store.

Parameters:

userId - calling user

Returns:

connection response