org.odpi.openmetadata.accessservices.assetowner.client.rest

Class AssetOwnerRESTClient

java.lang.Object

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

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

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

org.odpi.openmetadata.accessservices.assetowner.client.rest.AssetOwnerRESTClient

public class AssetOwnerRESTClient
extends OCFRESTClient

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

Method Summary

Modifier and Type	Method and Description
AnnotationResponse	callAnnotationGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns an AnnotationResponse object.
AnnotationListResponse	callAnnotationListGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns an AnnotationListResponse object.
AnnotationListResponse	callAnnotationListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns an AnnotationResponse object.
AnnotationResponse	callAnnotationPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns an AnnotationResponse object.
AssetElementResponse	callAssetElementGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns an AssetElementResponse object.
AssetElementsResponse	callAssetElementsGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a AssetElementsResponse object.
AssetElementsResponse	callAssetElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a AssetElementsResponse object.
DiscoveryAnalysisReportListResponse	callDiscoveryAnalysisReportListGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a DiscoveryAnalysisReportListResponse object.
DiscoveryAnalysisReportListResponse	callDiscoveryAnalysisReportListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a DiscoveryAnalysisReportListResponse object.
FileSystemResponse	callFileSystemGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a FileSystemResponse object.
FolderResponse	callFolderGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a FolderResponse object.
ValidValueResponse	callValidValueGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ValidValuesResponse object.
ValidValuesResponse	callValidValuesGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ValidValuesResponse object.
ValidValuesResponse	callValidValuesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ValidValuesResponse object.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient

callAssetGetRESTCall, callAssetsGetRESTCall, callAssetsPostRESTCall, callConnectionGetRESTCall, callSchemaTypeGetRESTCall, callTagGetRESTCall, callTagListGetRESTCall, callTagListPostRESTCall

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

callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, 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 Detail

AssetOwnerRESTClient

public AssetOwnerRESTClient(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.

AssetOwnerRESTClient

public AssetOwnerRESTClient(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.

AssetOwnerRESTClient

public AssetOwnerRESTClient(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.

AssetOwnerRESTClient

public AssetOwnerRESTClient(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 Detail

callFileSystemGetRESTCall

public FileSystemResponse callFileSystemGetRESTCall(String methodName,
                                                    String urlTemplate,
                                                    Object... params)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

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

FileSystemResponse

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.

callFolderGetRESTCall

public FolderResponse callFolderGetRESTCall(String methodName,
                                            String urlTemplate,
                                            Object... params)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

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

FolderResponse

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.

callValidValueGetRESTCall

public ValidValueResponse callValidValueGetRESTCall(String methodName,
                                                    String urlTemplate,
                                                    Object... params)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

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

ValidValueResponse

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.

callValidValuesGetRESTCall

public ValidValuesResponse callValidValuesGetRESTCall(String methodName,
                                                      String urlTemplate,
                                                      Object... params)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

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

ValidValuesResponse

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.

callValidValuesPostRESTCall

public ValidValuesResponse callValidValuesPostRESTCall(String methodName,
                                                       String urlTemplate,
                                                       Object requestBody,
                                                       Object... params)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

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

ValidValuesResponse

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.

callAssetElementGetRESTCall

public AssetElementResponse callAssetElementGetRESTCall(String methodName,
                                                        String urlTemplate,
                                                        Object... params)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

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

AssetElementResponse

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.

callAssetElementsGetRESTCall

public AssetElementsResponse callAssetElementsGetRESTCall(String methodName,
                                                          String urlTemplate,
                                                          Object... params)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

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

AssetElementsResponse

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.

callAssetElementsPostRESTCall

public AssetElementsResponse callAssetElementsPostRESTCall(String methodName,
                                                           String urlTemplate,
                                                           Object requestBody,
                                                           Object... params)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Issue a POST REST call that returns a AssetElementsResponse object.

Parameters:

methodName - name of the method being called.

requestBody - request body for the REST call - contains most of the parameters

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:

AssetElementsResponse

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.

callDiscoveryAnalysisReportListGetRESTCall

public DiscoveryAnalysisReportListResponse callDiscoveryAnalysisReportListGetRESTCall(String methodName,
                                                                                      String urlTemplate,
                                                                                      Object... params)
                                                                               throws InvalidParameterException,
                                                                                      UserNotAuthorizedException,
                                                                                      PropertyServerException

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

DiscoveryAnalysisReportResponse

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.

callDiscoveryAnalysisReportListPostRESTCall

public DiscoveryAnalysisReportListResponse callDiscoveryAnalysisReportListPostRESTCall(String methodName,
                                                                                       String urlTemplate,
                                                                                       Object requestBody,
                                                                                       Object... params)
                                                                                throws InvalidParameterException,
                                                                                       UserNotAuthorizedException,
                                                                                       PropertyServerException

Issue a POST REST call that returns a DiscoveryAnalysisReportListResponse 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 call - contains most of the parameters

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

Returns:

DiscoveryAnalysisReportResponse

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.

callAnnotationListGetRESTCall

public AnnotationListResponse callAnnotationListGetRESTCall(String methodName,
                                                            String urlTemplate,
                                                            Object... params)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

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

AnnotationListResponse

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.

callAnnotationListPostRESTCall

public AnnotationListResponse callAnnotationListPostRESTCall(String methodName,
                                                             String urlTemplate,
                                                             Object requestBody,
                                                             Object... params)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Issue a POST REST call that returns an AnnotationResponse 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 call - contains most of the parameters

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

Returns:

AnnotationResponse

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.

callAnnotationGetRESTCall

public AnnotationResponse callAnnotationGetRESTCall(String methodName,
                                                    String urlTemplate,
                                                    Object... params)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

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

AnnotationResponse

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.

callAnnotationPostRESTCall

public AnnotationResponse callAnnotationPostRESTCall(String methodName,
                                                     String urlTemplate,
                                                     Object requestBody,
                                                     Object... params)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Issue a POST REST call that returns an AnnotationResponse 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 call - contains most of the parameters

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

Returns:

AnnotationResponse

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.