/xservices/trunk/doc/types/SelectorType.xml |
---|
1,11 → 1,13 |
<?xml version="1.0" encoding="UTF-8"?> |
<section id="selectortype"> |
<section xmlns="http://docbook.org/ns/docbook" |
version="5.0" |
xmlns:xi="http://www.w3.org/2001/XInclude" id="selectortype"> |
<title>SelectorType type</title> |
<para>The SelectorType exposes various selectors for the selection of resources (files).</para> |
<para>The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/SelectorType.html"> |
<classname>net.brutex.xservices.types.SelectorType</classname></ulink>.</para> |
&schemadefinition; |
<bridgehead renderas='sect3'>Schema definition</bridgehead> |
<programlisting language="xml"><![CDATA[ |
<xs:complexType abstract="true" name="selectorType"> |
<xs:sequence> |
13,7 → 15,7 |
</xs:sequence> |
</xs:complexType>]]> |
</programlisting> |
&examplexml; |
<bridgehead renderas='sect3'>Example XML</bridgehead> |
<programlisting language="xml"><![CDATA[ |
tbd.]]> |
</programlisting> |
/xservices/trunk/doc/types/AntProperty.xml |
---|
1,11 → 1,18 |
<?xml version='1.0' encoding='UTF-8'?><section id="antproperty"> |
<?xml version="1.0" encoding="UTF-8"?> |
<section> |
<title>AntProperty type</title> |
<para>The AntProperty type defines a list of key/value pairs.</para> |
<para>The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/AntProperty.html"> |
<classname>net.brutex.xservices.types.AntProperty</classname></ulink>.</para> |
&schemadefinition; |
<programlisting language="xml"><![CDATA[ |
<para> |
The defining Java class is |
<ulink |
url="javadoc/net/brutex/xservices/types/AntProperty.html"> |
<classname>net.brutex.xservices.types.AntProperty</classname> |
</ulink> |
. |
</para> |
<programlisting |
language="xml"><![CDATA[ |
<xs:complexType name="antProperty"> |
<xs:sequence> |
<xs:element name="name" type="xs:string"/> |
13,12 → 20,12 |
</xs:sequence> |
</xs:complexType>]]> |
</programlisting> |
&examplexml; |
<programlisting language="xml"><![CDATA[ |
<programlisting |
language="xml"><![CDATA[ |
<AntProperty> |
<name>key2</name> |
<value>value2</value> |
</AntProperty>]]> |
</programlisting> |
</section> |
/xservices/trunk/doc/types/PatternElement.xml |
---|
1,31 → 1,52 |
<?xml version='1.0' encoding='UTF-8'?><section id="patternelement"> |
<?xml version='1.0' encoding='UTF-8'?> |
<section xmlns="http://docbook.org/ns/docbook" version="5.0" |
xmlns:xi="http://www.w3.org/2001/XInclude" id="patternelement"> |
<title>PatternElement type</title> |
<para>The PatternElement type defines single string pattern for file/ directory matching.</para> |
<para>The defining Java class is |
<para>The PatternElement type defines single string pattern for file/ |
directory matching.</para> |
<para> |
The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/PatternElement.html"> |
<classname>net.brutex.xservices.types.PatternElement</classname> |
</ulink>. |
</ulink> |
. |
</para> |
<para>These patterns look exactly like those used in Apache Ant |
<para> |
These patterns look exactly like those used in Apache Ant |
<ulink url="http://ant.apache.org/manual/dirtasks.html#patterns">Patterns</ulink>. |
The '*' matches zero or more characters and the '?' will match a single character. |
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. |
</para> |
<para>Some example patterns:</para> |
<para><parameter>**/mydir/**</parameter></para> |
<para>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.</para> |
<para><parameter>/mydir/</parameter></para> |
<para>The parser will automatically append an '**' symbol, thus the resulting pattern is <parameter>/mydir/**</parameter>. All files below the "/mydir/" directory (including its sub-directories will be chosen.</para> |
<para> |
<parameter>**/mydir/**</parameter> |
</para> |
<para>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.</para> |
<para> |
<parameter>/mydir/</parameter> |
</para> |
<para>The |
parser will automatically append an '**' symbol, thus the |
resulting pattern is |
<parameter>/mydir/**</parameter>. |
All files below the "/mydir/" directory (including its |
sub-directories will be chosen. |
</para> |
<note> |
<para>The pattern is OS independent. You should always use "/" as path separator, even on windows based systems.</para> |
<para>The pattern is OS independent. You should always use |
"/" as path separator, even on windows based systems. |
</para> |
</note> |
&schemadefinition; |
<bridgehead renderas='sect3'>Schema definition</bridgehead> |
<programlisting language="xml"><![CDATA[<xs:simpleType name="patternElement"> |
<xs:restriction base="xs:string"/> |
</xs:simpleType>]]></programlisting> |
&examplexml; |
<bridgehead renderas='sect3'>Example XML</bridgehead> |
<programlisting language="xml"><![CDATA[<PatternElement>**/*</PatternElement>]]></programlisting> |
</section> |
/xservices/trunk/doc/types/FileResource.xml |
---|
0,0 → 1,34 |
<?xml version="1.0" encoding="UTF-8"?> |
<section> |
<title>FileResource type</title> |
<para>The FileResource type defines an URI to a file with optional on-the-fly decompression.</para> |
<para> |
The defining Java class is |
<ulink |
url="javadoc/net/brutex/xservices/types/FileResource.html"> |
<classname>net.brutex.xservices.types.FileResource</classname> |
</ulink> |
. |
</para> |
<programlisting |
language="xml"><![CDATA[ |
<xs:complexType name="FileResourceType"> |
<xs:sequence> |
<xs:element default="FILE" name="type" type="tns:type"/> |
<xs:element name="uri" type="xs:string"/> |
</xs:sequence> |
</xs:complexType>]]> |
</programlisting> |
<para>Available types:</para> |
<para>FILE: URI points to a local file resource. Examples: c:\temp\something.txt, c:/dir/another.file, /home/brian/file</para> |
<para>URL: File from URL (http, https, ftp, ...). Example: http://brutex.net/file.pdf</para> |
<para>GZIP and BZIP2: File from a local file system with on-the-fly decompression.</para> |
<programlisting |
language="xml"><![CDATA[ |
<resource> |
<type>FILE</type> |
<uri>c:\temp\xservices.war</uri> |
</resource>]]> |
</programlisting> |
</section> |
Property changes: |
Added: svn:mime-type |
+text/plain |
\ No newline at end of property |
/xservices/trunk/doc/types/ReturnCode.xml |
---|
1,10 → 1,20 |
<?xml version='1.0' encoding='UTF-8'?><section> |
<?xml version='1.0' encoding='UTF-8'?> |
<section xmlns="http://docbook.org/ns/docbook" version="5.0" |
xmlns:xi="http://www.w3.org/2001/XInclude"> |
<title>ReturnCode type</title> |
<para>The ReturnCode type is used as the generic answer type for most of the &brs; operations.</para> |
<para>The defining Java class is |
<ulink url="&javadoc-base;javadoc/net/brutex/xservices/types/ReturnCode.html"> |
<classname>net.brutex.xservices.types.ReturnCode</classname></ulink>.</para> |
&schemadefinition; |
<para> |
The ReturnCode type is used as the generic answer type for most of the |
<application class='software'>BruteXservices</application> |
operations. |
</para> |
<para> |
The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html"> |
<classname>net.brutex.xservices.types.ReturnCode</classname> |
</ulink> |
. |
</para> |
<bridgehead renderas='sect3'>Schema definition</bridgehead> |
<programlisting language="xml"><![CDATA[ |
<xs:complexType name="ReturnCodeType"> |
<xs:sequence> |
11,17 → 21,25 |
<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="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/> |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link |
linkend="antproperty">tns:antProperty</link><![CDATA["/> |
</xs:sequence> |
</xs:complexType>]]> |
</programlisting> |
&examplexml; |
<programlisting language="xml"><ReturnCode xmlns:ns2="http://ws.xservices.brutex.net"> |
<bridgehead renderas='sect3'>Example XML</bridgehead> |
<programlisting language="xml"> |
<ReturnCode |
xmlns:ns2="http://ws.xservices.brutex.net"> |
<returnCode>0</returnCode> |
<stdOut/> |
<stdErr/> |
<propertyList> <lineannotation>See <link linkend="antproperty">tns:antProperty</link> for details about the <propertyList> elements.</lineannotation> |
<propertyList> |
<lineannotation> |
See |
<link linkend="antproperty">tns:antProperty</link> |
for details about the <propertyList> elements. |
</lineannotation> |
<name>key1</name> |
<value>value1</value> |
</propertyList> |
29,6 → 47,7 |
<name>key2</name> |
<value>value2</value> |
</propertyList> |
</ReturnCode></programlisting> |
</ReturnCode> |
</programlisting> |
</section> |
/xservices/trunk/doc/types/PatternSetType.xml |
---|
1,21 → 1,30 |
<?xml version="1.0" encoding="UTF-8"?> |
<section id="patternsettype"> |
<section xmlns="http://docbook.org/ns/docbook" version="5.0" |
xmlns:xi="http://www.w3.org/2001/XInclude" id="patternsettype"> |
<title>PatternSetType type</title> |
<para>The PatternSetType exposes various filters/ selectors for the selection of resources (files).</para> |
<para>The defining Java class is |
<para>The PatternSetType exposes various filters/ selectors for the |
selection of resources (files).</para> |
<para> |
The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/PatternSetType.html"> |
<classname>net.brutex.xservices.types.PatternSetType</classname></ulink>.</para> |
&schemadefinition; |
<classname>net.brutex.xservices.types.PatternSetType</classname> |
</ulink> |
. |
</para> |
<bridgehead renderas='sect3'>Schema definition</bridgehead> |
<programlisting language="xml"><![CDATA[ |
<xs:complexType name="patternSetType"> |
<xs:sequence> |
<xs:element default="**/*" maxOccurs="unbounded" minOccurs="0" name="include" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/> |
<xs:element maxOccurs="unbounded" minOccurs="0" name="exclude" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/> |
<xs:element minOccurs="0" name="selector" nillable="true" type="]]><link linkend="selectortype">tns:selectorType</link><![CDATA["/> |
<xs:element default="**/*" maxOccurs="unbounded" minOccurs="0" name="include" type="]]><link |
linkend="patternelement">tns:patternElement</link><![CDATA["/> |
<xs:element maxOccurs="unbounded" minOccurs="0" name="exclude" type="]]><link |
linkend="patternelement">tns:patternElement</link><![CDATA["/> |
<xs:element minOccurs="0" name="selector" nillable="true" type="]]><link |
linkend="selectortype">tns:selectorType</link><![CDATA["/> |
</xs:sequence> |
</xs:complexType>]]> |
</programlisting> |
&examplexml; |
<bridgehead renderas='sect3'>Example XML</bridgehead> |
<programlisting language="xml"><![CDATA[ |
tbd.]]> |
</programlisting> |
/xservices/trunk/doc/types/HostConnection.xml |
---|
0,0 → 1,37 |
<?xml version="1.0" encoding="UTF-8"?> |
<section xmlns="http://docbook.org/ns/docbook" version="5.0" |
xmlns:xi="http://www.w3.org/2001/XInclude" id="hostconnection"> |
<title>HostConnection type</title> |
<para>The HostConnection type identifies a server resource and login |
credentials.</para> |
<para> |
The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/HostConnection.html"> |
<classname>net.brutex.xservices.types.HostConnection</classname> |
</ulink> |
. |
</para> |
<bridgehead renderas='sect3'>Schema definition</bridgehead> |
<programlisting language="xml"><![CDATA[ |
<xs:complexType name="connection"> |
<xs:sequence> |
<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"/> |
</xs:sequence> |
</xs:complexType> |
]]> |
</programlisting> |
<bridgehead renderas='sect3'>Example XML</bridgehead> |
<programlisting language="xml"><![CDATA[ |
<host> |
<hostname>server.brutex.net</hostname> |
<port>512</port> <!-- default rExec port --> |
<user>brian</user> |
<!--Optional:--> |
<password>somepass</password> |
</host> |
]]> |
</programlisting> |
</section> |
Property changes: |
Added: svn:mime-type |
+text/plain |
\ No newline at end of property |