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

Class ServerAuthorViewAdmin

java.lang.Object
org.odpi.openmetadata.adminservices.registration.ViewServiceAdmin
org.odpi.openmetadata.viewservices.serverauthor.admin.ServerAuthorViewAdmin
public class ServerAuthorViewAdmin extends org.odpi.openmetadata.adminservices.registration.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.registration.ViewServiceAdmin

    remoteServerName, remoteServerURL

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServerAuthorViewAdmin()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    protected List<org.odpi.openmetadata.adminservices.configuration.properties.ResourceEndpointConfig>
    extractResourceEndpoints(List<org.odpi.openmetadata.adminservices.configuration.properties.ResourceEndpointConfig> resourceEndpoints, String viewServiceFullName, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Extract the resource endpoints property from the view services option.
    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 Server Author view service.
    void
    shutdown()
    Shutdown the Server Author view service.

    Methods inherited from class org.odpi.openmetadata.adminservices.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 Details

    • resourceEndpointsPropertyName

      protected String resourceEndpointsPropertyName
      resource endpoints property name

  • Constructor Details

    • ServerAuthorViewAdmin

      public ServerAuthorViewAdmin()
      Default constructor

  • Method Details

    • initialize

      public 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 Server Author view service.
      Specified by:
      initialize in class org.odpi.openmetadata.adminservices.registration.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:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - invalid parameters in the configuration properties.

    • shutdown

      public void shutdown()
      Shutdown the Server Author view service.
      Specified by:
      shutdown in class org.odpi.openmetadata.adminservices.registration.ViewServiceAdmin

    • extractResourceEndpoints

      protected List<org.odpi.openmetadata.adminservices.configuration.properties.ResourceEndpointConfig> extractResourceEndpoints(List<org.odpi.openmetadata.adminservices.configuration.properties.ResourceEndpointConfig> resourceEndpoints, String viewServiceFullName, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.adminservices.ffdc.exception.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:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - the supported zones property is not a list of zone names.