Package org.odpi.openmetadata.viewservices.externalreferences.admin

Class ExternalReferencesAdmin

java.lang.Object

org.odpi.openmetadata.adminservices.registration.ViewServerGenericServiceAdmin

org.odpi.openmetadata.viewservices.externalreferences.admin.ExternalReferencesAdmin

public class ExternalReferencesAdmin
extends ViewServerGenericServiceAdmin

ExternalReferencesAdmin is the class that is called by the View Server to initialize and terminate the External References OMVS. The initialization call provides this OMVS with the Audit log and configuration.

Field Summary

Fields inherited from class org.odpi.openmetadata.adminservices.registration.ViewServerGenericServiceAdmin

remoteServerName, remoteServerURL, supportedTypesForSearch

Constructor Summary

Constructors

Constructor	Description
ExternalReferencesAdmin()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	initialize(String serverName, ViewServiceConfig viewServiceConfig, AuditLog auditLog, String serverUserName, String serverUserPassword, int maxPageSize, List<ViewServiceConfig> activeViewServices)	Initialize the view service.
void	shutdown()	Shutdown the External References service.

Methods inherited from class org.odpi.openmetadata.adminservices.registration.ViewServerGenericServiceAdmin

getFullServiceName, getSupportedTypesForSearchOption, logBadConfigProperties, logBadConfiguration, setFullServiceName, throwUnexpectedInitializationException

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalReferencesAdmin

public ExternalReferencesAdmin()

Default constructor

Method Details

initialize

public void initialize(String serverName,
 ViewServiceConfig viewServiceConfig,
 AuditLog auditLog,
 String serverUserName,
 String serverUserPassword,
 int maxPageSize,
 List<ViewServiceConfig> activeViewServices)
                throws OMAGConfigurationErrorException

Initialize the view service.

Specified by:

initialize in class ViewServerGenericServiceAdmin

Parameters:

serverName - name of the local server

viewServiceConfig - specific configuration properties for this view service.

auditLog - audit log component for logging messages.

serverUserName - user id to use to issue calls to the remote server.

serverUserPassword - password to use as part of an HTTP authentication mechanism.

maxPageSize - maximum page size. 0 means unlimited

activeViewServices - list of view services active in this server

Throws:

OMAGConfigurationErrorException - invalid parameters in the configuration properties.

shutdown

public void shutdown()

Shutdown the External References service.

Specified by:

shutdown in class ViewServerGenericServiceAdmin