Package org.odpi.openmetadata.serveroperations.client

Class ServerOperationsClient

java.lang.Object

org.odpi.openmetadata.serveroperations.client.ServerOperationsClient

public class ServerOperationsClient
extends Object

ServerOperationsClient is the client for issuing queries about an OMAG Server

Constructor Summary

Constructors

Constructor	Description
ServerOperationsClient(String platformName, String platformRootURL)	Create a new client with no authentication embedded in the HTTP request.
ServerOperationsClient(String platformName, String platformRootURL, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
ServerOperationsClient(String platformName, String platformRootURL, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
ServerOperationsClient(String platformName, String platformRootURL, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	addOpenMetadataArchive(String userId, String serverName, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)	Add a new open metadata archive to running repository.
void	addOpenMetadataArchiveFile(String userId, String serverName, String fileName)	Add a new open metadata archive to running repository.
org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig	getActiveConfiguration(String userId, String serverName)	Return the configuration used for the current active instance of the server.
org.odpi.openmetadata.serveroperations.properties.ServerServicesStatus	getActiveServerStatus(String userId, String serverName)	Return the status of a running server (use platform services to find out if the server is running).
List<String>	getActiveServices(String userId, String serverName)	Retrieve a list of the active services on a server
org.odpi.openmetadata.serveroperations.properties.ServerStatus	getServerStatus(String userId, String serverName)	Retrieve the server status

Methods inherited from class java.lang.Object

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

Constructor Details

ServerOperationsClient

public ServerOperationsClient(String platformName,
 String platformRootURL,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

platformName - name of the platform to connect to

platformRootURL - the network address of the server running the OMAG Platform

auditLog - logging destination

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ServerOperationsClient

public ServerOperationsClient(String platformName,
 String platformRootURL)
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

platformName - name of the platform to connect to

platformRootURL - the network address of the server running the OMAS REST services

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ServerOperationsClient

public ServerOperationsClient(String platformName,
 String platformRootURL,
 String userId,
 String password,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

platformName - name of the platform to connect to

platformRootURL - the network address of the platform

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ServerOperationsClient

public ServerOperationsClient(String platformName,
 String platformRootURL,
 String userId,
 String password)
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

platformName - name of the server to connect to

platformRootURL - the network address of the platform

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

getServerStatus

public org.odpi.openmetadata.serveroperations.properties.ServerStatus getServerStatus(String userId,
 String serverName)
                                                                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the server status

Parameters:

userId - calling user

serverName - the name of the server

Returns:

The server status

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

getActiveConfiguration

public org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig getActiveConfiguration(String userId,
 String serverName)
                                                                                                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return the configuration used for the current active instance of the server. Null is returned if the server instance is not running.

Parameters:

userId - calling user

serverName - server to start

Returns:

configuration properties used to initialize the server or null if not running

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.

getActiveServerStatus

public org.odpi.openmetadata.serveroperations.properties.ServerServicesStatus getActiveServerStatus(String userId,
 String serverName)
                                                                                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return the status of a running server (use platform services to find out if the server is running).

Parameters:

userId - calling user

serverName - server to start

Returns:

status of the server

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.

getActiveServices

public List<String> getActiveServices(String userId,
 String serverName)
                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve a list of the active services on a server

Parameters:

userId - calling user

serverName - name of the server

Returns:

List of service names

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

addOpenMetadataArchiveFile

public void addOpenMetadataArchiveFile(String userId,
 String serverName,
 String fileName)
                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Add a new open metadata archive to running repository.

Parameters:

userId - calling user

serverName - server to start

fileName - name of the open metadata archive file.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.

addOpenMetadataArchive

public void addOpenMetadataArchive(String userId,
 String serverName,
 org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Add a new open metadata archive to running repository.

Parameters:

userId - calling user

serverName - server to start

connection - connection for the open metadata archive.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.