RFT Schema Documentation
Table of Contents
- Schema Document Properties
- Global Declarations
-
Global Definitions
- Complex Type: BaseRequestType
- Complex Type: DelegationEPRMissingFaultType
- Complex Type: DeleteOptionsType
- Complex Type: DeleteRequestType
- Complex Type: DeleteType
- Complex Type: OverallStatus
- Complex Type: RFTAuthenticationFaultType
- Complex Type: RFTAuthorizationFaultType
- Complex Type: RFTDatabaseFaultType
- Complex Type: RFTFaultResourcePropertyType
- Complex Type: RFTOptionsType
- Complex Type: RepeatedlyStartedFaultType
- Complex Type: RequestStatusType
- Complex Type: TotalBytesTransferredResource
- Complex Type: TotalTimeTakenResource
- Complex Type: TransferFaultType
- Complex Type: TransferRequestType
- Complex Type: TransferStatusType
- Complex Type: TransferTransientFaultType
- Complex Type: TransferType
- Simple Type: RequestStatusTypeEnumeration
- Simple Type: TransferJobTypeEnumeration
- Simple Type: TransferStatusTypeEnumeration
Schema Document Properties
Target Namespace | http://www.globus.org/namespaces/2004/10/rft |
---|---|
Element and Attribute Namespaces |
|
Schema Composition |
|
Declared Namespaces
Prefix | Namespace |
---|---|
tns | http://www.globus.org/namespaces/2004/10/rft |
wsa | http://schemas.xmlsoap.org/ws/2004/03/addressing |
wsbf | http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-BaseFaults-1.2-draft-01.xsd |
xsd | http://www.w3.org/2001/XMLSchema |
xml | http://www.w3.org/XML/1998/namespace |
Schema Component Representation |
---|
<xsd:schema targetNamespace="http://www.globus.org/namespaces/2004/10/rft" attributeFormDefault="qualified" elementFormDefault="qualified">
<xsd:import schemaLocation="../../ws/addressing/WS-Addressing.xsd" namespace="http://schemas.xmlsoap.org/ws/2004/03/addressing"/> <xsd:import schemaLocation="../../wsrf/faults/WS-BaseFaults.xsd" namespace="http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-BaseFaults-1.2-draft-01.xsd"/> ... </xsd:schema> |
Global Declarations
Element: deleteRequest
Name | deleteRequest |
---|---|
Type | tns:DeleteRequestType |
Nillable | no |
Abstract | no |
XML Instance Representation |
---|
Schema Component Representation |
---|
|
Element: fault
Name | fault |
---|---|
Type | wsbf:BaseFaultType |
Nillable | no |
Abstract | no |
XML Instance Representation |
---|
Schema Component Representation |
---|
|
Element: transferRequest
Name | transferRequest |
---|---|
Type | tns:TransferRequestType |
Nillable | no |
Abstract | no |
XML Instance Representation |
---|
Schema Component Representation |
---|
|
Global Definitions
Complex Type: BaseRequestType
Super-types: | None |
---|---|
Sub-types: |
|
Name | BaseRequestType |
---|---|
Abstract | no |
Documentation | Base Request Type from which TransferRequestType and DeleteRequest Type are derived. Concurrency is the number of transfers done simultaneously. maxAttempts denotes the number of attempts after which RFT marks a transfer as failed. finishBy (not implemented yet) represents the time by which this request should be finished. transferCredentialEndpoint represents EPR of delegation resource that holds the delegated credential for this resource. |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="BaseRequestType">
<xsd:sequence> </xsd:complexType><xsd:element name="transferCredentialEndpoint" type="wsa:EndpointReferenceType" minOccurs="0" maxOccurs="1"/> </xsd:sequence> |
Complex Type: DelegationEPRMissingFaultType
Super-types: | wsbf:BaseFaultType < DelegationEPRMissingFaultType (by extension) |
---|---|
Sub-types: | None |
Name | DelegationEPRMissingFaultType |
---|---|
Abstract | no |
Documentation | This fault is thrown when the request does not have a EPR for Delegation Cred. Terminal Error. |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="DelegationEPRMissingFaultType"></xsd:complexType>
|
Complex Type: DeleteOptionsType
Super-types: | None |
---|---|
Sub-types: | None |
Name | DeleteOptionsType |
---|---|
Abstract | no |
Documentation | Type representing various options one can set on a DeleteType. |
XML Instance Representation |
---|
Schema Component Representation |
---|
Complex Type: DeleteRequestType
Super-types: | BaseRequestType < DeleteRequestType (by extension) |
---|---|
Sub-types: | None |
Name | DeleteRequestType |
---|---|
Abstract | no |
Documentation | This type is used to submit transfers that need to be deleted |
XML Instance Representation |
---|
<...>
</...> |
Schema Component Representation |
---|
<xsd:complexType name="DeleteRequestType">
<xsd:complexContent></xsd:complexContent> </xsd:complexType> |
Complex Type: DeleteType
Super-types: | None |
---|---|
Sub-types: | None |
Name | DeleteType |
---|---|
Abstract | no |
Documentation | Type representing a file that needs to be deleted |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="DeleteType">
<xsd:sequence></xsd:sequence> </xsd:complexType> |
Complex Type: OverallStatus
Super-types: | None |
---|---|
Sub-types: | None |
Name | OverallStatus |
---|---|
Abstract | no |
Documentation | Type representing overall status of a RFT resource in the form of number of transfers done/active/failed/retrying/cancelled |
XML Instance Representation |
---|
<...>
</...> |
Schema Component Representation |
---|
<xsd:complexType name="OverallStatus">
<xsd:sequence></xsd:sequence> </xsd:complexType> |
Complex Type: RFTAuthenticationFaultType
Super-types: | wsbf:BaseFaultType < RFTAuthenticationFaultType (by extension) |
---|---|
Sub-types: | None |
Name | RFTAuthenticationFaultType |
---|---|
Abstract | no |
Documentation | This fault is thrown for Authz Faults. Terminal for resource if happens at resource creation and terminal for transfer. |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="RFTAuthenticationFaultType"></xsd:complexType>
|
Complex Type: RFTAuthorizationFaultType
Super-types: | wsbf:BaseFaultType < RFTAuthorizationFaultType (by extension) |
---|---|
Sub-types: | None |
Name | RFTAuthorizationFaultType |
---|---|
Abstract | no |
Documentation | This fault is thrown for Authz Faults. Terminal for resource if happens at the resource creation and terminal for transfer. |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="RFTAuthorizationFaultType"></xsd:complexType>
|
Complex Type: RFTDatabaseFaultType
Super-types: | wsbf:BaseFaultType < RFTDatabaseFaultType (by extension) |
---|---|
Sub-types: | None |
Name | RFTDatabaseFaultType |
---|---|
Abstract | no |
Documentation | This fault is thrown whenever there is an exception during inserting, updating,deleting,getting information from database.This can be a terminal fault if thrown at the resource level and non-terminal at the transfer level. |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="RFTDatabaseFaultType"></xsd:complexType>
|
Complex Type: RFTFaultResourcePropertyType
Super-types: | None |
---|---|
Sub-types: | None |
Name | RFTFaultResourcePropertyType |
---|---|
Abstract | no |
XML Instance Representation |
---|
<...>
Start Choice [1] <tns:rftRepeatedlyStartedFaultType> tns:RepeatedlyStartedFaultType </tns:rftRepeatedlyStartedFaultType> [1] <tns:delegationEPRMissingFaultType> tns:DelegationEPRMissingFaultType </tns:delegationEPRMissingFaultType> [1] <tns:rftAuthenticationFaultType> tns:RFTAuthenticationFaultType </tns:rftAuthenticationFaultType> [1] <tns:transferTransientFaultType> tns:TransferTransientFaultType </tns:transferTransientFaultType> [1] End Choice</...> |
Schema Component Representation |
---|
<xsd:complexType name="RFTFaultResourcePropertyType">
<xsd:choice></xsd:choice> </xsd:complexType> |
Complex Type: RFTOptionsType
Super-types: | None |
---|---|
Sub-types: | None |
Name | RFTOptionsType |
---|---|
Abstract | no |
Documentation | Type representing various options one can set at transfer and request level.ignoreFilePermErr when set will force RFT to ignore errors that occur while setting/getting file permissions. |
XML Instance Representation |
---|
<...>
</...> |
Schema Component Representation |
---|
<xsd:complexType name="RFTOptionsType">
<xsd:sequence></xsd:sequence> </xsd:complexType> |
Complex Type: RepeatedlyStartedFaultType
Super-types: | wsbf:BaseFaultType < RepeatedlyStartedFaultType (by extension) |
---|---|
Sub-types: | None |
Name | RepeatedlyStartedFaultType |
---|---|
Abstract | no |
Documentation | This fault indicates that the start method of the RFT service could not run because the job had already been started. This is not a terminal fault. |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="RepeatedlyStartedFaultType"></xsd:complexType>
|
Complex Type: RequestStatusType
Super-types: | None |
---|---|
Sub-types: | None |
Name | RequestStatusType |
---|---|
Abstract | no |
Documentation | Complex Type representing status of a RFT Resource along with Fault information for failed transfers. |
XML Instance Representation |
---|
<...>
</...> |
Schema Component Representation |
---|
<xsd:complexType name="RequestStatusType">
<xsd:sequence></xsd:sequence> </xsd:complexType> |
Complex Type: TotalBytesTransferredResource
Super-types: | None |
---|---|
Sub-types: | None |
Name | TotalBytesTransferredResource |
---|---|
Abstract | no |
Documentation | Type representing total number of bytes transferred in a RFT Resource |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="TotalBytesTransferredResource"></xsd:complexType>
|
Complex Type: TotalTimeTakenResource
Super-types: | None |
---|---|
Sub-types: | None |
Name | TotalTimeTakenResource |
---|---|
Abstract | no |
Documentation | Type representing total time taken transferring above mentioned TotalByteTransferredResource |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="TotalTimeTakenResource"></xsd:complexType>
|
Complex Type: TransferFaultType
Super-types: | wsbf:BaseFaultType < TransferFaultType (by extension) |
---|---|
Sub-types: | None |
Name | TransferFaultType |
---|---|
Abstract | no |
Documentation | This fault is thrown for terminal transfer Faults. This is included in RequestStatusType and TransferStatusType. Terminal Transfer faults include exceeding the number of maximum retries, Malformed URLs. |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="TransferFaultType"></xsd:complexType>
|
Complex Type: TransferRequestType
Super-types: | BaseRequestType < TransferRequestType (by extension) |
---|---|
Sub-types: | None |
Name | TransferRequestType |
---|---|
Abstract | no |
Documentation | This type represents transfer requests. RFTOptionsType are all the options you can set on a gridftp transfer (like Tcp Buffer Size etc ). allOrNone if set will force RFT to clean up all the files that are transferred already if one of the transfer fails. |
XML Instance Representation |
---|
<...>
</...> |
Schema Component Representation |
---|
<xsd:complexType name="TransferRequestType">
<xsd:complexContent></xsd:complexContent> </xsd:complexType> |
Complex Type: TransferStatusType
Super-types: | None |
---|---|
Sub-types: | None |
Name | TransferStatusType |
---|---|
Abstract | no |
Documentation | Type representing status of a single transfer |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="TransferStatusType">
<xsd:sequence></xsd:sequence> </xsd:complexType> |
Complex Type: TransferTransientFaultType
Super-types: | wsbf:BaseFaultType < TransferTransientFaultType (by extension) |
---|---|
Sub-types: | None |
Name | TransferTransientFaultType |
---|---|
Abstract | no |
Documentation | This fault is thrown for non-terminal transfer Faults. This is included in RequestStatusType and TransferStatusType. All exceptions for which RFT is going to retry a transfer come under this. |
XML Instance Representation |
---|
Schema Component Representation |
---|
<xsd:complexType name="TransferTransientFaultType"></xsd:complexType>
|
Complex Type: TransferType
Super-types: | None |
---|---|
Sub-types: | None |
Name | TransferType |
---|---|
Abstract | no |
Documentation | Type representing a single transfer along with various options that can be set on a transfer. retry_time is time when a particular transfer is retried. |
XML Instance Representation |
---|
<...>
</...> |
Schema Component Representation |
---|
<xsd:complexType name="TransferType">
<xsd:sequence></xsd:sequence> </xsd:complexType> |
Simple Type: RequestStatusTypeEnumeration
Super-types: | xsd:string < RequestStatusTypeEnumeration (by restriction) |
---|---|
Sub-types: | None |
Name | RequestStatusTypeEnumeration |
---|---|
Content |
|
Documentation | Enumeration of Status of Transfer Request |
Schema Component Representation |
---|
<xsd:simpleType name="RequestStatusTypeEnumeration">
<xsd:restriction base="xsd:string"> </xsd:simpleType><xsd:enumeration value="Pending"/> <xsd:enumeration value="Active"/> <xsd:enumeration value="Done"/> <xsd:enumeration value="Failed"/> <xsd:enumeration value="Cancelled"/> </xsd:restriction> |
Simple Type: TransferJobTypeEnumeration
Super-types: | xsd:string < TransferJobTypeEnumeration (by restriction) |
---|---|
Sub-types: | None |
Name | TransferJobTypeEnumeration |
---|---|
Content |
|
Documentation | Enumeration of different transfer job types |
Schema Component Representation |
---|
<xsd:simpleType name="TransferJobTypeEnumeration">
<xsd:restriction base="xsd:string"> </xsd:simpleType><xsd:enumeration value="transfer"/> <xsd:enumeration value="delete"/> </xsd:restriction> |
Simple Type: TransferStatusTypeEnumeration
Super-types: | xsd:string < TransferStatusTypeEnumeration (by restriction) |
---|---|
Sub-types: | None |
Name | TransferStatusTypeEnumeration |
---|---|
Content |
|
Documentation | Enumeration of different status a transfer can have |
Schema Component Representation |
---|
<xsd:simpleType name="TransferStatusTypeEnumeration">
<xsd:restriction base="xsd:string"> </xsd:simpleType><xsd:enumeration value="Finished"/> <xsd:enumeration value="Retrying"/> <xsd:enumeration value="Failed"/> <xsd:enumeration value="Active"/> <xsd:enumeration value="Pending"/> <xsd:enumeration value="Cancelled"/> <xsd:enumeration value="Expanding"/> <xsd:enumeration value="Expanding_Done"/> <xsd:enumeration value="Dirty"/> </xsd:restriction> |
Legend
Complex Type: | AusAddress |
Schema Component Type | Schema Component Name |
Super-types: | Address < AusAddress (by extension) |
---|---|
Sub-types: |
|
Name | AusAddress |
---|---|
Abstract | no |
XML Instance Representation |
---|
<... country="Australia">
<unitNo> string </unitNo> [0..1] <houseNo> string </houseNo> [1] <street> string </street> [1] Start Choice[1] <city> string </city> [1] <town> string </town> [1] End Choice <state> AusStates </state> [1] <postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] </...> |
The XML Instance Representation table above shows the schema component's content as an XML instance.
- The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
- Model group information are shown in gray, e.g. Start Choice ... End Choice.
- For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
- If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
- Otherwise, the type of the element/attribute is displayed.
- If the element/attribute's type is in the schema, a link is provided to it.
- For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
Schema Component Representation |
---|
<complexTypename="AusAddress">
<complexContent> <extensionbase="Address"> <sequence> <elementname="state" type="AusStates"/> <elementname="postcode"> <simpleType> <restrictionbase="string"> <patternvalue="[1-9][0-9]{3}"/> </restriction> </simpleType> </element> </sequence> <attributename="country" type="string" fixed="Australia"/> </extension> </complexContent> </complexType> |
Glossary
Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.
All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.
Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.
Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.
Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type
attribute.
Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.
Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil
attribute. The xsi:nil
attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil
attribute set to true, it can be left empty, even though its element declaration may have required content.
Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.
Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.
Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.
Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.
Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).
Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.
Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.
Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.
Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.
Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Generated by xs3p.