Package org.odpi.openmetadata.commonservices.generichandlers

Class OpenMetadataAPIRootHandler<B>

java.lang.Object
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler<B>
Type Parameters:
B - bean class
Direct Known Subclasses:
OpenMetadataAPIAnchorHandler
public class OpenMetadataAPIRootHandler<B> extends Object
OpenMetadataAPIRootHandler provides the common properties for the generic handlers.

  • Field Details

  • Constructor Details

    • OpenMetadataAPIRootHandler

      public OpenMetadataAPIRootHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, AuditLog auditLog)
      Construct the handler information needed to interact with the repository services
      Parameters:
      converter - specific converter for this bean class
      beanClass - name of bean class that is represented by the generic class B
      serviceName - name of this service
      serverName - name of the local server
      invalidParameterHandler - handler for managing parameter errors
      repositoryHandler - manages calls to the repository services
      repositoryHelper - provides utilities for manipulating the repository services objects
      localServerUserId - userId for this server
      securityVerifier - open metadata security services verifier
      auditLog - destination for audit log events.

  • Method Details

    • getConverter

      public OpenMetadataAPIGenericConverter<B> getConverter()
      Return this handler's converter.
      Returns:
      converter

    • setSecurityVerifier

      public void setSecurityVerifier(OpenMetadataServerSecurityVerifier securityVerifier)
      Set up a new security verifier (the handler runs with a default verifier until this method is called).

      The security verifier provides authorization checks for access and maintenance changes to open metadata. Authorization checks are enabled through the OpenMetadataServerSecurityConnector.
      Parameters:
      securityVerifier - new security verifier

    • getRepositoryHelper

      public OMRSRepositoryHelper getRepositoryHelper()
      Return the repository helper for this server.
      Returns:
      repository helper object

    • getRepositoryHandler

      public RepositoryHandler getRepositoryHandler()
      Return the repository handler for this server.
      Returns:
      repository handler object

    • getElementStub

      public ElementStub getElementStub(EntityProxy entityProxy) throws PropertyServerException
      Convert an entity proxy into an element stub.
      Parameters:
      entityProxy - proxy to convert
      Returns:
      element stub
      Throws:
      PropertyServerException - null entity proxy

    • getTypeDefByName

      public TypeDef getTypeDefByName(String suppliedTypeName, String defaultTypeName)
      Return the type definition for the named type.
      Parameters:
      suppliedTypeName - caller's subtype (or null)
      defaultTypeName - common super type
      Returns:
      type definition

    • getServiceName

      public String getServiceName()
      Return the name of this service.
      Returns:
      string name

    • isObservedAnchorType

      protected boolean isObservedAnchorType(String typeName)
      Is this the type of anchor element whose activity is reported in the audit log with the METADATA-OBSERVABILITY messages? These are the elements whose popularity is of interest to the people using the open metadata ecosystem: assets, digital products and glossary terms.
      Parameters:
      typeName - name of the element's type
      Returns:
      boolean

    • getServerName

      public String getServerName()
      Return the name of this server.
      Returns:
      string name

    • forLog

      protected static String forLog(String value)
      Return a caller-supplied value ready to write to the log. Line breaks are replaced so that a value cannot start what looks like a new log entry.
      Parameters:
      value - value supplied by the caller
      Returns:
      value without line breaks