Chapter 3. XML Types

Table of Contents

1.1. AntProperty type
1.2. DateInfoType type
1.3. FileResource type
1.4. HostConnection type
1.5. PatternElement type
1.6. PatternSetType type
1.7. ReturnCode type
1.8. SelectorType type

This chapter bundles the documentation for common XML types used by XServices web service.

1.1. AntProperty type

The AntProperty type defines a list of key/value pairs.

The defining Java class is net.brutex.xservices.types.AntProperty .

<xs:complexType name="antProperty">
      <xs:element name="name" type="xs:string"/>
      <xs:element name="value" type="xs:string"/>

1.2. DateInfoType type

Different presentation of a date time value.

The defining Java class is net.brutex.xservices.types.DateInfoType .

1.3. FileResource type

The FileResource type defines an URI to a file with optional on-the-fly decompression.

The defining Java class is net.brutex.xservices.types.FileResource .

<xs:complexType name="FileResourceType">
    	<xs:element default="FILE" name="type" type="tns:type"/>
        <xs:element name="uri" type="xs:string"/>

Available types:

FILE: URI points to a local file resource. Examples: c:\temp\something.txt, c:/dir/another.file, /home/brian/file

URL: File from URL (http, https, ftp, ...). Example:

GZIP and BZIP2: File from a local file system with on-the-fly decompression.


1.4. HostConnection type

The HostConnection type identifies a server resource and login credentials.

The defining Java class is net.brutex.xservices.types.HostConnection .

Schema definition

<xs:complexType name="connection">
      <xs:element name="hostname" type="xs:string"/>
      <xs:element name="port" type="xs:int"/>
      <xs:element minOccurs="0" name="user" type="xs:string"/>
      <xs:element minOccurs="0" name="password" type="xs:string"/>


Example XML

   <port>512</port> <!-- default rExec port -->


1.5. PatternElement type

The PatternElement type defines single string pattern for file/ directory matching.

The defining Java class is net.brutex.xservices.types.PatternElement .

These patterns look exactly like those used in Apache Ant Patterns. The '*' matches zero or more characters and the '?' will match a single character. Both symbols can be combined in one pattern. The '**' symbol can be used to match any directory deepth.

Some example patterns:


Match all file that are located in any directory that has "mydir" string in its pathname. Also applies to files with "mydir" in their name.


The parser will automatically append an '**' symbol, thus the resulting pattern is /mydir/**. All files below the "/mydir/" directory (including its sub-directories will be chosen.


The pattern is OS independent. You should always use "/" as path separator, even on windows based systems.

Schema definition

<xs:simpleType name="patternElement">
    <xs:restriction base="xs:string"/>

Example XML


1.6. PatternSetType type

The PatternSetType exposes various filters/ selectors for the selection of resources (files).

The defining Java class is net.brutex.xservices.types.PatternSetType .

Schema definition

<xs:complexType name="patternSetType">
        <xs:element default="**/*" maxOccurs="unbounded" minOccurs="0" name="include" type="tns:patternElement"/>
        <xs:element maxOccurs="unbounded" minOccurs="0" name="exclude" type="tns:patternElement"/>
        <xs:element minOccurs="0" name="selector" nillable="true" type="tns:selectorType"/>

Example XML


1.7. ReturnCode type

The ReturnCode type is used as the generic answer type for most of the BruteXservices operations.

The defining Java class is net.brutex.xservices.types.ReturnCode .

Schema definition

<xs:complexType name="ReturnCodeType">
        <xs:element name="returnCode" type="xs:int"/>
        <xs:element minOccurs="0" name="stdOut" type="xs:string"/>
        <xs:element minOccurs="0" name="stdErr" type="xs:string"/>
        <xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="tns:antProperty"/>

Example XML

			for details about the <propertyList> elements.

1.8. SelectorType type

The SelectorType exposes various selectors for the selection of resources (files).

The defining Java class is net.brutex.xservices.types.SelectorType.

Schema definition

         <xs:complexType abstract="true" name="selectorType">
               <xs:element maxOccurs="unbounded" minOccurs="0" name="contains" nillable="true" type="tns:containsSelectorType"/>

Example XML