Prev   Next

Services and WSDL

Table of Contents

1. Protocol overview
2. Operations
3. Resource properties
4. Faults
5. WSDL and Schema Definition

1. Protocol overview

The DRS provides a set of Resource Properties and SOAP operations to create, manipulate and inspect replication activities. Users will begin by creating a replication resource (AKA "Replicator") by invoking the create operation and passing it a URL of the replication request file (described in the domain-specific interface section). Users may start, stop, suspend and resume the Replicator when necessary. Typically a user is expected to simply start the resource and allow it to run through completion. During and after the course of replication activities performed by the resource, users may invoke standard "get resource property" and DRS-specific "find" operations to inspect the state of the resource. When the resource finishes the replication activities and the user has satisfactorily inspected the resource state, the resource should be destroyed using the standard "destroy" operation.

2. Operations

Supported operations include:

  • createReplicator creates the "Replicator" resource.

    • [in] InitialTerminationTime The requested initial termination time for the resource.

    • [in] requestFileRequest The request-file style request.

      • credentialEPR Endpoint Reference of the user's delegated credential.
      • options Replication options which include a set of options pertinent to the transfer stage of the request, such as concurrency, parallel streams, tcp buffer size, etc.
      • autostart A Boolean flag indicating whether the resource should be automatically started following resource creation.
      • requestFileUri The URI of the request file. Currently supported schemes include http, file, and ftp.
      • format The request file format (domain-specific). Currently, the service only supports a simple "Table" format.
    • [out] EPR The Endpoint Reference of the Replicator resource.
    • [fault] fault Indicates a general failure when attempting to create the Replicator resource.

  • start starts the resource.

    • [fault] invalidStateFault Indicates the resource is in an invalid state to perform the operation.

  • stop stops the resource.

    • [fault] invalidStateFault Indicates the resource is in an invalid state to perform the operation.

  • suspend suspends the resource.

    • [fault] invalidStateFault Indicates the resource is in an invalid state to perform the operation.

  • resume resumes the resource.

    • [fault] invalidStateFault Indicates the resource is in an invalid state to perform the operation.

  • findItems Finds state information for individual replication items.

    • [in] byUri Finds by replication URI (currently, this value must be the logical filename, LFN, rather than a properly formed URI). This param is mutually-exclusive with byStatus.
    • [in] byStatus Find by status, which includes Pending, Finished, Failed, and Terminated. This param is mutually-exclusive with byUri.
    • [in] offset An offset into the results set.
    • [in] limit A limit of results to be returned to the client.
    • [out] items An array of items to be returned to the client as a result of the find operation. Each item in the array contains the complete status of the replication item including its identifier, priority, status, error (if any), sources, and destinations.
    • [fault] internalErrorFault Indicates that an internal error occurred.

3. Resource properties

Supported resource properties for DataRep include:

  • status: The status of the resource, such as Pending, Active, Suspended, Terminated, Destroyed, etc.
  • stage: The current stage or activity of the resource, such as Discover, Transfer, and Register.
  • result: The final result (if any) of the resource, such as Finished, Failed, and Exception.
  • errorMessage: A verbose description of an error (if any) encountered by the resource. The message may include error or exception information returned by one of the dependent components, such as RLS or RFT.
  • count: An element containing counts of individual replication items pertaining to total, finished, failed, and terminated replication items.

4. Faults

Supported faults include:

  • CreateReplicatorFault Indicates that the service failed to create the Replicator resource.
  • RequestBodyMissingFault Indicates that the request body of the create message parameters was missing.
  • CredentialEprMissingFault Indicates that the delegated credential EPR was missing from the create message.
  • InvalidStateFault Indicates that the requested lifecycle operation (e.g., start, stop, suspend, resume) was performed on a resource that was not in the proper state for the operation to succeed (e.g., performing a resume operation on a non-suspended Replicator resource).
  • InternalErrorFaultType Indicates that an internal error occurred (e.g., internal system failure, etc.).

5. WSDL and Schema Definition

For more information, please see the Replicator Port Type or the complete list of schemas.

Prev   Next
APIs Home Command-line tools