Package org.odpi.openmetadata.accessservices.securitymanager.api

Interface MetadataSourceInterface

public interface MetadataSourceInterface

MetadataSourceInterface is the interface used to define information about the third party technologies that an integration daemon is extracting metadata from. These technologies are represented by a software capability in open metadata.

Method Summary

Modifier and Type	Method	Description
String	createExternalSecurityManager(String userId, String externalSourceGUID, String externalSourceName, String typeName, org.odpi.openmetadata.frameworks.openmetadata.properties.softwarecapabilities.SecurityManagerProperties securityManagerProperties)	Create information about a security manager such as a user access directory - such as an LDAP server or access control manager such as Apache Ranger.
String	getExternalSecurityManagerGUID(String userId, String qualifiedName)	Retrieve the unique identifier of the external security manager.

Method Details

createExternalSecurityManager

String createExternalSecurityManager(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String typeName,
 org.odpi.openmetadata.frameworks.openmetadata.properties.softwarecapabilities.SecurityManagerProperties securityManagerProperties)
                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create information about a security manager such as a user access directory - such as an LDAP server or access control manager such as Apache Ranger.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

typeName - type name for the software server capability

securityManagerProperties - description of the security manager

Returns:

unique identifier of the user directory's software server capability

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

getExternalSecurityManagerGUID

String getExternalSecurityManagerGUID(String userId,
 String qualifiedName)
                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the unique identifier of the external security manager.

Parameters:

userId - calling user

qualifiedName - unique name of the integration daemon

Returns:

unique identifier of the integration daemon's software server capability

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server