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

Class GAFRESTClient

java.lang.Object

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

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

org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.OCFRESTClient

org.odpi.openmetadata.frameworkservices.gaf.client.rest.GAFRESTClient

public class GAFRESTClient
extends OCFRESTClient

GAFRESTClient 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
GAFRESTClient(String serverName, String serverPlatformURLRoot)	Constructor for no authentication.
GAFRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Constructor for simple userId and password authentication.
GAFRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Constructor for simple userId and password authentication with audit log.
GAFRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Constructor for no authentication with audit log.

Method Summary

Modifier and Type	Method	Description
BooleanResponse	callBooleanGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a BooleanResponse object.
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.
EngineActionElementResponse	callEngineActionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EngineActionElementResponse object.
EngineActionElementsResponse	callEngineActionsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EngineActionElementsResponse object.
EngineActionElementsResponse	callEngineActionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a EngineActionElementsResponse object.
FirstGovernanceActionProcessStepResponse	callFirstGovernanceActionProcessStepGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceProcessStepResponseElementsResponse object.
GovernanceActionProcessElementsResponse	callGovernanceActionProcessElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GovernanceActionProcessElementsResponse object.
GovernanceActionProcessElementResponse	callGovernanceActionProcessGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceActionProcessElementResponse object.
GovernanceActionProcessGraphResponse	callGovernanceActionProcessGraphPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a GovernanceActionProcessGraphResponse object.
GovernanceActionProcessStepResponse	callGovernanceActionProcessStepGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceProcessStepResponseElementsResponse object.
GovernanceActionTypeResponse	callGovernanceActionTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceTypeResponseElementsResponse object.
GovernanceEngineElementResponse	callGovernanceEngineGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceEngineElementResponse object.
GovernanceEngineElementResponse	callGovernanceEnginePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GovernanceEngineElementResponse object.
GovernanceEngineElementsResponse	callGovernanceEnginesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceEngineElementsResponse object.
GovernanceActionProcessStepsResponse	callGovernanceProcessStepsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GovernanceActionProcessStepsResponse object.
GovernanceServiceElementResponse	callGovernanceServiceGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceServiceElementResponse object.
GovernanceServiceElementResponse	callGovernanceServicePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GovernanceServiceElementResponse object.
GovernanceServiceElementsResponse	callGovernanceServicesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceServiceElementsResponse object.
GovernanceActionTypesResponse	callGovernanceTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GovernanceActionTypesResponse 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.
NextGovernanceActionProcessStepsResponse	callNextGovernanceActionProcessStepsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a NextGovernanceActionProcessStepsResponse object.
RegisteredGovernanceServiceResponse	callRegisteredGovernanceServiceGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RegisteredGovernanceServiceResponse object.
RegisteredGovernanceServicesResponse	callRegisteredGovernanceServicesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RegisteredGovernanceServicesResponse 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.frameworkservices.ocf.metadatamanagement.client.OCFRESTClient

callOCFAssetGetRESTCall, callOCFAssetsGetRESTCall, callOCFAssetsPostRESTCall, callOCFConnectionGetRESTCall, callOCFTagGetRESTCall, callOCFTagListGetRESTCall, callOCFTagListPostRESTCall

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

