Package org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers

Class MetadataAccessServerConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.OMAGServerConnectorBase

org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.MetadataAccessServerConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension

public class MetadataAccessServerConnector
extends OMAGServerConnectorBase

MetadataAccessServerConnector Connectors to access a metadata access point or metadata access store.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.OMAGServerConnectorBase

extractor

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
MetadataAccessServerConnector()

Method Summary

Modifier and Type	Method	Description
void	addOpenMetadataArchive(Connection connection)	Add a new open metadata archive to running repository.
void	addOpenMetadataArchiveContent(OpenMetadataArchive openMetadataArchive)	Add a new open metadata archive to running repository.
void	addOpenMetadataArchiveFile(String fileName)	Add a new open metadata archive to running repository.
boolean	connectToCohort(String cohortName)	A new server needs to register the metadataCollectionId for its metadata repository with the other servers in the open metadata repository.
boolean	disconnectFromCohort(String cohortName)	Disconnect communications from a specific cohort.
List<RegisteredOMAGService>	getAccessServices()	Retrieve a list of the access services registered on the platform
boolean	unregisterFromCohort(String cohortName)	Unregister from a specific cohort and disconnect from cohort communications.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.OMAGServerConnectorBase

activateServer, connectToCohort, disconnectFromCohort, getActiveConfiguration, getActiveServerStatus, getActiveServices, getConnectorComponentDescription, getOMAGServerConfig, getServerReport, getServerStatus, setAuditLog, setClientUserId, shutdownAndUnregisterServer, shutdownServer, start, unregisterFromCohort

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

combineConfigurationProperties, disconnect, disconnectConnectors, equals, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingEndpointAddress, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, refreshStatistics, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension

initializeEmbeddedConnectors

Constructor Details

MetadataAccessServerConnector

public MetadataAccessServerConnector()

Method Details

getAccessServices

public List<RegisteredOMAGService> getAccessServices()
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a list of the access services registered on the platform

Returns:

List of access services

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

connectToCohort

public boolean connectToCohort(String cohortName)
                        throws InvalidParameterException,
RepositoryErrorException,
UserNotAuthorizedException

A new server needs to register the metadataCollectionId for its metadata repository with the other servers in the open metadata repository. It only needs to do this once and uses a timestamp to record that the registration event has been sent. If the server has already registered in the past, it sends a reregistration request.

Parameters:

cohortName - name of cohort

Returns:

boolean to indicate that the request has been issued. If false it is likely that the cohort name is not known

Throws:

InvalidParameterException - one of the supplied parameters caused a problem

RepositoryErrorException - there is a problem communicating with the remote server.

UserNotAuthorizedException - the user is not authorized to perform the operation requested

disconnectFromCohort

public boolean disconnectFromCohort(String cohortName)
                             throws InvalidParameterException,
RepositoryErrorException,
UserNotAuthorizedException

Disconnect communications from a specific cohort.

Parameters:

cohortName - name of cohort

Returns:

boolean flag to indicate success.

Throws:

InvalidParameterException - one of the supplied parameters caused a problem

RepositoryErrorException - there is a problem communicating with the remote server.

UserNotAuthorizedException - the user is not authorized to perform the operation requested

unregisterFromCohort

public boolean unregisterFromCohort(String cohortName)
                             throws InvalidParameterException,
RepositoryErrorException,
UserNotAuthorizedException

Unregister from a specific cohort and disconnect from cohort communications.

Parameters:

cohortName - name of cohort

Returns:

boolean flag to indicate success.

Throws:

InvalidParameterException - one of the supplied parameters caused a problem

RepositoryErrorException - there is a problem communicating with the remote server.

UserNotAuthorizedException - the user is not authorized to perform the operation requested

addOpenMetadataArchiveFile

public void addOpenMetadataArchiveFile(String fileName)
                                throws UserNotAuthorizedException,
InvalidParameterException,
PropertyServerException

Add a new open metadata archive to running repository.

Parameters:

fileName - name of the open metadata archive file.

Throws:

UserNotAuthorizedException - the supplied userId is not authorized to issue this command.

InvalidParameterException - invalid parameter.

PropertyServerException - unusual state in the platform.

addOpenMetadataArchive

public void addOpenMetadataArchive(Connection connection)
                            throws UserNotAuthorizedException,
InvalidParameterException,
PropertyServerException

Add a new open metadata archive to running repository.

Parameters:

connection - connection for the open metadata archive.

Throws:

UserNotAuthorizedException - the supplied userId is not authorized to issue this command.

InvalidParameterException - invalid parameter.

PropertyServerException - unusual state in the platform.

addOpenMetadataArchiveContent

public void addOpenMetadataArchiveContent(OpenMetadataArchive openMetadataArchive)
                                   throws UserNotAuthorizedException,
InvalidParameterException,
PropertyServerException

Add a new open metadata archive to running repository.

Parameters:

openMetadataArchive - openMetadataArchive for the open metadata archive.

Throws:

UserNotAuthorizedException - the supplied userId is not authorized to issue this command.

InvalidParameterException - invalid parameter.

PropertyServerException - unusual state in the platform.