Class ConnectorTypeManagerClient

    • Constructor Summary

      Constructors 
      Constructor Description
      ConnectorTypeManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      ConnectorTypeManagerClient​(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.
      ConnectorTypeManagerClient​(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.
      ConnectorTypeManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)
      Create a new client that is going to be used in an OMAG Server.
      ConnectorTypeManagerClient​(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
      java.lang.String createConnectorType​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, ConnectorTypeProperties connectorTypeProperties)
      Create a new metadata element to represent an connectorType
      java.lang.String createConnectorTypeFromTemplate​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent an connectorType using an existing metadata element as a template.
      java.util.List<ConnectorTypeElement> findConnectorTypes​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of connector type metadata elements that contain the search string.
      ConnectorTypeElement getConnectorTypeByGUID​(java.lang.String userId, java.lang.String connectorTypeGUID)
      Retrieve the connector type metadata element with the supplied unique identifier.
      java.util.List<ConnectorTypeElement> getConnectorTypesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of connector type metadata elements with a matching qualified name, display name or connector provider class name.
      void removeConnectorType​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String connectorTypeGUID)
      Remove the metadata element representing an connectorType.
      void updateConnectorType​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean isMergeUpdate, java.lang.String connectorTypeGUID, ConnectorTypeProperties connectorTypeProperties)
      Update the metadata element representing an connectorType.
      • Methods inherited from class java.lang.Object

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

      • ConnectorTypeManagerClient

        public ConnectorTypeManagerClient​(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.
      • ConnectorTypeManagerClient

        public ConnectorTypeManagerClient​(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.
      • ConnectorTypeManagerClient

        public ConnectorTypeManagerClient​(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.
      • ConnectorTypeManagerClient

        public ConnectorTypeManagerClient​(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.
      • ConnectorTypeManagerClient

        public ConnectorTypeManagerClient​(java.lang.String serverName,
                                          java.lang.String serverPlatformURLRoot,
                                          ITInfrastructureRESTClient 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.