public abstract class AccessServiceAdmin extends Object
| Modifier and Type | Field and Description |
|---|---|
protected String |
defaultZonesPropertyName |
protected String |
karmaPointIncrementPropertyName |
protected String |
karmaPointPlateauPropertyName |
protected String |
supportedZonesPropertyName |
| Constructor and Description |
|---|
AccessServiceAdmin() |
| Modifier and Type | Method and Description |
|---|---|
protected List<String> |
extractDefaultZones(Map<String,Object> accessServiceOptions,
String accessServiceName,
OMRSAuditLog auditLog)
Extract the default zones property from the access services option.
|
protected int |
extractKarmaPointIncrement(Map<String,Object> accessServiceOptions,
String accessServiceName,
OMRSAuditLog auditLog)
Extract the karma point plateau property from the access services option.
|
protected int |
extractKarmaPointPlateau(Map<String,Object> accessServiceOptions,
String accessServiceName,
OMRSAuditLog auditLog)
Extract the karma point plateau property from the access services option.
|
protected List<String> |
extractSupportedZones(Map<String,Object> accessServiceOptions,
String accessServiceName,
OMRSAuditLog auditLog)
Extract the supported zones property from the access services option.
|
protected OpenMetadataTopicConnector |
getInTopicConnector(Connection inTopicConnection,
String accessServiceName,
OMRSAuditLog parentAuditLog)
Create the connector for this access services' In Topic.
|
protected OpenMetadataTopicConnector |
getOutTopicConnector(Connection outTopicConnection,
String accessServiceName,
OMRSAuditLog parentAuditLog)
Create the connector for this access services' Out Topic.
|
protected String |
getTopicName(Connection connection)
Return the name of the topic extracted from the endpoint of the topic's Connection.
|
abstract void |
initialize(AccessServiceConfig accessServiceConfigurationProperties,
OMRSTopicConnector enterpriseOMRSTopicConnector,
OMRSRepositoryConnector enterpriseOMRSRepositoryConnector,
OMRSAuditLog auditLog,
String serverUserName)
Initialize the access service.
|
protected void |
registerWithEnterpriseTopic(String accessServiceName,
String serverName,
OMRSTopicConnector omrsTopicConnector,
OMRSTopicListener omrsTopicListener,
OMRSAuditLog auditLog)
Register a listener with the enterprise topic connector.
|
abstract void |
shutdown()
Shutdown the access service.
|
protected String supportedZonesPropertyName
protected String defaultZonesPropertyName
protected String karmaPointPlateauPropertyName
protected String karmaPointIncrementPropertyName
public abstract void initialize(AccessServiceConfig accessServiceConfigurationProperties, OMRSTopicConnector enterpriseOMRSTopicConnector, OMRSRepositoryConnector enterpriseOMRSRepositoryConnector, OMRSAuditLog auditLog, String serverUserName) throws OMAGConfigurationErrorException
accessServiceConfigurationProperties - specific configuration properties for this access service.enterpriseOMRSTopicConnector - connector for receiving OMRS Events from the cohortsenterpriseOMRSRepositoryConnector - connector for querying the cohort repositoriesauditLog - audit log component for logging messages.serverUserName - user id to use on OMRS calls where there is no end user.OMAGConfigurationErrorException - invalid parameters in the configuration properties.public abstract void shutdown()
protected List<String> extractSupportedZones(Map<String,Object> accessServiceOptions, String accessServiceName, OMRSAuditLog auditLog) throws OMAGConfigurationErrorException
accessServiceOptions - options passed to the access service.accessServiceName - name of calling serviceauditLog - audit log for error messagesOMAGConfigurationErrorException - the supported zones property is not a list of zone names.protected List<String> extractDefaultZones(Map<String,Object> accessServiceOptions, String accessServiceName, OMRSAuditLog auditLog) throws OMAGConfigurationErrorException
accessServiceOptions - options passed to the access service.accessServiceName - name of calling serviceauditLog - audit log for error messagesOMAGConfigurationErrorException - the supported zones property is not a list of zone names.protected int extractKarmaPointIncrement(Map<String,Object> accessServiceOptions, String accessServiceName, OMRSAuditLog auditLog) throws OMAGConfigurationErrorException
accessServiceOptions - options passed to the access service.accessServiceName - name of calling serviceauditLog - audit log for error messagesOMAGConfigurationErrorException - the supported zones property is not a list of zone names.protected int extractKarmaPointPlateau(Map<String,Object> accessServiceOptions, String accessServiceName, OMRSAuditLog auditLog) throws OMAGConfigurationErrorException
accessServiceOptions - options passed to the access service.accessServiceName - name of calling serviceauditLog - audit log for error messagesOMAGConfigurationErrorException - the supported zones property is not a list of zone names.protected void registerWithEnterpriseTopic(String accessServiceName, String serverName, OMRSTopicConnector omrsTopicConnector, OMRSTopicListener omrsTopicListener, OMRSAuditLog auditLog) throws OMAGConfigurationErrorException
accessServiceName - name of calling access serviceserverName - name of OMAG Server instanceomrsTopicConnector - topic connector to register withomrsTopicListener - listener to registerauditLog - audit log to record messagesOMAGConfigurationErrorException - problem with topic connectionprotected String getTopicName(Connection connection)
connection - connection objectprotected OpenMetadataTopicConnector getInTopicConnector(Connection inTopicConnection, String accessServiceName, OMRSAuditLog parentAuditLog) throws OMAGConfigurationErrorException
inTopicConnection - connection from the configuration propertiesaccessServiceName - name of the calling access serviceparentAuditLog - audit log from the admin componentOMAGConfigurationErrorException - problem creating connectorprotected OpenMetadataTopicConnector getOutTopicConnector(Connection outTopicConnection, String accessServiceName, OMRSAuditLog parentAuditLog) throws OMAGConfigurationErrorException
outTopicConnection - connection from the configuration propertiesaccessServiceName - name of the calling access serviceparentAuditLog - audit log from the admin componentOMAGConfigurationErrorException - problem creating connectorCopyright © 2018–2019 ODPi. All rights reserved.