Class AssetOwnerRESTClient
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.assetowner.client.rest.AssetOwnerRESTClient
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
ConstructorsConstructorDescriptionAssetOwnerRESTClient
(String serverName, String serverPlatformURLRoot) Constructor for no authentication.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.AssetOwnerRESTClient
(String serverName, String serverPlatformURLRoot, AuditLog auditLog) Constructor for no authentication with audit log. -
Method Summary
Modifier and TypeMethodDescriptioncallAnnotationGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns an AnnotationResponse object.callAnnotationListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns an AnnotationListResponse object.callAnnotationListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns an AnnotationResponse object.callAnnotationPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns an AnnotationResponse object.callAssetElementGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns an AssetElementResponse object.callAssetElementsGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns an AssetElementsResponse object.callAssetElementsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns an AssetElementsResponse object.callCertificationTypeGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a CertificationTypeResponse object.callCertificationTypeListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of CertificationTypeElement objects.callCertificationTypeListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a list of CertificationTypeElement objects.callConnectionsGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a POST REST call that returns a ConnectionsResponse object.callConnectionsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ConnectionsResponse object.callConnectorTypesPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ConnectorTypesResponse object.callDiscoveryAnalysisReportListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a DiscoveryAnalysisReportListResponse object.callDiscoveryAnalysisReportListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a DiscoveryAnalysisReportListResponse object.callElementStubListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ElementStubListResponse object.callEndpointGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a EndpointResponse object.callEndpointsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a EndpointsResponse object.callExternalReferenceGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ExternalReferenceResponse object.callExternalReferenceListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of ExternalReferenceElement objects.callExternalReferenceListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a list of ExternalReferenceElement objects.callFileSystemGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a FileSystemResponse object.callFolderGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a FolderResponse object.callLicenseListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of LicenseElement objects.callLicenseTypeGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a LicenseTypeResponse object.callLicenseTypeListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of LicenseTypeElement objects.callLicenseTypeListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a list of LicenseTypeElement objects.callMyConnectionGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ConnectionResponse object.callMyConnectorTypeGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ConnectorReportResponse object.callRelatedElementListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a RelatedElementListResponse object.callValidValueGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ValidValuesResponse object.callValidValuesGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ValidValuesResponse object.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.frameworkservices.ocf.metadatamanagement.client.OCFRESTClient
callOCFAssetGetRESTCall, callOCFAssetsGetRESTCall, callOCFAssetsPostRESTCall, callOCFConnectionGetRESTCall, callOCFTagGetRESTCall, callOCFTagListGetRESTCall, callOCFTagListPostRESTCall
Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
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
-
Constructor Details
-
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 callserverPlatformURLRoot
- 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 callserverPlatformURLRoot
- 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 callserverPlatformURLRoot
- URL root of the server platform where the OMAG Server is running.userId
- user id for the HTTP requestpassword
- password for the HTTP requestauditLog
- 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 callserverPlatformURLRoot
- URL root of the server platform where the OMAG Server is running.userId
- user id for the HTTP requestpassword
- password for the HTTP request- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
-
Method Details
-
callMyConnectionGetRESTCall
public ConnectionResponse callMyConnectionGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a ConnectionResponse 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:
- ConnectionResponse
- 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.
-
callConnectionsGetRESTCall
public ConnectionsResponse callConnectionsGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a ConnectionsResponse 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:
- ConnectionsResponse
- 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.
-
callConnectionsPostRESTCall
public ConnectionsResponse callConnectionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a ConnectionsResponse 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
- properties describing the valid value definition/setparams
- a list of parameters that are slotted into the url template.- Returns:
- ConnectionsResponse
- 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.
-
callMyConnectorTypeGetRESTCall
public ConnectorTypeResponse callMyConnectorTypeGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a ConnectorReportResponse 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:
- ConnectorReportResponse
- 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.
-
callConnectorTypesPostRESTCall
public ConnectorTypesResponse callConnectorTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a ConnectorTypesResponse 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
- properties describing the valid value definition/setparams
- a list of parameters that are slotted into the url template.- Returns:
- ConnectorTypesResponse
- 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.
-
callEndpointGetRESTCall
public EndpointResponse callEndpointGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a EndpointResponse 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:
- EndpointResponse
- 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.
-
callEndpointsPostRESTCall
public EndpointsResponse callEndpointsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a EndpointsResponse 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
- properties describing the valid value definition/setparams
- a list of parameters that are slotted into the url template.- Returns:
- EndpointsResponse
- 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.
-
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.requestBody
- additional parametersparams
- 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 an 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 an AssetElementsResponse object.- Parameters:
methodName
- name of the method being called.requestBody
- request body for the REST call - contains most of the parametersurlTemplate
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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.
-
callCertificationTypeGetRESTCall
public CertificationTypeResponse callCertificationTypeGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a GET REST call that returns a CertificationTypeResponse object.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- CertificationTypeResponse
- 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.
-
callCertificationTypeListGetRESTCall
public CertificationTypeListResponse callCertificationTypeListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a GET REST call that returns a list of CertificationTypeElement objects.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- CertificationTypeListResponse
- 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.
-
callCertificationTypeListPostRESTCall
public CertificationTypeListResponse callCertificationTypeListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a POST REST call that returns a list of CertificationTypeElement objects.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersrequestBody
- request body for the REST call - contains most of the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- CertificationTypeListResponse
- 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.
-
callElementStubListGetRESTCall
public ElementStubListResponse callElementStubListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a GET REST call that returns a ElementStubListResponse object.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- ElementStubListResponse
- 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.
-
callExternalReferenceGetRESTCall
public ExternalReferenceResponse callExternalReferenceGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a GET REST call that returns a ExternalReferenceResponse object.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- ExternalReferenceResponse
- 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.
-
callExternalReferenceListGetRESTCall
public ExternalReferenceListResponse callExternalReferenceListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a GET REST call that returns a list of ExternalReferenceElement objects.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- ExternalReferenceListResponse
- 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.
-
callExternalReferenceListPostRESTCall
public ExternalReferenceListResponse callExternalReferenceListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a POST REST call that returns a list of ExternalReferenceElement objects.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersrequestBody
- request body for the REST call - contains most of the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- ExternalReferenceListResponse
- 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.
-
callRelatedElementListGetRESTCall
public RelatedElementListResponse callRelatedElementListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a RelatedElementListResponse object.- Parameters:
methodName
- name of the method being called.urlTemplate
- REST API call URL template 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.
-
callLicenseTypeGetRESTCall
public LicenseTypeResponse callLicenseTypeGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a GET REST call that returns a LicenseTypeResponse object.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- LicenseTypeResponse
- 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.
-
callLicenseTypeListGetRESTCall
public LicenseTypeListResponse callLicenseTypeListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a GET REST call that returns a list of LicenseTypeElement objects.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- LicenseTypeListResponse
- 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.
-
callLicenseListGetRESTCall
public LicenseListResponse callLicenseListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a GET REST call that returns a list of LicenseElement objects.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- LicenseListResponse
- 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.
-
callLicenseTypeListPostRESTCall
public LicenseTypeListResponse callLicenseTypeListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Issue a POST REST call that returns a list of LicenseTypeElement objects.- Parameters:
methodName
- name of the method being calledurlTemplate
- template of the URL with place-holders for the parametersrequestBody
- request body for the REST call - contains most of the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- LicenseTypeListResponse
- 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.
-