You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

WS-DM Interface Specification

This section contains QMan WS-DM Interface Specification.
Each interface will be detailed using a dedicated subsection with the following template:

Name

Description

Description

A brief description of the interface purpose

Request

Analysis of a sample request that the interface expects

Response

Analysis of a sample response that the interface produces 

Error and Exceptions

Enumeration of all faults that are generated in error scenarios

Quick links

Useful external links about the interface (OASIS specs, etc...)

QMan has three different kinds of resources :

  • 1 WSDM Adapter resource, which is the a facade that handles lifecycle of all managed WS-Resource;
  • 0...* QMan WS Resource, which is a web service representation of a managed resource; This is directly part of QMan / Qpid management domain model;
  • 1 Subscription Manager : the WS-Resource that enables notifications and allows clients to register themselves as notification listeners.

WS-DM Adapter WS-Resource

A facade Web service stateful resource that represents a facade resource manager from a requestor endpoint perspective.

Name

Description

MetadataExchange

Defines messages to retrieve metadata associated with the adapter endpoint.

Connect

Allows a requestor to connect QMan with a broker.

GetResourceMembers

Allows a requestor to retrieve the catalogue of all managed resources.

Subscribe

Allows a requestor to be registered as a notification listener.

GetCurrentMessage

Allows a requestor to retrieve the last notification published on a given topic.

QMan WS-Resource

A stateful Qpid entity (that is part of Qpid management domain model) represented as a web service (stateful) instance on QMan side and therefore exposed for management.

Name

Description

MetadataExchange

Defines messages to retrieve metadata associated with a resource.

GetResourcePropertyDocument

Allows a requestor to retrieve the values of all resource properties associated with the resource.

PutResourcePropertyDocument

Allows a requestor to completely replace the values of a resource's properties with an entirely new resource property document.

GetResourceProperty

Allows a requestor to retrieve the value of a single resource property of a resource.

SetResourceProperties

Allows a requestor to modify the values of multiple resource properties of a resource.

GetMultipleResourceProperties

Allows a requestor to retrieve the values of multiple resource properties of a resource.

QueryResourceProperties

Allows arequestor to query the resource properties document of a resource using a query expression.

Subscription Manager WS-Resource

A web service endpoint that provides operations that allow a service requestor to manage subscription resources.

Name

Description

MetadataExchange

Defines messages to retrieve metadata associated with the subscription manager.

PauseSubscription

Allows a requestor to suspend the production of notifications on the given subscription.

ResumeSubscription

Allows a requestor to resume a previously suspended subscription.

  • No labels