callActorProfileGetRESTCall, callActorProfilesGetRESTCall, callActorProfilesPostRESTCall, callAnnotationGetRESTCall, callAnnotationListGetRESTCall, callAnnotationListPostRESTCall, callAnnotationPostRESTCall, callAPIGetRESTCall, callAPIOperationGetRESTCall, callAPIOperationsGetRESTCall, callAPIOperationsPostRESTCall, callAPIParameterListGetRESTCall, callAPIParameterListsGetRESTCall, callAPIParameterListsPostRESTCall, callAPIParametersGetRESTCall, callAPIsGetRESTCall, callAPIsPostRESTCall, callAppointeesPostRESTCall, callAssetElementGetRESTCall, callAssetElementsGetRESTCall, callAssetElementsPostRESTCall, callAssetRelationshipsPostRESTCall, callCertificationTypeGetRESTCall, callCertificationTypeListGetRESTCall, callCertificationTypeListPostRESTCall, callCollectionGetRESTCall, callCollectionListGetRESTCall, callCollectionListPostRESTCall, callCollectionMemberGetRESTCall, callCollectionMemberListGetRESTCall, callCommunitiesGetRESTCall, callCommunitiesPostRESTCall, callCommunityGetRESTCall, callConnectionGetRESTCall, callConnectionsGetRESTCall, callConnectionsPostRESTCall, callConnectorTypeGetRESTCall, callConnectorTypesPostRESTCall, callControlFlowPostRESTCall, callControlFlowsPostRESTCall, callCountGetRESTCall, callDatabaseColumnGetRESTCall, callDatabaseColumnsGetRESTCall, callDatabaseColumnsPostRESTCall, callDatabaseGetRESTCall, callDatabaseSchemaGetRESTCall, callDatabaseSchemasGetRESTCall, callDatabaseSchemasPostRESTCall, callDatabasesPostRESTCall, callDatabaseTableGetRESTCall, callDatabaseTablesGetRESTCall, callDatabaseTablesPostRESTCall, callDatabaseViewGetRESTCall, callDatabaseViewsGetRESTCall, callDatabaseViewsPostRESTCall, callDataContainerGetRESTCall, callDataContainersGetRESTCall, callDataContainersPostRESTCall, callDataFileGetRESTCall, callDataFilePostRESTCall, callDataFilesGetRESTCall, callDataFilesPostRESTCall, callDataFlowPostRESTCall, callDataFlowsPostRESTCall, callDigitalServiceGetRESTCall, callDigitalServicesGetRESTCall, callDigitalServicesPostRESTCall, callDiscoveryAnalysisReportListPostRESTCall, callElementHeaderPostRESTCall, callElementHeadersPostRESTCall, callElementStubGetRESTCall, callElementStubsGetRESTCall, callElementStubsPostRESTCall, callEndpointGetRESTCall, callEndpointsGetRESTCall, callEndpointsPostRESTCall, callEventTypeGetRESTCall, callEventTypesGetRESTCall, callEventTypesPostRESTCall, callExternalReferenceGetRESTCall, callExternalReferencesGetRESTCall, callExternalReferencesPostRESTCall, callFileFolderGetRESTCall, callFileFolderPostRESTCall, callFileFoldersGetRESTCall, callFileSystemGetRESTCall, callFolderGetRESTCall, callFormGetRESTCall, callFormsGetRESTCall, callFormsPostRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callITProfileGetRESTCall, callITProfileListGetRESTCall, callITProfileListPostRESTCall, callLicensesGetRESTCall, callLicenseTypeGetRESTCall, callLicenseTypeListPostRESTCall, callLicenseTypesGetRESTCall, callLineageMappingPostRESTCall, callLineageMappingsPostRESTCall, callLocationGetRESTCall, callLocationsGetRESTCall, callLocationsPostRESTCall, callMetadataElementSummariesPostRESTCall, callMetadataSourceGetRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callPersonRoleGetRESTCall, callPersonRolesGetRESTCall, callPersonRolesPostRESTCall, callProcessCallPostRESTCall, callProcessCallsPostRESTCall, callProjectGetRESTCall, callProjectsGetRESTCall, callProjectsPostRESTCall, callQueriesGetRESTCall, callQueriesPostRESTCall, callQueryGetRESTCall, callReferenceValueAssignmentDefinitionsGetRESTCall, callReferenceValueAssignmentItemsGetRESTCall, callRelatedAssetsPostRESTCall, callRelatedElementsGetRESTCall, callRelatedElementsPostRESTCall, callRelationshipPostRESTCall, callRelationshipsPostRESTCall, callReportGetRESTCall, callReportsGetRESTCall, callReportsPostRESTCall, callSchemaAttributeGetRESTCall, callSchemaAttributePostRESTCall, callSchemaAttributesGetRESTCall, callSchemaAttributesPostRESTCall, callSchemaTypeGetRESTCall, callSchemaTypePostRESTCall, callSchemaTypesPostRESTCall, callSecurityGroupGetRESTCall, callSecurityGroupPostRESTCall, callSecurityGroupsGetRESTCall, callSecurityGroupsPostRESTCall, callServerAssetUseGetRESTCall, callServerAssetUseListGetRESTCall, callServerAssetUseListPostRESTCall, callSoftwareServerCapabilitiesGetRESTCall, callSoftwareServerCapabilitiesPostRESTCall, callSoftwareServerCapabilityGetRESTCall, callStringMapGetRESTCall, callSupportedCapabilityListPostRESTCall, callSurveyReportListGetRESTCall, callTopicGetRESTCall, callTopicsGetRESTCall, callTopicsPostRESTCall, callUserIdentitiesGetRESTCall, callUserIdentitiesPostRESTCall, callUserIdentityGetRESTCall, callUserIdentityListPostRESTCall, callUserIdentityPostRESTCall, callValidValueAssignmentConsumersGetRESTCall, callValidValueAssignmentDefinitionsGetRESTCall, callValidValueGetRESTCall, callValidValueListGetRESTCall, callValidValueListPostRESTCall, callValidValueMappingsGetRESTCall, callValidValueSetsPostRESTCall, callValidValuesGetRESTCall, callValidValuesImplAssetsGetRESTCall, callValidValuesImplDefinitionsGetRESTCall, callValidValuesMappingsGetRESTCall, callValidValuesPostRESTCall, 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

