Package org.odpi.openmetadata.adminservices.client.rest

Class AdminServicesRESTClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.rest.AdminServicesRESTClient

public class AdminServicesRESTClient
extends Object

AssetOwnerRESTClient is responsible for issuing calls to the Admin Services REST APIs.

Constructor Summary

Constructors

Constructor	Description
AdminServicesRESTClient(String serverName, String serverPlatformURLRoot)	Constructor for no authentication.
AdminServicesRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Constructor for simple userId and password authentication.

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.adminservices.rest.AccessServicesResponse	callAccessServicesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a AccessServicesResponse object.
org.odpi.openmetadata.adminservices.rest.BasicServerPropertiesResponse	callBasicServerPropertiesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a BasicServerPropertiesResponse object.
org.odpi.openmetadata.adminservices.rest.ConnectionResponse	callConnectionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ConnectionResponse object.
org.odpi.openmetadata.adminservices.rest.DedicatedTopicListResponse	callDedicatedTopicListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DedicatedTopicListResponse object.
org.odpi.openmetadata.adminservices.rest.EngineHostServicesResponse	callEngineHostServicesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EngineHostServicesResponse object.
org.odpi.openmetadata.adminservices.rest.EngineServiceConfigResponse	callEngineServiceConfigGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EngineServiceConfigResponse object.
org.odpi.openmetadata.adminservices.rest.OMAGServerConfigsResponse	callGetAllServerConfigurationsRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a OMAGServerConfigsResponse object.
org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse	callGUIDGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GUIDResponse object.
org.odpi.openmetadata.adminservices.rest.IntegrationGroupsResponse	callIntegrationGroupsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a IntegrationServicesResponse object.
org.odpi.openmetadata.adminservices.rest.IntegrationServiceConfigResponse	callIntegrationServiceConfigGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a IntegrationServiceConfigResponse object.
org.odpi.openmetadata.adminservices.rest.IntegrationServicesResponse	callIntegrationServicesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a IntegrationServicesResponse object.
org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse	callOMAGServerConfigGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a OMAGServerConfigResponse object.
org.odpi.openmetadata.adminservices.rest.OMAGServerStatusResponse	callOMAGServerStatusGetRESTCall(String methodName, String urlTemplate, Object... params)	Deprecated.
org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse	callRegisteredOMAGServicesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RegisteredOMAGServicesResponse object.
org.odpi.openmetadata.adminservices.rest.ServerTypeClassificationResponse	callServerClassificationGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ServerTypeClassificationResponse object.
org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse	callStringGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a StringResponse object.
org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse	callStringMapGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a StringMapResponse object.
org.odpi.openmetadata.adminservices.rest.SuccessMessageResponse	callSuccessMessagePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a SuccessMessageResponse object.
org.odpi.openmetadata.adminservices.rest.ViewServicesResponse	callViewServicesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ViewServicesResponse object.
org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse	callVoidDeleteRESTCall(String methodName, String urlTemplate, Object... params)	Issue a DELETE REST call that returns a VoidResponse object.
org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse	callVoidPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a VoidResponse object.

Methods inherited from class java.lang.Object

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

Constructor Details

AdminServicesRESTClient

public AdminServicesRESTClient(String serverName,
 String serverPlatformURLRoot)
                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException

Constructor for no authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

AdminServicesRESTClient

public AdminServicesRESTClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password)
                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException

Constructor for simple userId and password authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

callVoidPostRESTCall

public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse callVoidPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                                 throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a POST REST call that returns a VoidResponse object. This is typically a create

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

requestBody - request body for the request.

params - a list of parameters that are slotted into the url template.

Returns:

VoidResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callVoidDeleteRESTCall

public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse callVoidDeleteRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                   throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a DELETE REST call that returns a VoidResponse object. This is typically a delete

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

VoidResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callSuccessMessagePostRESTCall

public org.odpi.openmetadata.adminservices.rest.SuccessMessageResponse callSuccessMessagePostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                                               throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a POST REST call that returns a SuccessMessageResponse object. This is typically a server start.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

requestBody - request body for the request.

params - a list of parameters that are slotted into the url template.

Returns:

SuccessMessageResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callStringGetRESTCall

public org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse callStringGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a StringResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

StringResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callBasicServerPropertiesGetRESTCall

public org.odpi.openmetadata.adminservices.rest.BasicServerPropertiesResponse callBasicServerPropertiesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                            throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a BasicServerPropertiesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

BasicServerPropertiesResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callDedicatedTopicListGetRESTCall

public org.odpi.openmetadata.adminservices.rest.DedicatedTopicListResponse callDedicatedTopicListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                      throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a DedicatedTopicListResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

DedicatedTopicListResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callGUIDGetRESTCall

public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse callGUIDGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a GUIDResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

GUIDResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callStringMapGetRESTCall

public org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse callStringMapGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a StringMapResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

StringMapResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callOMAGServerConfigGetRESTCall

public org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse callOMAGServerConfigGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                  throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a OMAGServerConfigResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

OMAGServerConfigResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callGetAllServerConfigurationsRESTCall

public org.odpi.openmetadata.adminservices.rest.OMAGServerConfigsResponse callGetAllServerConfigurationsRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a OMAGServerConfigsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

OMAGServerConfigResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callOMAGServerStatusGetRESTCall

@Deprecated
public org.odpi.openmetadata.adminservices.rest.OMAGServerStatusResponse callOMAGServerStatusGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                  throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Deprecated.

Issue a GET REST call that returns a OMAGServerStatusResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

OMAGServerStatusResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callConnectionGetRESTCall

public org.odpi.openmetadata.adminservices.rest.ConnectionResponse callConnectionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                      throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a ConnectionResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

ConnectionResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callServerClassificationGetRESTCall

public org.odpi.openmetadata.adminservices.rest.ServerTypeClassificationResponse callServerClassificationGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                              throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a ServerTypeClassificationResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

ServerTypeClassificationResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callRegisteredOMAGServicesGetRESTCall

public org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse callRegisteredOMAGServicesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a RegisteredOMAGServicesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

RegisteredOMAGServicesResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callAccessServicesGetRESTCall

public org.odpi.openmetadata.adminservices.rest.AccessServicesResponse callAccessServicesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                              throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a AccessServicesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

AccessServicesResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callEngineHostServicesGetRESTCall

public org.odpi.openmetadata.adminservices.rest.EngineHostServicesResponse callEngineHostServicesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                      throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a EngineHostServicesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

EngineHostServicesResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callEngineServiceConfigGetRESTCall

public org.odpi.openmetadata.adminservices.rest.EngineServiceConfigResponse callEngineServiceConfigGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a EngineServiceConfigResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

EngineServiceConfigResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callIntegrationServicesGetRESTCall

public org.odpi.openmetadata.adminservices.rest.IntegrationServicesResponse callIntegrationServicesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a IntegrationServicesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

IntegrationServicesResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callIntegrationServiceConfigGetRESTCall

public org.odpi.openmetadata.adminservices.rest.IntegrationServiceConfigResponse callIntegrationServiceConfigGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                                  throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a IntegrationServiceConfigResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

IntegrationServiceConfigResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callIntegrationGroupsGetRESTCall

public org.odpi.openmetadata.adminservices.rest.IntegrationGroupsResponse callIntegrationGroupsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a IntegrationServicesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

IntegrationServicesResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

callViewServicesGetRESTCall

public org.odpi.openmetadata.adminservices.rest.ViewServicesResponse callViewServicesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Issue a GET REST call that returns a ViewServicesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API call with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

ViewServicesResponse

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.