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

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

public class CommunityProfileRESTClient
extends FFDCRESTClient

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

Constructors

Constructor	Description
CommunityProfileRESTClient(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 Type	Method	Description
AssetListResponse	callAssetListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a AssetListResponse object.
MetadataSourceResponse	callMetadataSourceGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a MetadataSourceResponse object.
PersonalProfileResponse	callPersonalProfileGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a PersonalProfileUniverse in a response object.
PersonalProfileListResponse	callPersonalProfileListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of PersonalProfileElements in a response object.
UserIdentityResponse	callUserIdentityGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a UserIdentityElement in a response object.
UserIdentityListResponse	callUserIdentityListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of UserIdentityElements in a response object.
UserIdentityListResponse	callUserIdentityListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a list of UserIdentityElements in a response object.

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

callConnectorTypeGetRESTCall, 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

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 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.

CommunityProfileRESTClient

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

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 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.

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 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

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 - 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:

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.

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 - 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:

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 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:

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 GET REST call that returns a list of UserIdentityElements in a response 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 request

params - 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.

callPersonalProfileGetRESTCall

public PersonalProfileResponse callPersonalProfileGetRESTCall(String methodName,
                                                              String urlTemplate,
                                                              Object... params)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

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

PersonalProfileResponse

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.

callPersonalProfileListGetRESTCall

public PersonalProfileListResponse callPersonalProfileListGetRESTCall(String methodName,
                                                                      String urlTemplate,
                                                                      Object... params)
                                                               throws InvalidParameterException,
                                                                      UserNotAuthorizedException,
                                                                      PropertyServerException

Issue a GET REST call that returns a list of PersonalProfileElements in a response 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:

PersonalProfileListResponse

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.

callAssetListGetRESTCall

public AssetListResponse callAssetListGetRESTCall(String methodName,
                                                  String urlTemplate,
                                                  Object... params)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

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

AssetListResponse

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.