org.odpi.openmetadata.adminservices.configuration.registration

Interface AccessServiceAdmin

public interface AccessServiceAdmin

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
static String	karmaPointPlateauPropertyName
static String	supportedZonesPropertyName

Method Summary

Modifier and Type	Method and Description
void	initialize(AccessServiceConfig accessServiceConfigurationProperties, OMRSTopicConnector enterpriseOMRSTopicConnector, OMRSRepositoryConnector enterpriseOMRSRepositoryConnector, OMRSAuditLog auditLog, String serverUserName) Initialize the access service.
void	shutdown() Shutdown the access service.

Field Detail

supportedZonesPropertyName

static final String supportedZonesPropertyName

See Also:

Constant Field Values

karmaPointPlateauPropertyName

static final String karmaPointPlateauPropertyName

See Also:

Constant Field Values

Method Detail

initialize

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

void shutdown()

Shutdown the access service.