Class ITInfrastructureRESTClient


  • public class ITInfrastructureRESTClient
    extends OCFRESTClient
    ITInfrastructureRESTClient is responsible for issuing calls to the OMAS REST APIs.
    • Constructor Detail

      • ITInfrastructureRESTClient

        public ITInfrastructureRESTClient​(java.lang.String serverName,
                                          java.lang.String serverPlatformURLRoot,
                                          AuditLog auditLog)
                                   throws InvalidParameterException
        Constructor for no authentication with audit log.
        Parameters:
        serverName - name of the OMAG Server to call
        serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
        auditLog - destination for log messages.
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ITInfrastructureRESTClient

        public ITInfrastructureRESTClient​(java.lang.String serverName,
                                          java.lang.String serverPlatformURLRoot)
                                   throws InvalidParameterException
        Constructor for no authentication.
        Parameters:
        serverName - name of the OMAG Server to call
        serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ITInfrastructureRESTClient

        public ITInfrastructureRESTClient​(java.lang.String serverName,
                                          java.lang.String serverPlatformURLRoot,
                                          java.lang.String userId,
                                          java.lang.String password,
                                          AuditLog auditLog)
                                   throws InvalidParameterException
        Constructor for simple userId and password authentication with audit log.
        Parameters:
        serverName - name of the OMAG Server to call
        serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
        userId - user id for the HTTP request
        password - password for the HTTP request
        auditLog - destination for log messages.
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ITInfrastructureRESTClient

        public ITInfrastructureRESTClient​(java.lang.String serverName,
                                          java.lang.String serverPlatformURLRoot,
                                          java.lang.String userId,
                                          java.lang.String password)
                                   throws InvalidParameterException
        Constructor for simple userId and password authentication.
        Parameters:
        serverName - name of the OMAG Server to call
        serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
        userId - user id for the HTTP request
        password - password for the HTTP request
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • Method Detail

      • callConnectionsPostRESTCall

        public ConnectionsResponse callConnectionsPostRESTCall​(java.lang.String methodName,
                                                               java.lang.String urlTemplate,
                                                               java.lang.Object requestBody,
                                                               java.lang.Object... params)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               PropertyServerException
        Issue a POST REST call that returns a ConnectionsResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - properties describing the valid value definition/set
        params - a list of parameters that are slotted into the url template.
        Returns:
        ConnectionsResponse
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • callConnectorTypesPostRESTCall

        public ConnectorTypesResponse callConnectorTypesPostRESTCall​(java.lang.String methodName,
                                                                     java.lang.String urlTemplate,
                                                                     java.lang.Object requestBody,
                                                                     java.lang.Object... params)
                                                              throws InvalidParameterException,
                                                                     UserNotAuthorizedException,
                                                                     PropertyServerException
        Issue a POST REST call that returns a ConnectorTypesResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - properties describing the valid value definition/set
        params - a list of parameters that are slotted into the url template.
        Returns:
        ConnectorTypesResponse
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • callEndpointsPostRESTCall

        public EndpointsResponse callEndpointsPostRESTCall​(java.lang.String methodName,
                                                           java.lang.String urlTemplate,
                                                           java.lang.Object requestBody,
                                                           java.lang.Object... params)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException
        Issue a POST REST call that returns a EndpointsResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - properties describing the valid value definition/set
        params - a list of parameters that are slotted into the url template.
        Returns:
        EndpointsResponse
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • callITProfileListPostRESTCall

        public ITProfileListResponse callITProfileListPostRESTCall​(java.lang.String methodName,
                                                                   java.lang.String urlTemplate,
                                                                   java.lang.Object requestBody,
                                                                   java.lang.Object... params)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException
        Issue a GET REST call that returns a list of ITProfileElements in a response object.
        Parameters:
        methodName - name of the method being called
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters
        requestBody - request body for the request
        params - a list of parameters that are slotted into the url template
        Returns:
        response object
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - something went wrong with the REST call stack.
      • callUserIdentityListPostRESTCall

        public UserIdentityListResponse callUserIdentityListPostRESTCall​(java.lang.String methodName,
                                                                         java.lang.String urlTemplate,
                                                                         java.lang.Object requestBody,
                                                                         java.lang.Object... params)
                                                                  throws InvalidParameterException,
                                                                         UserNotAuthorizedException,
                                                                         PropertyServerException
        Issue a POST REST call that returns a list of UserIdentityElements in a response object.
        Parameters:
        methodName - name of the method being called
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters
        requestBody - request body for the request
        params - a list of parameters that are slotted into the url template
        Returns:
        UserIdentityListResponse
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - something went wrong with the REST call stack.
      • callSoftwareServerCapabilityListPostRESTCall

        public SoftwareCapabilityListResponse callSoftwareServerCapabilityListPostRESTCall​(java.lang.String methodName,
                                                                                           java.lang.String urlTemplate,
                                                                                           java.lang.Object requestBody,
                                                                                           java.lang.Object... params)
                                                                                    throws InvalidParameterException,
                                                                                           UserNotAuthorizedException,
                                                                                           PropertyServerException
        Issue a POST REST call that returns a list of SoftwareServerCapabilityElements in a response object.
        Parameters:
        methodName - name of the method being called
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters
        requestBody - request body for the request
        params - a list of parameters that are slotted into the url template
        Returns:
        response objects
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - something went wrong with the REST call stack.
      • callAssetPostRESTCall

        public AssetResponse callAssetPostRESTCall​(java.lang.String methodName,
                                                   java.lang.String urlTemplate,
                                                   java.lang.Object requestBody,
                                                   java.lang.Object... params)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException
        Issue a POST REST call that returns an asset in a response object.
        Parameters:
        methodName - name of the method being called
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters
        requestBody - request body for the request
        params - a list of parameters that are slotted into the url template
        Returns:
        response object
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - something went wrong with the REST call stack.
      • callAssetListPostRESTCall

        public AssetListResponse callAssetListPostRESTCall​(java.lang.String methodName,
                                                           java.lang.String urlTemplate,
                                                           java.lang.Object requestBody,
                                                           java.lang.Object... params)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException
        Issue a POST REST call that returns a list of AssetElements in a response object.
        Parameters:
        methodName - name of the method being called
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters
        requestBody - request body for the request
        params - a list of parameters that are slotted into the url template
        Returns:
        response objects
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - something went wrong with the REST call stack.
      • callAssetRelationshipListPostRESTCall

        public AssetRelationshipListResponse callAssetRelationshipListPostRESTCall​(java.lang.String methodName,
                                                                                   java.lang.String urlTemplate,
                                                                                   java.lang.Object requestBody,
                                                                                   java.lang.Object... params)
                                                                            throws InvalidParameterException,
                                                                                   UserNotAuthorizedException,
                                                                                   PropertyServerException
        Issue a POST REST call that returns a list of AssetRelationshipListResponse in a response object.
        Parameters:
        methodName - name of the method being called
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters
        requestBody - request body for the request
        params - a list of parameters that are slotted into the url template
        Returns:
        response objects
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - something went wrong with the REST call stack.
      • callRelatedAssetListPostRESTCall

        public RelatedAssetListResponse callRelatedAssetListPostRESTCall​(java.lang.String methodName,
                                                                         java.lang.String urlTemplate,
                                                                         java.lang.Object requestBody,
                                                                         java.lang.Object... params)
                                                                  throws InvalidParameterException,
                                                                         UserNotAuthorizedException,
                                                                         PropertyServerException
        Issue a POST REST call that returns a list of RelatedAssetElements in a response object.
        Parameters:
        methodName - name of the method being called
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters
        requestBody - request body for the request
        params - a list of parameters that are slotted into the url template
        Returns:
        response objects
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - something went wrong with the REST call stack.
      • callServerAssetUseListPostRESTCall

        public ServerAssetUseListResponse callServerAssetUseListPostRESTCall​(java.lang.String methodName,
                                                                             java.lang.String urlTemplate,
                                                                             java.lang.Object requestBody,
                                                                             java.lang.Object... params)
                                                                      throws InvalidParameterException,
                                                                             UserNotAuthorizedException,
                                                                             PropertyServerException
        Issue a POST REST call that returns a list of ServerAssetUseElements in a response object.
        Parameters:
        methodName - name of the method being called
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters
        requestBody - request body for the request
        params - a list of parameters that are slotted into the url template
        Returns:
        response objects
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - something went wrong with the REST call stack.
      • callSupportedCapabilityListPostRESTCall

        public SupportedCapabilityListResponse callSupportedCapabilityListPostRESTCall​(java.lang.String methodName,
                                                                                       java.lang.String urlTemplate,
                                                                                       java.lang.Object requestBody,
                                                                                       java.lang.Object... params)
                                                                                throws InvalidParameterException,
                                                                                       UserNotAuthorizedException,
                                                                                       PropertyServerException
        Issue a POST REST call that returns a list of SupportedCapabilityElements in a response object.
        Parameters:
        methodName - name of the method being called
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters
        requestBody - request body for the request
        params - a list of parameters that are slotted into the url template
        Returns:
        response objects
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - something went wrong with the REST call stack.
      • callDataFlowPostRESTCall

        public DataFlowElementResponse callDataFlowPostRESTCall​(java.lang.String methodName,
                                                                java.lang.String urlTemplate,
                                                                java.lang.Object requestBody,
                                                                java.lang.Object... params)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException
        Issue a POST REST call that returns a DataFlowElementResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - object that passes additional parameters
        params - a list of parameters that are slotted into the url template.
        Returns:
        response object
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • callDataFlowsPostRESTCall

        public DataFlowElementsResponse callDataFlowsPostRESTCall​(java.lang.String methodName,
                                                                  java.lang.String urlTemplate,
                                                                  java.lang.Object requestBody,
                                                                  java.lang.Object... params)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException
        Issue a POST REST call that returns a DataFlowElementsResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - object that passes additional parameters
        params - a list of parameters that are slotted into the url template.
        Returns:
        response object
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • callControlFlowPostRESTCall

        public ControlFlowElementResponse callControlFlowPostRESTCall​(java.lang.String methodName,
                                                                      java.lang.String urlTemplate,
                                                                      java.lang.Object requestBody,
                                                                      java.lang.Object... params)
                                                               throws InvalidParameterException,
                                                                      UserNotAuthorizedException,
                                                                      PropertyServerException
        Issue a POST REST call that returns a ControlFlowElementResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - object that passes additional parameters
        params - a list of parameters that are slotted into the url template.
        Returns:
        response object
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • callControlFlowsPostRESTCall

        public ControlFlowElementsResponse callControlFlowsPostRESTCall​(java.lang.String methodName,
                                                                        java.lang.String urlTemplate,
                                                                        java.lang.Object requestBody,
                                                                        java.lang.Object... params)
                                                                 throws InvalidParameterException,
                                                                        UserNotAuthorizedException,
                                                                        PropertyServerException
        Issue a POST REST call that returns a ControlFlowElementsResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - object that passes additional parameters
        params - a list of parameters that are slotted into the url template.
        Returns:
        response object
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • callProcessCallPostRESTCall

        public ProcessCallElementResponse callProcessCallPostRESTCall​(java.lang.String methodName,
                                                                      java.lang.String urlTemplate,
                                                                      java.lang.Object requestBody,
                                                                      java.lang.Object... params)
                                                               throws InvalidParameterException,
                                                                      UserNotAuthorizedException,
                                                                      PropertyServerException
        Issue a POST REST call that returns a ProcessCallElementResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - object that passes additional parameters
        params - a list of parameters that are slotted into the url template.
        Returns:
        response object
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • callProcessCallsPostRESTCall

        public ProcessCallElementsResponse callProcessCallsPostRESTCall​(java.lang.String methodName,
                                                                        java.lang.String urlTemplate,
                                                                        java.lang.Object requestBody,
                                                                        java.lang.Object... params)
                                                                 throws InvalidParameterException,
                                                                        UserNotAuthorizedException,
                                                                        PropertyServerException
        Issue a POST REST call that returns a ProcessCallElementsResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - object that passes additional parameters
        params - a list of parameters that are slotted into the url template.
        Returns:
        response object
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • callLineageMappingPostRESTCall

        public LineageMappingElementResponse callLineageMappingPostRESTCall​(java.lang.String methodName,
                                                                            java.lang.String urlTemplate,
                                                                            java.lang.Object requestBody,
                                                                            java.lang.Object... params)
                                                                     throws InvalidParameterException,
                                                                            UserNotAuthorizedException,
                                                                            PropertyServerException
        Issue a POST REST call that returns a LineageMappingElementResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - object that passes additional parameters
        params - a list of parameters that are slotted into the url template.
        Returns:
        response object
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • callLineageMappingsPostRESTCall

        public LineageMappingElementsResponse callLineageMappingsPostRESTCall​(java.lang.String methodName,
                                                                              java.lang.String urlTemplate,
                                                                              java.lang.Object requestBody,
                                                                              java.lang.Object... params)
                                                                       throws InvalidParameterException,
                                                                              UserNotAuthorizedException,
                                                                              PropertyServerException
        Issue a POST REST call that returns a LineageMappingElementsResponse object.
        Parameters:
        methodName - name of the method being called.
        urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
        requestBody - object that passes additional parameters
        params - a list of parameters that are slotted into the url template.
        Returns:
        response object
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.