org.odpi.openmetadata.adminservices.client.rest.AdminServicesRESTClient 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
Show all versions of admin-services-client Show documentation
Administration Services Client
/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.adminservices.client.rest;
import org.odpi.openmetadata.adapters.connectors.restclients.RESTClientConnector;
import org.odpi.openmetadata.adapters.connectors.restclients.factory.RESTClientFactory;
import org.odpi.openmetadata.adminservices.ffdc.OMAGAdminErrorCode;
import org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException;
import org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException;
import org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException;
import org.odpi.openmetadata.adminservices.rest.*;
import org.odpi.openmetadata.adminservices.rest.ConnectionResponse;
import org.odpi.openmetadata.commonservices.ffdc.rest.*;
/**
* AssetOwnerRESTClient is responsible for issuing calls to the Admin Services REST APIs.
*/
public class AdminServicesRESTClient
{
private final String serverPlatformURLRoot; /* Initialized in constructor */
private final AdminClientRESTExceptionHandler exceptionHandler = new AdminClientRESTExceptionHandler();
private final RESTClientConnector clientConnector; /* Initialized in constructor */
/**
* Constructor for no authentication.
*
* @param serverName name of the OMAG Server to call
* @param serverPlatformURLRoot URL root of the server platform where the OMAG Server is running.
* @throws OMAGInvalidParameterException there is a problem creating the client-side components to issue any
* REST API calls.
*/
public AdminServicesRESTClient(String serverName,
String serverPlatformURLRoot) throws OMAGInvalidParameterException
{
final String methodName = "RESTClient(no authentication)";
this.serverPlatformURLRoot = serverPlatformURLRoot;
RESTClientFactory factory = new RESTClientFactory(serverName, serverPlatformURLRoot);
try
{
this.clientConnector = factory.getClientConnector();
}
catch (Exception error)
{
throw new OMAGInvalidParameterException(OMAGAdminErrorCode.NULL_LOCAL_SERVER_NAME.getMessageDefinition(serverName, error.getMessage()),
this.getClass().getName(),
methodName,
error);
}
}
/**
* Constructor for simple userId and password authentication.
*
* @param serverName name of the OMAG Server to call
* @param serverPlatformURLRoot URL root of the server platform where the OMAG Server is running.
* @param userId user id for the HTTP request
* @param password password for the HTTP request
* @throws OMAGInvalidParameterException there is a problem creating the client-side components to issue any
* REST API calls.
*/
public AdminServicesRESTClient(String serverName,
String serverPlatformURLRoot,
String userId,
String password) throws OMAGInvalidParameterException
{
final String methodName = "RESTClient(userId and password)";
this.serverPlatformURLRoot = serverPlatformURLRoot;
RESTClientFactory factory = new RESTClientFactory(serverName,
serverPlatformURLRoot,
userId,
password,
null,
null);
try
{
this.clientConnector = factory.getClientConnector();
}
catch (Exception error)
{
throw new OMAGInvalidParameterException(OMAGAdminErrorCode.NULL_LOCAL_SERVER_NAME.getMessageDefinition(serverName, error.getMessage()),
this.getClass().getName(),
methodName,
error);
}
}
/**
* Issue a POST REST call that returns a VoidResponse object. This is typically a create
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param requestBody request body for the request.
* @param params a list of parameters that are slotted into the url template.
*
* @return VoidResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public VoidResponse callVoidPostRESTCall(String methodName,
String urlTemplate,
Object requestBody,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
VoidResponse restResult = this.callPostRESTCall(methodName,
VoidResponse.class,
urlTemplate,
requestBody,
params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a DELETE REST call that returns a VoidResponse object. This is typically a delete
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return VoidResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public VoidResponse callVoidDeleteRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
VoidResponse restResult = this.callDeleteRESTCall(methodName,
VoidResponse.class,
urlTemplate,
null,
params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a POST REST call that returns a SuccessMessageResponse object. This is typically a server start.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param requestBody request body for the request.
* @param params a list of parameters that are slotted into the url template.
*
* @return SuccessMessageResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public SuccessMessageResponse callSuccessMessagePostRESTCall(String methodName,
String urlTemplate,
Object requestBody,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
SuccessMessageResponse restResult = this.callPostRESTCall(methodName,
SuccessMessageResponse.class,
urlTemplate,
requestBody,
params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a StringResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return StringResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public StringResponse callStringGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
StringResponse restResult = this.callGetRESTCall(methodName, StringResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a BasicServerPropertiesResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return BasicServerPropertiesResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public BasicServerPropertiesResponse callBasicServerPropertiesGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
BasicServerPropertiesResponse restResult = this.callGetRESTCall(methodName, BasicServerPropertiesResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a DedicatedTopicListResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return DedicatedTopicListResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public DedicatedTopicListResponse callDedicatedTopicListGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
DedicatedTopicListResponse restResult = this.callGetRESTCall(methodName, DedicatedTopicListResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a GUIDResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return GUIDResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public GUIDResponse callGUIDGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
GUIDResponse restResult = this.callGetRESTCall(methodName, GUIDResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a StringMapResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return StringMapResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public StringMapResponse callStringMapGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
StringMapResponse restResult = this.callGetRESTCall(methodName, StringMapResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a OMAGServerConfigResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return OMAGServerConfigResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public OMAGServerConfigResponse callOMAGServerConfigGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
OMAGServerConfigResponse restResult = this.callGetRESTCall(methodName, OMAGServerConfigResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a OMAGServerConfigsResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return OMAGServerConfigResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public OMAGServerConfigsResponse callGetAllServerConfigurationsRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
OMAGServerConfigsResponse restResult = this.callGetRESTCall(methodName, OMAGServerConfigsResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a OMAGServerStatusResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return OMAGServerStatusResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
@Deprecated
public OMAGServerStatusResponse callOMAGServerStatusGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
OMAGServerStatusResponse restResult = this.callGetRESTCall(methodName, OMAGServerStatusResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a OCFConnectionResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return OCFConnectionResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public ConnectionResponse callConnectionGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
ConnectionResponse restResult = this.callGetRESTCall(methodName, ConnectionResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a ServerTypeClassificationResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return ServerTypeClassificationResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public ServerTypeClassificationResponse callServerClassificationGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
ServerTypeClassificationResponse restResult = this.callGetRESTCall(methodName, ServerTypeClassificationResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a RegisteredOMAGServicesResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return RegisteredOMAGServicesResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public RegisteredOMAGServicesResponse callRegisteredOMAGServicesGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
RegisteredOMAGServicesResponse restResult = this.callGetRESTCall(methodName, RegisteredOMAGServicesResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a AccessServicesResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return AccessServicesResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public AccessServicesResponse callAccessServicesGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
AccessServicesResponse restResult = this.callGetRESTCall(methodName, AccessServicesResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a EngineHostServicesResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return EngineHostServicesResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public EngineHostServicesResponse callEngineHostServicesGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
EngineHostServicesResponse restResult = this.callGetRESTCall(methodName, EngineHostServicesResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a EngineServiceConfigResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return EngineServiceConfigResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public EngineServiceConfigResponse callEngineServiceConfigGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
EngineServiceConfigResponse restResult = this.callGetRESTCall(methodName, EngineServiceConfigResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a IntegrationServicesResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return IntegrationServicesResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public IntegrationServicesResponse callIntegrationServicesGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
IntegrationServicesResponse restResult = this.callGetRESTCall(methodName, IntegrationServicesResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a IntegrationServiceConfigResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return IntegrationServiceConfigResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public IntegrationServiceConfigResponse callIntegrationServiceConfigGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
IntegrationServiceConfigResponse restResult = this.callGetRESTCall(methodName, IntegrationServiceConfigResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a IntegrationServicesResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return IntegrationServicesResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public IntegrationGroupsResponse callIntegrationGroupsGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
IntegrationGroupsResponse restResult = this.callGetRESTCall(methodName, IntegrationGroupsResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a ViewServicesResponse object.
*
* @param methodName name of the method being called.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return ViewServicesResponse
* @throws OMAGInvalidParameterException one of the parameters is invalid.
* @throws OMAGNotAuthorizedException the user is not authorized to make this request.
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
public ViewServicesResponse callViewServicesGetRESTCall(String methodName,
String urlTemplate,
Object... params) throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
OMAGConfigurationErrorException
{
ViewServicesResponse restResult = this.callGetRESTCall(methodName, ViewServicesResponse.class, urlTemplate, params);
exceptionHandler.detectAndThrowAdminExceptions(restResult);
return restResult;
}
/**
* Issue a GET REST call that returns a response object.
*
* @param return type
* @param methodName name of the method being called.
* @param returnClass class of the response object.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
*
* @return response object
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
protected T callGetRESTCallNoParams(String methodName,
Class returnClass,
String urlTemplate) throws OMAGConfigurationErrorException
{
try
{
return clientConnector.callGetRESTCall(methodName, returnClass, urlTemplate);
}
catch (Exception error)
{
exceptionHandler.logRESTCallException(serverPlatformURLRoot, methodName, error);
}
return null;
}
/**
* Issue a GET REST call that returns a response object.
*
* @param return type
* @param methodName name of the method being called.
* @param returnClass class of the response object.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param params a list of parameters that are slotted into the url template.
*
* @return response object
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
protected T callGetRESTCall(String methodName,
Class returnClass,
String urlTemplate,
Object... params) throws OMAGConfigurationErrorException
{
try
{
return clientConnector.callGetRESTCall(methodName, returnClass, urlTemplate, params);
}
catch (Exception error)
{
exceptionHandler.logRESTCallException(serverPlatformURLRoot, methodName, error);
}
return null;
}
/**
* Issue a POST REST call that returns a response object. This is typically a create, update, or find with
* complex parameters.
*
* @param return type
* @param methodName name of the method being called.
* @param returnClass class of the response object.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param requestBody request body for the request.
*
* @return response object
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
protected T callPostRESTCallNoParams(String methodName,
Class returnClass,
String urlTemplate,
Object requestBody) throws OMAGConfigurationErrorException
{
try
{
return clientConnector.callPostRESTCallNoParams(methodName, returnClass, urlTemplate, requestBody);
}
catch (Exception error)
{
exceptionHandler.logRESTCallException(serverPlatformURLRoot, methodName, error);
}
return null;
}
/**
* Issue a POST REST call that returns a response object. This is typically a create, update, or find with
* complex parameters.
*
* @param return type
* @param methodName name of the method being called.
* @param returnClass class of the response object.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param requestBody request body for the request.
* @param params a list of parameters that are slotted into the url template.
*
* @return response object
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
protected T callPostRESTCall(String methodName,
Class returnClass,
String urlTemplate,
Object requestBody,
Object... params) throws OMAGConfigurationErrorException
{
try
{
return clientConnector.callPostRESTCall(methodName, returnClass, urlTemplate, requestBody, params);
}
catch (Exception error)
{
exceptionHandler.logRESTCallException(serverPlatformURLRoot, methodName, error);
}
return null;
}
/**
* Issue a DELETE REST call that returns a response object.
*
* @param return type
* @param methodName name of the method being called.
* @param returnClass class of the response object.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param requestBody request body for the request.
*
* @return response object
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
protected T callDeleteRESTCallNoParams(String methodName,
Class returnClass,
String urlTemplate,
Object requestBody) throws OMAGConfigurationErrorException
{
try
{
return clientConnector.callDeleteRESTCallNoParams(methodName, returnClass, urlTemplate, requestBody);
}
catch (Exception error)
{
exceptionHandler.logRESTCallException(serverPlatformURLRoot, methodName, error);
}
return null;
}
/**
* Issue a DELETE REST call that returns a response object.
*
* @param return type
* @param methodName name of the method being called.
* @param returnClass class of the response object.
* @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
* @param requestBody request body for the request.
* @param params a list of parameters that are slotted into the url template.
*
* @return response object
* @throws OMAGConfigurationErrorException something went wrong with the REST call stack.
*/
protected T callDeleteRESTCall(String methodName,
Class returnClass,
String urlTemplate,
Object requestBody,
Object... params) throws OMAGConfigurationErrorException
{
try
{
return clientConnector.callDeleteRESTCall(methodName, returnClass, urlTemplate, requestBody, params);
}
catch (Exception error)
{
exceptionHandler.logRESTCallException(serverPlatformURLRoot, methodName, error);
}
return null;
}
}