org.odpi.openmetadata.adminservices.client.GovernanceServerConfigurationClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of admin-services-client Show documentation

Administration Services Client

There is a newer version: 5.0

Show newest version

/* SPDX-License-Identifier: Apache 2.0 */
/* Copyright Contributors to the ODPi Egeria project. */

package org.odpi.openmetadata.adminservices.client;

import org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException;

/**
 * GovernanceServerConfigurationClient provides the common configuration for all types of governance server.
 * It is abstract because it is extended by the concrete types of governance server.
 */
public class GovernanceServerConfigurationClient extends OMAGServerConfigurationClient
{
    /**
     * Create a new client with no authentication embedded in the HTTP request.
     *
     * @param adminUserId           administrator's (end user's) userId to associate with calls.
     * @param serverName            name of the server to connect to
     * @param serverPlatformRootURL the network address of the server running the admin services
     * @throws OMAGInvalidParameterException there is a problem creating the client-side components to issue any
     *                                       REST API calls.
     */
    public GovernanceServerConfigurationClient(String adminUserId,
                                               String serverName,
                                               String serverPlatformRootURL) throws OMAGInvalidParameterException
    {
        super(adminUserId, serverName, serverPlatformRootURL);
    }


    /**
     * Create a new client that passes a connection userId and password in each HTTP request.  This is the
     * userId/password of the calling server.  The end user's userId is passed as the admin userId.
     *
     * @param adminUserId           administrator's (end user's) userId to associate with calls.
     * @param serverName            name of the server to connect to
     * @param serverPlatformRootURL the network address of the server running the admin services
     * @param connectionUserId      caller's system userId embedded in all HTTP requests
     * @param connectionPassword    caller's system password embedded in all HTTP requests
     * @throws OMAGInvalidParameterException there is a problem creating the client-side components to issue any
     *                                       REST API calls.
     */
    public GovernanceServerConfigurationClient(String adminUserId,
                                               String serverName,
                                               String serverPlatformRootURL,
                                               String connectionUserId,
                                               String connectionPassword) throws OMAGInvalidParameterException
    {
        super(adminUserId, serverName, serverPlatformRootURL, connectionUserId, connectionPassword);
    }
}