Package org.odpi.openmetadata.accessservices.securitymanager.server

Class SecurityManagerRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.securitymanager.server.SecurityManagerRESTServices

public class SecurityManagerRESTServices
extends Object

The SecurityManagerRESTServices provides the server-side implementation of the services that are generic for all types of security managers.

Constructor Summary

Constructors

Constructor	Description
SecurityManagerRESTServices()	Default constructor

Method Summary

Modifier and Type	Method	Description
GUIDResponse	createDatabaseManagerInCatalog(String serverName, String userId, DatabaseManagerRequestBody requestBody)	Create information about the integration daemon that is managing the acquisition of metadata from the security manager.
GUIDResponse	createFileManagerInCatalog(String serverName, String userId, FileManagerRequestBody requestBody)	Files live on a file system.
GUIDResponse	createFileSystemInCatalog(String serverName, String userId, FileSystemRequestBody requestBody)	Files live on a file system.
GUIDResponse	getMetadataSourceGUID(String serverName, String userId, String qualifiedName)	Retrieve the unique identifier of the integration daemon service.
ConnectionResponse	getOutTopicConnection(String serverName, String userId, String callerId)	Return the connection object for the Security Manager OMAS's out topic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityManagerRESTServices

public SecurityManagerRESTServices()

Default constructor

Method Detail

getOutTopicConnection

public ConnectionResponse getOutTopicConnection(String serverName,
                                                String userId,
                                                String callerId)

Return the connection object for the Security Manager OMAS's out topic.

Parameters:

serverName - name of the service to route the request to.

userId - identifier of calling user.

callerId - unique identifier of the caller

Returns:

connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.

createFileSystemInCatalog

public GUIDResponse createFileSystemInCatalog(String serverName,
                                              String userId,
                                              FileSystemRequestBody requestBody)

Files live on a file system. This method creates a top level capability for a file system.

Parameters:

serverName - name of calling server

userId - calling user

requestBody - properties of the file system

Returns:

unique identifier for the file system or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

createFileManagerInCatalog

public GUIDResponse createFileManagerInCatalog(String serverName,
                                               String userId,
                                               FileManagerRequestBody requestBody)

Files live on a file system. This method creates a top level capability for a file system.

Parameters:

serverName - name of calling server

userId - calling user

requestBody - properties of the file system

Returns:

unique identifier for the file system or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

createDatabaseManagerInCatalog

public GUIDResponse createDatabaseManagerInCatalog(String serverName,
                                                   String userId,
                                                   DatabaseManagerRequestBody requestBody)

Create information about the integration daemon that is managing the acquisition of metadata from the security manager. Typically this is Egeria's security manager proxy.

Parameters:

serverName - name of the server to route the request to.

userId - calling user

requestBody - description of the database manager

Returns:

unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

getMetadataSourceGUID

public GUIDResponse getMetadataSourceGUID(String serverName,
                                          String userId,
                                          String qualifiedName)

Retrieve the unique identifier of the integration daemon service.

Parameters:

serverName - name of the server to route the request to.

userId - calling user

qualifiedName - unique name of the integration daemon

Returns:

unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server