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

Class StewardshipActionRESTClient

java.lang.Object

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

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

org.odpi.openmetadata.accessservices.stewardshipaction.client.rest.StewardshipActionRESTClient

public class StewardshipActionRESTClient
extends FFDCRESTClient

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

Method Summary

Modifier and Type	Method	Description
DuplicatesResponse	callDuplicatesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DuplicatesResponse object.
DuplicatesResponse	callDuplicatesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DuplicatesResponse object.
ElementStubResponse	callElementStubGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ElementStubResponse object.
ElementStubsResponse	callElementStubsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ElementStubsResponse 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

StewardshipActionRESTClient

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

StewardshipActionRESTClient

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

StewardshipActionRESTClient

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

StewardshipActionRESTClient

public StewardshipActionRESTClient(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

callDuplicatesGetRESTCall

public DuplicatesResponse callDuplicatesGetRESTCall(String methodName,
                                                    String urlTemplate,
                                                    Object... params)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

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

DuplicatesResponse

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.

callDuplicatesPostRESTCall

public DuplicatesResponse callDuplicatesPostRESTCall(String methodName,
                                                     String urlTemplate,
                                                     Object requestBody,
                                                     Object... params)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

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

DuplicatesResponse

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.

callElementStubGetRESTCall

public ElementStubResponse callElementStubGetRESTCall(String methodName,
                                                      String urlTemplate,
                                                      Object... params)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

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

ElementStubResponse

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.

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

ElementStubsResponse

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.