Package org.odpi.openmetadata.metadatasecurity

Interface OpenMetadataPlatformSecurity

All Known Implementing Classes:
CocoPharmaPlatformSecurityConnector, CocoPharmaPlatformSecurityConnectorTokenBased, CocoPharmaSecretsSecurityConnector, OpenMetadataPlatformSecurityConnector
public interface OpenMetadataPlatformSecurity
OpenMetadataPlatformSecurity provides the interface for a security connector that validates whether a calling user can access any service on an OMAG Server Platform. It is called within the context of a specific OMAG Server Platform request. Each OMAG Server can define its own plugin connector implementation and will have its own instance of the connector.

  • Method Details

    • setServerPlatformURL

      void setServerPlatformURL(String serverURLRoot)
      Set up the URL Root for the platform where this is running.
      Parameters:
      serverURLRoot - url root

    • validateUserForNewServer

      void validateUserForNewServer(String userId) throws UserNotAuthorizedException
      Check that the calling user is authorized to create new servers.
      Parameters:
      userId - calling user
      Throws:
      UserNotAuthorizedException - the user is not authorized to access this platform

    • validateUserAsOperatorForPlatform

      void validateUserAsOperatorForPlatform(String userId) throws UserNotAuthorizedException
      Check that the calling user is authorized to issue operator requests to the OMAG Server Platform.
      Parameters:
      userId - calling user
      Throws:
      UserNotAuthorizedException - the user is not authorized to issue operator commands to this platform

    • validateUserAsInvestigatorForPlatform

      void validateUserAsInvestigatorForPlatform(String userId) throws UserNotAuthorizedException
      Check that the calling user is authorized to issue diagnostic requests to the OMAG Server Platform.
      Parameters:
      userId - calling user
      Throws:
      UserNotAuthorizedException - the user is not authorized to issue diagnostic commands to this platform