Package org.odpi.openmetadata.adminservices.registration

Class ViewServiceAdmin

java.lang.Object

org.odpi.openmetadata.adminservices.registration.ViewServiceAdmin

public abstract class ViewServiceAdmin
extends Object

ViewServiceAdmin is the interface that a view 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 ViewServiceDescription enumeration.

Constructor Summary

Constructors

Constructor	Description
ViewServiceAdmin()

Method Summary

Modifier and Type	Method	Description
String	getFullServiceName()	Return the cached service name.
abstract void	initialize(String serverName, org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig viewServiceConfig, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, String serverUserName, int maxPageSize)	Initialize the view service.
void	setFullServiceName(String fullServiceName)	Set up the cached service name.
abstract void	shutdown()	Shutdown the view service.

Methods inherited from class java.lang.Object

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

Constructor Details

ViewServiceAdmin

public ViewServiceAdmin()

Method Details

initialize

public abstract void initialize(String serverName,
 org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig viewServiceConfig,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog,
 String serverUserName,
 int maxPageSize)
                         throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Initialize the view service.

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 on OMRS calls where there is no end user.

maxPageSize - maximum page size. 0 means unlimited

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - invalid parameters in the configuration properties.

shutdown

public abstract void shutdown()

Shutdown the view service.

getFullServiceName

public String getFullServiceName()

Return the cached service name.

Returns:

string name

setFullServiceName

public void setFullServiceName(String fullServiceName)

Set up the cached service name.

Parameters:

fullServiceName - string name