Class SecurityManagerBaseClient

  • Direct Known Subclasses:
    MetadataSourceClient

    public class SecurityManagerBaseClient
    extends java.lang.Object
    SecurityManagerBaseClient supports the common properties and functions for the Data Manager OMAS.
    • Constructor Summary

      Constructors 
      Constructor Description
      SecurityManagerBaseClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      SecurityManagerBaseClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      SecurityManagerBaseClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      SecurityManagerBaseClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, SecurityManagerRESTClient restClient, int maxPageSize)
      Create a new client that is going to be used in an OMAG Server.
      SecurityManagerBaseClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void removeReferenceable​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String elementGUIDParameterName, java.lang.String urlTemplate, java.lang.String methodName)
      Remove the metadata element.
      • Methods inherited from class java.lang.Object

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

      • SecurityManagerBaseClient

        public SecurityManagerBaseClient​(java.lang.String serverName,
                                         java.lang.String serverPlatformURLRoot,
                                         AuditLog auditLog)
                                  throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • SecurityManagerBaseClient

        public SecurityManagerBaseClient​(java.lang.String serverName,
                                         java.lang.String serverPlatformURLRoot)
                                  throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • SecurityManagerBaseClient

        public SecurityManagerBaseClient​(java.lang.String serverName,
                                         java.lang.String serverPlatformURLRoot,
                                         java.lang.String userId,
                                         java.lang.String password)
                                  throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • SecurityManagerBaseClient

        public SecurityManagerBaseClient​(java.lang.String serverName,
                                         java.lang.String serverPlatformURLRoot,
                                         java.lang.String userId,
                                         java.lang.String password,
                                         AuditLog auditLog)
                                  throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • SecurityManagerBaseClient

        public SecurityManagerBaseClient​(java.lang.String serverName,
                                         java.lang.String serverPlatformURLRoot,
                                         SecurityManagerRESTClient restClient,
                                         int maxPageSize)
                                  throws InvalidParameterException
        Create a new client that is going to be used in an OMAG Server.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - client that issues the REST API calls
        maxPageSize - maximum number of results supported by this server
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • Method Detail

      • removeReferenceable

        public void removeReferenceable​(java.lang.String userId,
                                        java.lang.String externalSourceGUID,
                                        java.lang.String externalSourceName,
                                        java.lang.String elementGUID,
                                        java.lang.String elementGUIDParameterName,
                                        java.lang.String urlTemplate,
                                        java.lang.String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Remove the metadata element.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the metadata element to remove
        elementGUIDParameterName - name of parameter passing the elementGUID
        urlTemplate - URL to call (no expected placeholders)
        methodName - calling method
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)