Class ViewServiceAdmin

java.lang.Object
org.odpi.openmetadata.adminservices.registration.ViewServiceAdmin
Direct Known Subclasses:
DinoViewAdmin, GlossaryAuthorViewAdmin, GlossaryBrowserAdmin, GlossaryWorkflowAdmin, MyProfileAdmin, RexViewAdmin, ServerAuthorViewAdmin, TexViewAdmin

public abstract class ViewServiceAdmin extends Object
ViewServiceAdmin is the interface that an 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.
  • Field Details

  • Constructor Details

    • ViewServiceAdmin

      public ViewServiceAdmin()
  • Method Details

    • initialize

      public abstract void initialize(String serverName, ViewServiceConfig viewServiceConfigurationProperties, AuditLog auditLog, String serverUserName, int maxPageSize) throws OMAGConfigurationErrorException
      Initialize the view service.
      Parameters:
      serverName - name of the local server
      viewServiceConfigurationProperties - 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:
      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
    • logBadConfiguration

      protected void logBadConfiguration(String viewServiceFullName, String propertyName, String propertyValue, AuditLog auditLog, String methodName) throws OMAGConfigurationErrorException
      Log that the configuration is not valid
      Parameters:
      viewServiceFullName - name of the calling view service
      propertyName - name of the property in error
      propertyValue - value of the property that is in error
      auditLog - log to write message to
      methodName - calling method
      Throws:
      OMAGConfigurationErrorException - exception documenting the error
    • logBadConfigProperties

      protected void logBadConfigProperties(String viewServiceFullName, String propertyName, String propertyValue, AuditLog auditLog, String methodName, Throwable error) throws OMAGConfigurationErrorException
      Log that a property value is incorrect.
      Parameters:
      viewServiceFullName - name of the calling view service
      propertyName - name of the property in error
      propertyValue - value of the property that is in error
      auditLog - log to write message to
      methodName - calling method
      error - resulting exception
      Throws:
      OMAGConfigurationErrorException - exception documenting the error
    • throwUnexpectedInitializationException

      protected void throwUnexpectedInitializationException(String actionDescription, String fullViewServiceName, Throwable error) throws OMAGConfigurationErrorException
      Log that an unexpected exception was received during start up.
      Parameters:
      actionDescription - calling method
      fullViewServiceName - name of the view service
      error - exception that was caught
      Throws:
      OMAGConfigurationErrorException - wrapped exception