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

Class SecurityManagerRESTClient

java.lang.Object

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

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

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient

org.odpi.openmetadata.accessservices.securitymanager.client.rest.SecurityManagerRESTClient

public class SecurityManagerRESTClient
extends OCFRESTClient

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

Method Summary

Modifier and Type	Method	Description
DatabaseColumnResponse	callDatabaseColumnGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseColumnResponse object.
DatabaseColumnsResponse	callDatabaseColumnsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseColumnsResponse object.
DatabaseResponse	callDatabaseGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseResponse object.
DatabaseSchemaResponse	callDatabaseSchemaGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseSchemaResponse object.
DatabaseSchemasResponse	callDatabaseSchemasGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseSchemasResponse object.
DatabasesResponse	callDatabasesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabasesResponse object.
DatabaseTableResponse	callDatabaseTableGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseTableResponse object.
DatabaseTablesResponse	callDatabaseTablesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseTablesResponse object.
DatabaseViewResponse	callDatabaseViewGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseViewResponse object.
DatabaseViewsResponse	callDatabaseViewsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseViewsResponse object.
DataFileResponse	callDataFileGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DataFileResponse object.
DataFileResponse	callDataFilePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DataFileResponse object.
DataFilesResponse	callDataFilesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DataFilesResponse object.
DataFilesResponse	callDataFilesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DataFilesResponse object.
FileFolderResponse	callFileFolderGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a FileFolderResponse object.
FileFolderResponse	callFileFolderPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a FileFolderResponse object.
FileFoldersResponse	callFileFoldersGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a FileFoldersResponse object.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient

callAssetGetRESTCall, callAssetsGetRESTCall, callAssetsPostRESTCall, callConnectionGetRESTCall, callTagGetRESTCall, callTagListGetRESTCall, callTagListPostRESTCall

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

SecurityManagerRESTClient

public SecurityManagerRESTClient(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 manager 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.

SecurityManagerRESTClient

public SecurityManagerRESTClient(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 manager where the OMAG Server is running.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

SecurityManagerRESTClient

public SecurityManagerRESTClient(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 manager 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.

SecurityManagerRESTClient

public SecurityManagerRESTClient(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 manager 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

callDatabaseColumnGetRESTCall

public DatabaseColumnResponse callDatabaseColumnGetRESTCall(String methodName,
                                                            String urlTemplate,
                                                            Object... params)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

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

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.

callDatabaseColumnsGetRESTCall

public DatabaseColumnsResponse callDatabaseColumnsGetRESTCall(String methodName,
                                                              String urlTemplate,
                                                              Object... params)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

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

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.

callDatabaseGetRESTCall

public DatabaseResponse callDatabaseGetRESTCall(String methodName,
                                                String urlTemplate,
                                                Object... params)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

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

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.

callDatabasesGetRESTCall

public DatabasesResponse callDatabasesGetRESTCall(String methodName,
                                                  String urlTemplate,
                                                  Object... params)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

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

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.

callDatabaseSchemaGetRESTCall

public DatabaseSchemaResponse callDatabaseSchemaGetRESTCall(String methodName,
                                                            String urlTemplate,
                                                            Object... params)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

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

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.

callDatabaseSchemasGetRESTCall

public DatabaseSchemasResponse callDatabaseSchemasGetRESTCall(String methodName,
                                                              String urlTemplate,
                                                              Object... params)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

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

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.

callDatabaseTableGetRESTCall

public DatabaseTableResponse callDatabaseTableGetRESTCall(String methodName,
                                                          String urlTemplate,
                                                          Object... params)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

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

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.

callDatabaseTablesGetRESTCall

public DatabaseTablesResponse callDatabaseTablesGetRESTCall(String methodName,
                                                            String urlTemplate,
                                                            Object... params)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

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

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.

callDatabaseViewGetRESTCall

public DatabaseViewResponse callDatabaseViewGetRESTCall(String methodName,
                                                        String urlTemplate,
                                                        Object... params)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

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

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.

callDatabaseViewsGetRESTCall

public DatabaseViewsResponse callDatabaseViewsGetRESTCall(String methodName,
                                                          String urlTemplate,
                                                          Object... params)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

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

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.

callDataFileGetRESTCall

public DataFileResponse callDataFileGetRESTCall(String methodName,
                                                String urlTemplate,
                                                Object... params)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

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

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.

callDataFilePostRESTCall

public DataFileResponse callDataFilePostRESTCall(String methodName,
                                                 String urlTemplate,
                                                 Object requestBody,
                                                 Object... params)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Issue a POST REST call that returns a DataFileResponse 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 - object that passes additional 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.

callDataFilesGetRESTCall

public DataFilesResponse callDataFilesGetRESTCall(String methodName,
                                                  String urlTemplate,
                                                  Object... params)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

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

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.

callDataFilesPostRESTCall

public DataFilesResponse callDataFilesPostRESTCall(String methodName,
                                                   String urlTemplate,
                                                   Object requestBody,
                                                   Object... params)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Issue a POST REST call that returns a DataFilesResponse 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 - object that passes additional 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.

callFileFolderGetRESTCall

public FileFolderResponse callFileFolderGetRESTCall(String methodName,
                                                    String urlTemplate,
                                                    Object... params)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

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

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.

callFileFolderPostRESTCall

public FileFolderResponse callFileFolderPostRESTCall(String methodName,
                                                     String urlTemplate,
                                                     Object requestBody,
                                                     Object... params)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Issue a POST REST call that returns a FileFolderResponse 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 - object that passes additional 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.

callFileFoldersGetRESTCall

public FileFoldersResponse callFileFoldersGetRESTCall(String methodName,
                                                      String urlTemplate,
                                                      Object... params)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

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

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.