org.odpi.openmetadata.adminservices.configuration.registration

Class AccessServiceAdmin

java.lang.Object

org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceAdmin

public abstract class AccessServiceAdmin
extends Object

AccessServiceAdmin is the interface that an access service implements to receive its configuration. The java class that implements this interface is created with a default constructor and then the initialize method is called. It is configured in the AccessServiceDescription enumeration.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultZonesPropertyName
protected String	karmaPointIncrementPropertyName
protected String	karmaPointPlateauPropertyName
protected String	supportedZonesPropertyName

Constructor Summary

Constructors

Constructor and Description
AccessServiceAdmin()

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

supportedZonesPropertyName

protected String supportedZonesPropertyName

defaultZonesPropertyName

protected String defaultZonesPropertyName

karmaPointPlateauPropertyName

protected String karmaPointPlateauPropertyName

karmaPointIncrementPropertyName

protected String karmaPointIncrementPropertyName

Constructor Detail

AccessServiceAdmin

public AccessServiceAdmin()

Method Detail

initialize

public abstract void initialize(AccessServiceConfig accessServiceConfigurationProperties,
                                OMRSTopicConnector enterpriseOMRSTopicConnector,
                                OMRSRepositoryConnector enterpriseOMRSRepositoryConnector,
                                OMRSAuditLog auditLog,
                                String serverUserName)
                         throws OMAGConfigurationErrorException

Initialize the access service.

Parameters:

accessServiceConfigurationProperties - specific configuration properties for this access service.

enterpriseOMRSTopicConnector - connector for receiving OMRS Events from the cohorts

enterpriseOMRSRepositoryConnector - connector for querying the cohort repositories

auditLog - audit log component for logging messages.

serverUserName - user id to use on OMRS calls where there is no end user.

Throws:

OMAGConfigurationErrorException - invalid parameters in the configuration properties.

shutdown

public abstract void shutdown()

Shutdown the access service.

extractSupportedZones

protected List<String> extractSupportedZones(Map<String,Object> accessServiceOptions,
                                             String accessServiceName,
                                             OMRSAuditLog auditLog)
                                      throws OMAGConfigurationErrorException

Extract the supported zones property from the access services option.

Parameters:

accessServiceOptions - options passed to the access service.

accessServiceName - name of calling service

auditLog - audit log for error messages

Returns:

null or list of zone names

Throws:

OMAGConfigurationErrorException - the supported zones property is not a list of zone names.

extractDefaultZones

protected List<String> extractDefaultZones(Map<String,Object> accessServiceOptions,
                                           String accessServiceName,
                                           OMRSAuditLog auditLog)
                                    throws OMAGConfigurationErrorException

Extract the default zones property from the access services option.

Parameters:

accessServiceOptions - options passed to the access service.

accessServiceName - name of calling service

auditLog - audit log for error messages

Returns:

null or list of zone names

Throws:

OMAGConfigurationErrorException - the supported zones property is not a list of zone names.

extractKarmaPointIncrement

protected int extractKarmaPointIncrement(Map<String,Object> accessServiceOptions,
                                         String accessServiceName,
                                         OMRSAuditLog auditLog)
                                  throws OMAGConfigurationErrorException

Extract the karma point plateau property from the access services option.

Parameters:

accessServiceOptions - options passed to the access service.

accessServiceName - name of calling service

auditLog - audit log for error messages

Returns:

null or list of zone names

Throws:

OMAGConfigurationErrorException - the supported zones property is not a list of zone names.

extractKarmaPointPlateau

protected int extractKarmaPointPlateau(Map<String,Object> accessServiceOptions,
                                       String accessServiceName,
                                       OMRSAuditLog auditLog)
                                throws OMAGConfigurationErrorException

Extract the karma point plateau property from the access services option.

Parameters:

accessServiceOptions - options passed to the access service.

accessServiceName - name of calling service

auditLog - audit log for error messages

Returns:

null or list of zone names

Throws:

OMAGConfigurationErrorException - the supported zones property is not a list of zone names.

registerWithEnterpriseTopic

protected void registerWithEnterpriseTopic(String accessServiceName,
                                           String serverName,
                                           OMRSTopicConnector omrsTopicConnector,
                                           OMRSTopicListener omrsTopicListener,
                                           OMRSAuditLog auditLog)
                                    throws OMAGConfigurationErrorException

Register a listener with the enterprise topic connector.

Parameters:

accessServiceName - name of calling access service

serverName - name of OMAG Server instance

omrsTopicConnector - topic connector to register with

omrsTopicListener - listener to register

auditLog - audit log to record messages

Throws:

OMAGConfigurationErrorException - problem with topic connection

getTopicName

protected String getTopicName(Connection connection)

Return the name of the topic extracted from the endpoint of the topic's Connection.

Parameters:

connection - connection object

Returns:

topic name

getInTopicConnector

protected OpenMetadataTopicConnector getInTopicConnector(Connection inTopicConnection,
                                                         String accessServiceName,
                                                         OMRSAuditLog parentAuditLog)
                                                  throws OMAGConfigurationErrorException

Create the connector for this access services' In Topic.

Parameters:

inTopicConnection - connection from the configuration properties

accessServiceName - name of the calling access service

parentAuditLog - audit log from the admin component

Returns:

connector to access the topic

Throws:

OMAGConfigurationErrorException - problem creating connector

getOutTopicConnector

protected OpenMetadataTopicConnector getOutTopicConnector(Connection outTopicConnection,
                                                          String accessServiceName,
                                                          OMRSAuditLog parentAuditLog)
                                                   throws OMAGConfigurationErrorException

Create the connector for this access services' Out Topic.

Parameters:

outTopicConnection - connection from the configuration properties

accessServiceName - name of the calling access service

parentAuditLog - audit log from the admin component

Returns:

connector to access the topic

Throws:

OMAGConfigurationErrorException - problem creating connector