Administration services¶

OMAGServerPlatformConfigurationClient platformConfigurationClient = new OMAGServerPlatformConfigurationClient(clientUserId, platformURLRoot);

Connection configurationStoreConnection = platformConfigurationClient.getConfigurationStoreConnection();
Connection platformSecurityConnection   = platformConfigurationClient.getPlatformSecurityConnection();

/**
 * Set up the defaults that are used whenever a topic is configured for a server.
 * Check that the eventBusURLRoot is correct for your Kafka installation.
 *
 * @param client client responsible for the server configuration
 *
 * @throws OMAGNotAuthorizedException the supplied userId is not authorized to issue this command.
 * @throws OMAGInvalidParameterException invalid parameter.
 * @throws OMAGConfigurationErrorException unusual state in the admin server.
 */
private void setEventBus(OMAGServerConfigurationClient client) throws OMAGNotAuthorizedException,
                                                                      OMAGInvalidParameterException,
                                                                      OMAGConfigurationErrorException
{
    if (eventBusURLRoot != null)
    {
        Map<String, Object> configurationProperties = new HashMap<>();
        Map<String, Object> producerProperties      = new HashMap<>();
        Map<String, Object> consumerProperties      = new HashMap<>();

        producerProperties.put("bootstrap.servers", eventBusURLRoot);
        consumerProperties.put("bootstrap.servers", eventBusURLRoot);
        consumerProperties.put("auto.commit.interval.ms", "1");

        configurationProperties.put("producer", producerProperties);
        configurationProperties.put("consumer", consumerProperties);

        client.setEventBus(null, // use default - kafka
                           null, // use default - egeria.omag
                           configurationProperties);
    }
}


/**
 * Configure a security connector.  The default connector uses the Coco Pharmaceutical users and rules.
 * Change the serverSecurityConnectorProviderClassName to null to turn off security in new servers.
 * Alternatively change the class name for a different connector.
 *
 * @param client client responsible for the server configuration
 *
 * @throws OMAGNotAuthorizedException the supplied userId is not authorized to issue this command.
 * @throws OMAGInvalidParameterException invalid parameter.
 * @throws OMAGConfigurationErrorException unusual state in the admin server.
 */
private void setSecuritySecurityConnector(OMAGServerConfigurationClient client) throws OMAGNotAuthorizedException,
                                                                                       OMAGInvalidParameterException,
                                                                                       OMAGConfigurationErrorException
{
    if (serverSecurityConnectorProviderClassName != null)
    {
        Connection    connection    = new Connection();
        ConnectorType connectorType = new ConnectorType();

        connectorType.setConnectorProviderClassName(serverSecurityConnectorProviderClassName);
        connection.setConnectorType(connectorType);

        client.setServerSecurityConnection(connection);
    }
}


/**
 * Create a new metadata access store OMAG server with an in-memory repository.
 * If the event bus is not set up, the access services are configured without in and out topics.
 *
 * @param serverName name of the new server
 */
