Class EngineHostClient


  • public class EngineHostClient
    extends java.lang.Object
    GovernanceEngineClient is a client-side library for calling a specific governance engine with a governance server.
    • Constructor Summary

      Constructors 
      Constructor Description
      EngineHostClient​(java.lang.String serverPlatformRootURL, java.lang.String serverName)
      Create a client-side object for calling a governance engine.
      EngineHostClient​(java.lang.String serverPlatformRootURL, java.lang.String serverName, java.lang.String userId, java.lang.String password)
      Create a client-side object for calling a governance engine.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void refreshConfig​(java.lang.String userId, java.lang.String governanceEngineName)
      Request that the governance engine refresh its configuration by calling the metadata server.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • EngineHostClient

        public EngineHostClient​(java.lang.String serverPlatformRootURL,
                                java.lang.String serverName)
                         throws InvalidParameterException
        Create a client-side object for calling a governance engine.
        Parameters:
        serverPlatformRootURL - the root url of the platform where the governance engine is running.
        serverName - the name of the governance server where the governance engine is running
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
      • EngineHostClient

        public EngineHostClient​(java.lang.String serverPlatformRootURL,
                                java.lang.String serverName,
                                java.lang.String userId,
                                java.lang.String password)
                         throws InvalidParameterException
        Create a client-side object for calling a governance engine.
        Parameters:
        serverPlatformRootURL - the root url of the platform where the governance engine is running.
        serverName - the name of the governance server where the governance engine is running
        userId - user id for the HTTP request
        password - password for the HTTP request
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
    • Method Detail

      • refreshConfig

        public void refreshConfig​(java.lang.String userId,
                                  java.lang.String governanceEngineName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Request that the governance engine refresh its configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the governance server is initializing. This request just ensures that the latest configuration is in use.
        Parameters:
        userId - identifier of calling user
        governanceEngineName - qualifiedName of the governance engine to target
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        UserNotAuthorizedException - user not authorized to issue this request.
        PropertyServerException - there was a problem detected by the governance engine.