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.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenMetadataAPIRootHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler repositoryHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String localServerUserId, org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Construct the handler information needed to interact with the repository services

  • Method Summary

    Modifier and Type
    Method
    Description
    OpenMetadataAPIGenericConverter<B>
    getConverter()
    Return this handler's converter.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementStub
    getElementStub(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityProxy)
    Convert an entity proxy into an element stub.
    org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler
    getRepositoryHandler()
    Return the repository handler for this server.
    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper
    getRepositoryHelper()
    Return the repository helper for this server.
    String
    getServerName()
    Return the name of this server.
    String
    getServiceName()
    Return the name of this service.
    List<String>
    getSupportedZones()
    Return the list of zones to use for retrieving assets.
    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef
    getTypeDefByName(String suppliedTypeName, String defaultTypeName)
    Return the type definition for the named type.
    void
    setSecurityVerifier(org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier securityVerifier)
    Set up a new security verifier (the handler runs with a default verifier until this method is called).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OpenMetadataAPIRootHandler

      public OpenMetadataAPIRootHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler repositoryHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String localServerUserId, org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, org.odpi.openmetadata.frameworks.auditlog.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
      supportedZones - list of zones that the access service is allowed to serve Asset instances from.
      defaultZones - list of zones that the access service should set in all new Asset instances.
      publishZones - list of zones that the access service sets up in published Asset instances.
      auditLog - destination for audit log events.

  • Method Details

    • getConverter

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

    • setSecurityVerifier

      public void setSecurityVerifier(org.odpi.openmetadata.metadatasecurity.server.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 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper getRepositoryHelper()
      Return the repository helper for this server.
      Returns:
      repository helper object

    • getRepositoryHandler

      public org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler getRepositoryHandler()
      Return the repository handler for this server.
      Returns:
      repository handler object

    • getElementStub

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementStub getElementStub(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityProxy) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Convert an entity proxy into an element stub.
      Parameters:
      entityProxy - proxy to convert
      Returns:
      element stub
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - null entity proxy

    • getSupportedZones

      public List<String> getSupportedZones()
      Return the list of zones to use for retrieving assets.
      Returns:
      list of zone names

    • getTypeDefByName

      public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.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

    • getServerName

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