GAFRESTClient

public GAFRESTClient(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 API calls.

GAFRESTClient

public GAFRESTClient(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 API calls.

GAFRESTClient

public GAFRESTClient(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 API calls.

GAFRESTClient

public GAFRESTClient(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 API calls.

Method Details

callBooleanGetRESTCall

public BooleanResponse callBooleanGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a BooleanResponse object.

Overrides:

callBooleanGetRESTCall in class FFDCRESTClient

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:

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.

callEngineActionGetRESTCall

public EngineActionElementResponse callEngineActionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a EngineActionElementResponse 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.

callEngineActionsGetRESTCall

public EngineActionElementsResponse callEngineActionsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a EngineActionElementsResponse 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.

callEngineActionsPostRESTCall

public EngineActionElementsResponse callEngineActionsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a EngineActionElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callGovernanceActionTypeGetRESTCall

public GovernanceActionTypeResponse callGovernanceActionTypeGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceTypeResponseElementsResponse 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.

callGovernanceTypesPostRESTCall

public GovernanceActionTypesResponse callGovernanceTypesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a GovernanceActionTypesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callGovernanceActionProcessStepGetRESTCall

public GovernanceActionProcessStepResponse callGovernanceActionProcessStepGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceProcessStepResponseElementsResponse 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.

callFirstGovernanceActionProcessStepGetRESTCall

public FirstGovernanceActionProcessStepResponse callFirstGovernanceActionProcessStepGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceProcessStepResponseElementsResponse 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.

callGovernanceProcessStepsPostRESTCall

public GovernanceActionProcessStepsResponse callGovernanceProcessStepsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a GovernanceActionProcessStepsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callNextGovernanceActionProcessStepsGetRESTCall

public NextGovernanceActionProcessStepsResponse callNextGovernanceActionProcessStepsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a NextGovernanceActionProcessStepsResponse 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.

callGovernanceActionProcessGetRESTCall

public GovernanceActionProcessElementResponse callGovernanceActionProcessGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceActionProcessElementResponse 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.

callGovernanceActionProcessGraphPostRESTCall

public GovernanceActionProcessGraphResponse callGovernanceActionProcessGraphPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceActionProcessGraphResponse 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.

callGovernanceActionProcessElementsPostRESTCall

public GovernanceActionProcessElementsResponse callGovernanceActionProcessElementsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a GovernanceActionProcessElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callGovernanceEnginePostRESTCall

public GovernanceEngineElementResponse callGovernanceEnginePostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a GovernanceEngineElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callGovernanceEngineGetRESTCall

public GovernanceEngineElementResponse callGovernanceEngineGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceEngineElementResponse 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.

callGovernanceEnginesGetRESTCall

public GovernanceEngineElementsResponse callGovernanceEnginesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceEngineElementsResponse 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.

callGovernanceServicePostRESTCall

public GovernanceServiceElementResponse callGovernanceServicePostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a GovernanceServiceElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callGovernanceServiceGetRESTCall

public GovernanceServiceElementResponse callGovernanceServiceGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceServiceElementResponse 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.

callGovernanceServicesGetRESTCall

public GovernanceServiceElementsResponse callGovernanceServicesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceServiceElementsResponse 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.

callRegisteredGovernanceServiceGetRESTCall

public RegisteredGovernanceServiceResponse callRegisteredGovernanceServiceGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a RegisteredGovernanceServiceResponse 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.

callRegisteredGovernanceServicesGetRESTCall

public RegisteredGovernanceServicesResponse callRegisteredGovernanceServicesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a RegisteredGovernanceServicesResponse 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.