Package org.odpi.openmetadata.viewservices.serverauthor.admin

Class ServerAuthorViewAdmin

java.lang.Object

org.odpi.openmetadata.adminservices.configuration.registration.ViewServiceAdmin

org.odpi.openmetadata.viewservices.serverauthor.admin.ServerAuthorViewAdmin

public class ServerAuthorViewAdmin
extends ViewServiceAdmin

ServerAuthorViewAdmin is the class that is called by the UI Server to initialize and terminate the Server Author OMVS. The initialization call provides this OMVS with the Audit log and configuration.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	resourceEndpointsPropertyName	resource endpoints property name

Fields inherited from class org.odpi.openmetadata.adminservices.configuration.registration.ViewServiceAdmin

remoteServerName, remoteServerURL

Constructor Summary

Constructors

Constructor	Description
ServerAuthorViewAdmin()	Default constructor

Method Summary

Modifier and Type	Method	Description
protected List<ResourceEndpointConfig>	extractResourceEndpoints(List<ResourceEndpointConfig> resourceEndpoints, String viewServiceFullName, AuditLog auditLog)	Extract the resource endpoints property from the view services option.
void	initialize(String serverName, ViewServiceConfig viewServiceConfig, AuditLog auditLog, String serverUserName, int maxPageSize)	Initialize the Server Author view service.
void	shutdown()	Shutdown the Server Author view service.

Methods inherited from class org.odpi.openmetadata.adminservices.configuration.registration.ViewServiceAdmin

getFullServiceName, logBadConfigProperties, logBadConfiguration, setFullServiceName, throwUnexpectedInitializationException

Methods inherited from class java.lang.Object

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

Field Detail

resourceEndpointsPropertyName

protected String resourceEndpointsPropertyName

resource endpoints property name

Constructor Detail

ServerAuthorViewAdmin

public ServerAuthorViewAdmin()

Default constructor

Method Detail

initialize

public void initialize(String serverName,
                       ViewServiceConfig viewServiceConfig,
                       AuditLog auditLog,
                       String serverUserName,
                       int maxPageSize)
                throws OMAGConfigurationErrorException

Initialize the Server Author view service.

Specified by:

initialize in class ViewServiceAdmin

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.

maxPageSize - maximum page size. 0 means unlimited

Throws:

OMAGConfigurationErrorException - invalid parameters in the configuration properties.

shutdown

public void shutdown()

Shutdown the Server Author view service.

Specified by:

shutdown in class ViewServiceAdmin

extractResourceEndpoints

protected List<ResourceEndpointConfig> extractResourceEndpoints(List<ResourceEndpointConfig> resourceEndpoints,
                                                                String viewServiceFullName,
                                                                AuditLog auditLog)
                                                         throws OMAGConfigurationErrorException

Extract the resource endpoints property from the view services option.

Parameters:

resourceEndpoints - options passed to the access service.

viewServiceFullName - name of calling service

auditLog - audit log for error messages

Returns:

null or list of resource endpoints

Throws:

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