Package org.odpi.openmetadata.metadatasecurity.connectors

Class OpenMetadataPlatformSecurityConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.metadatasecurity.connectors.OpenMetadataSecurityConnector

org.odpi.openmetadata.metadatasecurity.connectors.OpenMetadataPlatformSecurityConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, OpenMetadataPlatformSecurity

public class OpenMetadataPlatformSecurityConnector
extends OpenMetadataSecurityConnector
implements OpenMetadataPlatformSecurity

OpenMetadataPlatformSecurityConnector provides the base class for a connector that validates access to the platform services that are not specific to an OMAG Server. This optional connector can be set up once the OMAGServerPlatform is running. The default implementation does not allow any access. It generates well-defined exceptions and console log messages. It is over-ridden to define the required access for the deployment environment. The methods in this base class can be called if access is to be denied as a way of reusing the message logging and exceptions.

Nested Class Summary

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

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected MessageFormatter	messageFormatter

Fields inherited from class org.odpi.openmetadata.metadatasecurity.connectors.OpenMetadataSecurityConnector

connectorName, localServerUserId, serverName, serverRootURL, unknownTypeName

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

auditLog, connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, embeddedConnectors, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
OpenMetadataPlatformSecurityConnector()

Method Summary

Modifier and Type	Method	Description
protected void	logConnectorDisconnecting()	Write an audit log message to say that the connector is stopping.
protected void	logConnectorStarting()	Write an audit log message to say that the connector is initializing.
protected void	logRecord(AuditLogRecordSeverity severity, String logMessage)	Log an audit log record for an event, decision, error, or exception detected by the OMRS.

Methods inherited from class org.odpi.openmetadata.metadatasecurity.connectors.OpenMetadataSecurityConnector

disconnect, getConnectorComponentDescription, printZoneList, setAuditLog, setLocalServerUserId, setServerName, setServerPlatformURL, setSupportedZonesForUser, start, throwMissingAnchor, throwUnauthorizedAddFeedback, throwUnauthorizedAnchorAccess, throwUnauthorizedElementAccess, throwUnauthorizedInstanceAccess, throwUnauthorizedInstanceChange, throwUnauthorizedInstanceCreate, throwUnauthorizedPlatformAccess, throwUnauthorizedServerAccess, throwUnauthorizedServiceAccess, throwUnauthorizedTypeAccess, throwUnauthorizedTypeChange, throwUnauthorizedZoneChange, throwUnknownUser, validateUserAsInvestigatorForPlatform, validateUserAsOperatorForPlatform, validateUserAsServerAdmin, validateUserAsServerInvestigator, validateUserAsServerOperator, validateUserForEntityClassificationAdd, validateUserForEntityClassificationDelete, validateUserForEntityClassificationUpdate, validateUserForEntityCreate, validateUserForEntityDelete, validateUserForEntityProxyRead, validateUserForEntityRead, validateUserForEntityReHoming, validateUserForEntityReIdentification, validateUserForEntityRestore, validateUserForEntityReTyping, validateUserForEntitySummaryRead, validateUserForEntityUpdate, validateUserForNewServer, validateUserForRelationshipCreate, validateUserForRelationshipDelete, validateUserForRelationshipRead, validateUserForRelationshipReHoming, validateUserForRelationshipReIdentification, validateUserForRelationshipRestore, validateUserForRelationshipReTyping, validateUserForRelationshipUpdate, validateUserForServer, validateUserForService, validateUserForServiceOperation, validateUserForTypeCreate, validateUserForTypeCreate, validateUserForTypeDelete, validateUserForTypeDelete, validateUserForTypeRead, validateUserForTypeRead, validateUserForTypeReIdentify, validateUserForTypeReIdentify, validateUserForTypeUpdate

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

combineConfigurationProperties, disconnectConnectors, equals, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, 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

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

Methods inherited from interface org.odpi.openmetadata.metadatasecurity.OpenMetadataPlatformSecurity

setServerPlatformURL, validateUserAsInvestigatorForPlatform, validateUserAsOperatorForPlatform, validateUserForNewServer

Field Details

messageFormatter

protected MessageFormatter messageFormatter

Constructor Details

OpenMetadataPlatformSecurityConnector

public OpenMetadataPlatformSecurityConnector()

Method Details

logRecord

protected void logRecord(AuditLogRecordSeverity severity,
 String logMessage)

Log an audit log record for an event, decision, error, or exception detected by the OMRS.

Parameters:

severity - is this an event, decision, error or exception?

logMessage - description of the audit log record including specific resources involved

logConnectorStarting

protected void logConnectorStarting()

Write an audit log message to say that the connector is initializing.

Overrides:

logConnectorStarting in class OpenMetadataSecurityConnector

logConnectorDisconnecting

protected void logConnectorDisconnecting()

Write an audit log message to say that the connector is stopping.

Overrides:

logConnectorDisconnecting in class OpenMetadataSecurityConnector