Package org.odpi.openmetadata.governanceservers.enginehostservices.client.rest

Class EngineHostRESTClient

java.lang.Object

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

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

org.odpi.openmetadata.governanceservers.enginehostservices.client.rest.EngineHostRESTClient

public class EngineHostRESTClient
extends FFDCRESTClient

EngineHostRESTClient is responsible for issuing the REST API calls

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
EngineHostRESTClient(String serverName, String serverPlatformURLRoot)	Constructor for no authentication.
EngineHostRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Constructor for simple userId and password authentication.
EngineHostRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Constructor for simple userId and password authentication with audit log.
EngineHostRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Constructor for no authentication with audit log.

Method Summary

Modifier and Type	Method	Description
GovernanceEngineSummariesResponse	callGovernanceEngineSummariesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceEngineSummariesResponse object.
GovernanceEngineSummaryResponse	callGovernanceEngineSummaryGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceEngineSummaryResponse object.

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

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

EngineHostRESTClient

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

EngineHostRESTClient

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

EngineHostRESTClient

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

EngineHostRESTClient

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

callGovernanceEngineSummariesGetRESTCall

public GovernanceEngineSummariesResponse callGovernanceEngineSummariesGetRESTCall(String methodName,
                                                                                  String urlTemplate,
                                                                                  Object... params)
                                                                           throws InvalidParameterException,
                                                                                  UserNotAuthorizedException,
                                                                                  PropertyServerException

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

GovernanceEngineSummariesResponse

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.

callGovernanceEngineSummaryGetRESTCall

public GovernanceEngineSummaryResponse callGovernanceEngineSummaryGetRESTCall(String methodName,
                                                                              String urlTemplate,
                                                                              Object... params)
                                                                       throws InvalidParameterException,
                                                                              UserNotAuthorizedException,
                                                                              PropertyServerException

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

GovernanceEngineSummaryResponse

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.