Package org.odpi.openmetadata.accessservices.assetconsumer.client.rest

Class AssetConsumerRESTClient

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.accessservices.assetconsumer.client.rest.AssetConsumerRESTClient

public class AssetConsumerRESTClient
extends OCFRESTClient

AssetConsumerRESTClient is responsible for issuing calls to the OMAG REST APIs.

Field Summary

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

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AssetGraphResponse	callAssetGraphGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns an AssetGraphResponse object.
AssetLineageGraphResponse	callAssetLineageGraphPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns an AssetLineageGraphResponse object.
AssetSearchMatchesListResponse	callAssetSearchMatchesListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a AssetSearchMatchesListResponse object.
MeaningResponse	callGlossaryTermGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a MeaningResponse object.
MeaningsResponse	callGlossaryTermListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a MeaningsResponse object.
InformalTagResponse	callInformalTagGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a InformalTagResponse object.
InformalTagsResponse	callInformalTagListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a InformalTagsResponse 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, callBooleanGetRESTCall, 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

AssetConsumerRESTClient

public AssetConsumerRESTClient(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 platform 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.

AssetConsumerRESTClient

public AssetConsumerRESTClient(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 platform where the OMAG Server is running.

Throws:

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

AssetConsumerRESTClient

public AssetConsumerRESTClient(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 platform 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.

AssetConsumerRESTClient

public AssetConsumerRESTClient(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 platform 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

callGlossaryTermGetRESTCall

public MeaningResponse callGlossaryTermGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a MeaningResponse 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:

MeaningResponse

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.

callGlossaryTermListPostRESTCall

public MeaningsResponse callGlossaryTermListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

requestBody - request body describing the value to search for

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

Returns:

MeaningsResponse

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.

callAssetGraphGetRESTCall

public AssetGraphResponse callAssetGraphGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns an AssetGraphResponse 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:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callAssetLineageGraphPostRESTCall

public AssetLineageGraphResponse callAssetLineageGraphPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns an AssetLineageGraphResponse 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:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callAssetSearchMatchesListPostRESTCall

public AssetSearchMatchesListResponse callAssetSearchMatchesListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

requestBody - request body for the REST API call

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 - something went wrong with the REST call stack.

callInformalTagGetRESTCall

public InformalTagResponse callInformalTagGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a InformalTagResponse 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:

InformalTagResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callInformalTagListPostRESTCall

public InformalTagsResponse callInformalTagListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

requestBody - request body for the REST API call

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

Returns:

InformalTagsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.