Package org.odpi.openmetadata.frameworkservices.oif.client.rest

Class OpenIntegrationRESTClient

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.frameworkservices.oif.client.rest.OpenIntegrationRESTClient

public class OpenIntegrationRESTClient
extends FFDCRESTClient

OpenIntegrationRESTClient is responsible for issuing calls to the OMAS REST APIs.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
OpenIntegrationRESTClient(String serverName, String serverPlatformURLRoot)	Constructor for no authentication.
OpenIntegrationRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Constructor for simple userId and password authentication.
OpenIntegrationRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Constructor for simple userId and password authentication with audit log.
OpenIntegrationRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Constructor for no authentication with audit log.

Method Summary

Modifier and Type	Method	Description
CatalogTargetResponse	callCatalogTargetGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a CatalogTargetResponse object.
CatalogTargetsResponse	callCatalogTargetsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a CatalogTargetsResponse object.
IntegrationConnectorElementResponse	callIntegrationConnectorGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a IntegrationConnectorElementResponse object.
IntegrationConnectorElementsResponse	callIntegrationConnectorsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a IntegrationConnectorElementsResponse object.
IntegrationGroupElementResponse	callIntegrationGroupGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a IntegrationGroupElementResponse object.
IntegrationGroupElementsResponse	callIntegrationGroupsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a IntegrationGroupElementsResponse object.
IntegrationReportResponse	callIntegrationReportGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a IntegrationReportResponse object.
IntegrationReportsResponse	callIntegrationReportsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a IntegrationReportsResponse object.
RegisteredIntegrationConnectorResponse	callRegisteredIntegrationConnectorGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RegisteredIntegrationConnectorResponse object.
RegisteredIntegrationConnectorsResponse	callRegisteredIntegrationConnectorsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RegisteredIntegrationConnectorsResponse object.

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

callBooleanGetRESTCall, callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Details

OpenIntegrationRESTClient

public OpenIntegrationRESTClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog)
                          throws InvalidParameterException

Constructor for no authentication with audit log.

Parameters:

serverName - name of the OMAG Server to call

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

auditLog - destination for log messages.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST APIs.

OpenIntegrationRESTClient

public OpenIntegrationRESTClient(String serverName,
 String serverPlatformURLRoot)
                          throws InvalidParameterException

Constructor for no authentication.

Parameters:

serverName - name of the OMAG Server to call

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

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST APIs.

OpenIntegrationRESTClient

public OpenIntegrationRESTClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog)
                          throws InvalidParameterException

Constructor for simple userId and password authentication with audit log.

Parameters:

serverName - name of the OMAG Server to call

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

userId - user id for the HTTP request

password - password for the HTTP request

auditLog - destination for log messages.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST APIs.

OpenIntegrationRESTClient

public OpenIntegrationRESTClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password)
                          throws InvalidParameterException

Constructor for simple userId and password authentication.

Parameters:

serverName - name of the OMAG Server to call

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

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST APIs.

Method Details

callIntegrationReportGetRESTCall

public IntegrationReportResponse callIntegrationReportGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a IntegrationReportResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callIntegrationReportsGetRESTCall

public IntegrationReportsResponse callIntegrationReportsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a IntegrationReportsResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callIntegrationGroupGetRESTCall

public IntegrationGroupElementResponse callIntegrationGroupGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a IntegrationGroupElementResponse object.

Parameters:

methodName - name of the method being called

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

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callIntegrationGroupsGetRESTCall

public IntegrationGroupElementsResponse callIntegrationGroupsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a IntegrationGroupElementsResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callIntegrationConnectorGetRESTCall

public IntegrationConnectorElementResponse callIntegrationConnectorGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a IntegrationConnectorElementResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callIntegrationConnectorsGetRESTCall

public IntegrationConnectorElementsResponse callIntegrationConnectorsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a IntegrationConnectorElementsResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callRegisteredIntegrationConnectorGetRESTCall

public RegisteredIntegrationConnectorResponse callRegisteredIntegrationConnectorGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a RegisteredIntegrationConnectorResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callRegisteredIntegrationConnectorsGetRESTCall

public RegisteredIntegrationConnectorsResponse callRegisteredIntegrationConnectorsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a RegisteredIntegrationConnectorsResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callCatalogTargetGetRESTCall

public CatalogTargetResponse callCatalogTargetGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a CatalogTargetResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callCatalogTargetsGetRESTCall

public CatalogTargetsResponse callCatalogTargetsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a CatalogTargetsResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.