private void createMetadataStore(String serverName)
{
    try
    {
        System.out.println("Configuring metadata store: " + serverName);

        MetadataAccessStoreConfigurationClient client = new MetadataAccessStoreConfigurationClient(clientUserId, serverName, platformURLRoot);

        client.setServerDescription("Metadata Access Store called " + serverName + " running on platform " + platformURLRoot);
        client.setServerUserId(serverName + "npa");
        client.setServerType(null); // Let the admin service set up the server types
        client.setOrganizationName(organizationName);
        client.setMaxPageSize(maxPageSize);

        this.setSecuritySecurityConnector(client);
        client.setDefaultAuditLog();

        client.setServerURLRoot(platformURLRoot);
        this.setEventBus(client);

        client.setInMemLocalRepository();
        client.setLocalMetadataCollectionName(serverName + "'s metadata collection");

        List<String> assetLookupZones = new ArrayList<>();

        assetLookupZones.add("data-lake");
        assetLookupZones.add("personal-files");

        List<String> personalFilesZone = new ArrayList<>();

        assetLookupZones.add("personal-files");

        List<String> maintenanceZones = new ArrayList<>();

        maintenanceZones.add("quarantine");
        maintenanceZones.add("trash-can");
        maintenanceZones.add("data-lake");

        List<String> newDataZone = new ArrayList<>();

        newDataZone.add("quarantine");

        Map<String, Object> accessServiceOptions = new HashMap<>();


        if (eventBusURLRoot != null)
        {
            accessServiceOptions.put("SupportedZones", assetLookupZones);
            accessServiceOptions.put("DefaultZones", personalFilesZone);

            client.configureAccessService("asset-consumer", accessServiceOptions);

            accessServiceOptions.put("KarmaPointPlateau", 10);

            client.configureAccessService("community-profile", accessServiceOptions);

            accessServiceOptions = new HashMap<>();
            accessServiceOptions.put("SupportedZones", maintenanceZones);
            accessServiceOptions.put("DefaultZones", newDataZone);
            accessServiceOptions.put("PublishZones", assetLookupZones);

            client.configureAccessService("asset-owner", accessServiceOptions);
            client.configureAccessService("data-manager", accessServiceOptions);
            client.configureAccessService("asset-manager", accessServiceOptions);
            client.configureAccessService("governance-program", accessServiceOptions);
            client.configureAccessService("digital-architecture", accessServiceOptions);
        }
        else // configure the access services without in and out topics
        {
            accessServiceOptions.put("SupportedZones", assetLookupZones);
            accessServiceOptions.put("DefaultZones", personalFilesZone);

            client.configureAccessServiceNoTopics("asset-consumer", accessServiceOptions);

            accessServiceOptions.put("KarmaPointPlateau", 10);

            client.configureAccessServiceNoTopics("community-profile", accessServiceOptions);

            accessServiceOptions = new HashMap<>();
            accessServiceOptions.put("SupportedZones", maintenanceZones);
            accessServiceOptions.put("DefaultZones", newDataZone);
            accessServiceOptions.put("PublishZones", assetLookupZones);

            client.configureAccessServiceNoTopics("asset-owner", accessServiceOptions);
            client.configureAccessServiceNoTopics("data-manager", accessServiceOptions);
            client.configureAccessServiceNoTopics("asset-manager", accessServiceOptions);
            client.configureAccessServiceNoTopics("governance-program", accessServiceOptions);
            client.configureAccessServiceNoTopics("digital-architecture", accessServiceOptions);
        }
    }
    catch (Exception error)
    {
        System.out.println("There was an " + error.getClass().getName() + " exception when calling the platform.  Error message is: " + error.getMessage());
    }
}

ConfigurationManagementClient configurationManagementClient = new ConfigurationManagementClient(clientUserId, platformURLRoot);

Set<OMAGServerConfig> configuredServers = configurationManagementClient.getAllServerConfigurations();

/**
 * Start the named server on the platform.  This will fail if the platform is not running,
 * or if the user is not authorized to issue operations requests to the platform or if the
 * server is not configured.
 *
 * @param serverName string name
 */
private void startServer(String serverName)
{
    try
    {
        OMAGServerOperationsClient client = new OMAGServerOperationsClient(clientUserId, serverName, platformURLRoot);

        System.out.println("Starting " + serverName + " ...");
        System.out.println(client.activateWithStoredConfig());
    }
    catch (Exception error)
    {
        System.out.println("There was an " + error.getClass().getName() + " exception when calling the platform.  Error message is: " + error.getMessage());
    }
}


/**
 * Stop the requested server.    This will fail if the server or the platform is not running,
 * or if the user is not authorized to issue operations requests to the platform.
 *
 * @param serverName string name
 */
private void stopServer(String serverName)
{
    try
    {
        OMAGServerOperationsClient client = new OMAGServerOperationsClient(clientUserId, serverName, platformURLRoot);

        System.out.println("Stopping " + serverName + " ...");

        client.deactivateTemporarily();

        System.out.println(serverName + " stopped.");
    }
    catch (Exception error)
    {
        System.out.println("There was an " + error.getClass().getName() + " exception when calling the platform.  Error message is: " + error.getMessage());
    }
}