Class CommunityProfileRESTClient
java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
org.odpi.openmetadata.accessservices.communityprofile.client.rest.CommunityProfileRESTClient
CommunityProfileRESTClient is responsible for issuing calls to the Community Profile OMAS REST APIs.
-
Field Summary
Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
auditLog, exceptionHandler, serverName, serverPlatformURLRoot
-
Constructor Summary
ConstructorsConstructorDescriptionCommunityProfileRESTClient
(String serverName, String serverPlatformURLRoot) Constructor for no authentication.CommunityProfileRESTClient
(String serverName, String serverPlatformURLRoot, String userId, String password) Constructor for simple userId and password authentication.CommunityProfileRESTClient
(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog) Constructor for simple userId and password authentication with audit log.CommunityProfileRESTClient
(String serverName, String serverPlatformURLRoot, AuditLog auditLog) Constructor for no authentication with audit log. -
Method Summary
Modifier and TypeMethodDescriptioncallActorProfileGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ActorProfileElement in a response object.callActorProfileListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of ActorProfileElements in a response object.callActorProfileListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a GET REST call that returns a list of ActorProfileElements in a response object.callCollectionGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a CollectionElement in a response object.callCollectionListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of CollectionElements in a response object.callCollectionListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a GET REST call that returns a list of CollectionElements in a response object.callCollectionMemberGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a CollectionMember in a response object.callCollectionMemberListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of CollectionMembers in a response object.callCommunityGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a CommunityElement in a response object.callCommunityListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of CommunityElements in a response object.callCommunityListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a GET REST call that returns a list of CommunityElements in a response object.callElementStubsGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ElementStubsResponse object.callLocationGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a LocationResponse object.callLocationsGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a LocationListResponse object.callLocationsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a LocationListResponse object.callMetadataSourceGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a MetadataSourceResponse object.callPersonRoleAppointeeListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a list of PersonRoleAppointees in a response object.callPersonRoleGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a PersonRoleElement in a response object.callPersonRoleListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of PersonRoleElements in a response object.callPersonRoleListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a list of PersonRoleElements in a response object.callRelatedElementListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a RelatedElementListResponse object.callSecurityGroupGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a SecurityGroupResponse object.callSecurityGroupPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a SecurityGroupResponse object.callSecurityGroupsGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a SecurityGroupsResponse object.callSecurityGroupsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a SecurityGroupsResponse object.callUserIdentityGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a UserIdentityElement in a response object.callUserIdentityListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of UserIdentityElements in a response object.callUserIdentityListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a list of UserIdentityElements in a response object.callValidValueGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ValidValueElement in a response object.callValidValueListGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a list of ValidValueElements in a response object.callValidValueListPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a GET REST call that returns a list of ValidValueElements in a response object.Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
callBooleanGetRESTCall, callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall
Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall
-
Constructor Details
-
CommunityProfileRESTClient
public CommunityProfileRESTClient(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.
-
CommunityProfileRESTClient
public CommunityProfileRESTClient(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.
-
CommunityProfileRESTClient
public CommunityProfileRESTClient(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.
-
CommunityProfileRESTClient
public CommunityProfileRESTClient(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
-
callMetadataSourceGetRESTCall
public MetadataSourceResponse callMetadataSourceGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a MetadataSourceResponse 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:
- MetadataSourceResponse
- 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.
-
callActorProfileGetRESTCall
public ActorProfileResponse callActorProfileGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a ActorProfileElement in a response 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
- something went wrong with the REST call stack.
-
callActorProfileListGetRESTCall
public ActorProfileListResponse callActorProfileListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of ActorProfileElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersparams
- 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.
-
callActorProfileListPostRESTCall
public ActorProfileListResponse callActorProfileListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of ActorProfileElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersrequestBody
- request body for the requestparams
- 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.
-
callCollectionGetRESTCall
public CollectionResponse callCollectionGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a CollectionElement in a response 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
- something went wrong with the REST call stack.
-
callCollectionListGetRESTCall
public CollectionListResponse callCollectionListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of CollectionElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersparams
- 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.
-
callCollectionMemberListGetRESTCall
public CollectionMemberListResponse callCollectionMemberListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of CollectionMembers in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersparams
- 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.
-
callCollectionMemberGetRESTCall
public CollectionMemberResponse callCollectionMemberGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a CollectionMember in a response 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
- something went wrong with the REST call stack.
-
callCollectionListPostRESTCall
public CollectionListResponse callCollectionListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of CollectionElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersrequestBody
- request body for the requestparams
- 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.
-
callCommunityGetRESTCall
public CommunityResponse callCommunityGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a CommunityElement in a response 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
- something went wrong with the REST call stack.
-
callCommunityListGetRESTCall
public CommunityListResponse callCommunityListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of CommunityElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersparams
- 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.
-
callCommunityListPostRESTCall
public CommunityListResponse callCommunityListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of CommunityElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersrequestBody
- request body for the requestparams
- 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.
-
callPersonRoleGetRESTCall
public PersonRoleResponse callPersonRoleGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a PersonRoleElement in a response 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
- something went wrong with the REST call stack.
-
callPersonRoleListGetRESTCall
public PersonRoleListResponse callPersonRoleListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of PersonRoleElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersparams
- 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.
-
callPersonRoleListPostRESTCall
public PersonRoleListResponse callPersonRoleListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a list of PersonRoleElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersrequestBody
- request body for the requestparams
- 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.
-
callPersonRoleAppointeeListPostRESTCall
public PersonRoleAppointeeListResponse callPersonRoleAppointeeListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a list of PersonRoleAppointees in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersrequestBody
- request body for the requestparams
- 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.
-
callUserIdentityGetRESTCall
public UserIdentityResponse callUserIdentityGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a UserIdentityElement in a response 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:
- UserIdentityResponse
- 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.
-
callUserIdentityListGetRESTCall
public UserIdentityListResponse callUserIdentityListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of UserIdentityElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersparams
- a list of parameters that are slotted into the url template- Returns:
- UserIdentityListResponse
- 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.
-
callUserIdentityListPostRESTCall
public UserIdentityListResponse callUserIdentityListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a list of UserIdentityElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersrequestBody
- request body for the requestparams
- a list of parameters that are slotted into the url template- Returns:
- UserIdentityListResponse
- 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.
-
callSecurityGroupGetRESTCall
public SecurityGroupResponse callSecurityGroupGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a SecurityGroupResponse 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.
-
callSecurityGroupPostRESTCall
public SecurityGroupResponse callSecurityGroupPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a SecurityGroupResponse object.- Parameters:
methodName
- name of the method being called.urlTemplate
- REST API call URL template with place-holders for the parameters.requestBody
- object that passes additional parametersparams
- 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.
-
callSecurityGroupsGetRESTCall
public SecurityGroupsResponse callSecurityGroupsGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a SecurityGroupsResponse 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.
-
callSecurityGroupsPostRESTCall
public SecurityGroupsResponse callSecurityGroupsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a SecurityGroupsResponse object.- Parameters:
methodName
- name of the method being called.urlTemplate
- REST API call URL template with place-holders for the parameters.requestBody
- object that passes additional parametersparams
- 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.
-
callElementStubsGetRESTCall
public ElementStubsResponse callElementStubsGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a ElementStubsResponse 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.
-
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.
-
callLocationGetRESTCall
public LocationResponse callLocationGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a LocationResponse 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:
- LocationResponse
- 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.
-
callLocationsGetRESTCall
public LocationListResponse callLocationsGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a LocationListResponse 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:
- LocationListResponse
- 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.
-
callLocationsPostRESTCall
public LocationListResponse callLocationsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a LocationListResponse object.- Parameters:
methodName
- name of the method being called.urlTemplate
- REST API call URL template 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:
- LocationListResponse
- 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 ValidValueElement in a response 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
- something went wrong with the REST call stack.
-
callValidValueListGetRESTCall
public ValidValueListResponse callValidValueListGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of ValidValueElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersparams
- 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.
-
callValidValueListPostRESTCall
public ValidValueListResponse callValidValueListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a list of ValidValueElements in a response object.- Parameters:
methodName
- name of the method being calledurlTemplate
- REST API call URL template with place-holders for the parametersrequestBody
- request body for the requestparams
- 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.
-