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:

org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension

public class MetadataAccessServerConnector
extends OMAGServerConnectorBase

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

Constructor Summary

Constructors

Constructor	Description
MetadataAccessServerConnector()

Method Summary

Modifier and Type	Method	Description
void	addOpenMetadataArchive(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)	Add a new open metadata archive to running repository.
void	addOpenMetadataArchiveContent(org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.properties.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<org.odpi.openmetadata.commonservices.ffdc.rest.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

disconnect, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, toString

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

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

Methods inherited from class java.lang.Object

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<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService> getAccessServices()
                                                                                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve a list of the access services registered on the platform

Returns:

List of access services

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

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

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

connectToCohort

public boolean connectToCohort(String cohortName)
                        throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
org.odpi.openmetadata.repositoryservices.ffdc.exception.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:

org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - one of the supplied parameters caused a problem

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - there is a problem communicating with the remote server.

org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException - the user is not authorized to perform the operation requested

disconnectFromCohort

public boolean disconnectFromCohort(String cohortName)
                             throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException

Disconnect communications from a specific cohort.

Parameters:

cohortName - name of cohort

Returns:

boolean flag to indicate success.

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - one of the supplied parameters caused a problem

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - there is a problem communicating with the remote server.

org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException - the user is not authorized to perform the operation requested

unregisterFromCohort

public boolean unregisterFromCohort(String cohortName)
                             throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException

Unregister from a specific cohort and disconnect from cohort communications.

Parameters:

cohortName - name of cohort

Returns:

boolean flag to indicate success.

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - one of the supplied parameters caused a problem

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - there is a problem communicating with the remote server.

org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException - the user is not authorized to perform the operation requested

addOpenMetadataArchiveFile

public void addOpenMetadataArchiveFile(String fileName)
                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Add a new open metadata archive to running repository.

Parameters:

fileName - name of the open metadata archive file.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.

addOpenMetadataArchive

public void addOpenMetadataArchive(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Add a new open metadata archive to running repository.

Parameters:

connection - connection for the open metadata archive.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.

addOpenMetadataArchiveContent

public void addOpenMetadataArchiveContent(org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.properties.OpenMetadataArchive openMetadataArchive)
                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Add a new open metadata archive to running repository.

Parameters:

openMetadataArchive - openMetadataArchive for the open metadata archive.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.