From 3e3498e50cf10d20620db8b62405442c6d96c0eb Mon Sep 17 00:00:00 2001 From: Brian Rosenberger Date: Sun, 15 Jun 2014 09:43:44 +0000 Subject: [PATCH] git-svn-id: https://brutex.net/svn/xservices/trunk@159 e7e49efb-446e-492e-b9ec-fcafc1997a86 --- doc/{ => ArchiveServices}/ArchiveServices.xml | 0 doc/BruteXServices_User_Guide.dbk | 495 ++++++++++++++++-- doc/BruteXServices_User_Guide.xml | 22 +- doc/{ => DateServices}/DateServices.xml | 14 +- doc/DateServices/getDate.xml | 4 +- doc/DateServices/getDateExtended.xml | 4 +- doc/DateServices/getTimestamp.xml | 12 +- doc/DateServices/getTimestamp2.xml | 12 +- doc/{ => ExecuteServices}/ExecuteServices.xml | 8 +- doc/{ => FileServices}/FileServices.xml | 2 + doc/JobServices/JobServices.xml | 13 + doc/{ => MailServices}/MailServices.xml | 2 +- doc/{ => MiscServices}/MiscServices.xml | 6 +- doc/StorageServices/StorageServices.xml | 12 + doc/StorageServices/operationName.xml | 59 +++ doc/StringServices/StringServices.xml | 11 + doc/Types.xml | 13 - doc/XmlServices/XmlServices.xml | 13 + doc/XmlServices/insertNodes.xml | 74 +++ doc/XmlServices/operationName.xml | 59 +++ doc/XmlServices/replaceNodes.xml | 74 +++ doc/XmlServices/wrapInCDATA.xml | 36 ++ doc/_template/_templateServices.xml | 11 + doc/_template/operationName.xml | 59 +++ doc/common/installation.xml | 3 +- doc/types/Types.xml | 13 + 26 files changed, 946 insertions(+), 85 deletions(-) rename doc/{ => ArchiveServices}/ArchiveServices.xml (100%) rename doc/{ => DateServices}/DateServices.xml (73%) rename doc/{ => ExecuteServices}/ExecuteServices.xml (60%) rename doc/{ => FileServices}/FileServices.xml (75%) create mode 100644 doc/JobServices/JobServices.xml rename doc/{ => MailServices}/MailServices.xml (81%) rename doc/{ => MiscServices}/MiscServices.xml (64%) create mode 100644 doc/StorageServices/StorageServices.xml create mode 100644 doc/StorageServices/operationName.xml create mode 100644 doc/StringServices/StringServices.xml delete mode 100644 doc/Types.xml create mode 100644 doc/XmlServices/XmlServices.xml create mode 100644 doc/XmlServices/insertNodes.xml create mode 100644 doc/XmlServices/operationName.xml create mode 100644 doc/XmlServices/replaceNodes.xml create mode 100644 doc/XmlServices/wrapInCDATA.xml create mode 100644 doc/_template/_templateServices.xml create mode 100644 doc/_template/operationName.xml create mode 100644 doc/types/Types.xml diff --git a/doc/ArchiveServices.xml b/doc/ArchiveServices/ArchiveServices.xml similarity index 100% rename from doc/ArchiveServices.xml rename to doc/ArchiveServices/ArchiveServices.xml diff --git a/doc/BruteXServices_User_Guide.dbk b/doc/BruteXServices_User_Guide.dbk index 17e2234..1532f93 100644 --- a/doc/BruteXServices_User_Guide.dbk +++ b/doc/BruteXServices_User_Guide.dbk @@ -1,7 +1,7 @@ Brutex XServices Documentation - Januar 2012 + June 2014 Brian Rosenberger @@ -9,7 +9,7 @@ Brutex Network - 2012 + 2014 @@ -39,9 +39,26 @@ Abstract - In complex IT environments it is often necessary to integrate different information systems with each other, exchange data between software tools and automate actions based on events arising from user interaction. Web Services is a popular way to make remote functions available to a broad range of clients. A WebService is independent from platforms and programming languages. XML Messages are exchanged through common protocols like TCP/IP or SMTP, processed and returned (request/ response paradigm). - Because of their nature, WebServices are a great technology to overcome system boundaries and to "orchestrate" your IT environment. They make up the basis for SOA and are the pieces that assemble automated business processes. - XServices is a collection of pre-build WebServices with the intention to avoid duplicate work and "re-inventing the wheel". The historical base for XServices is the 'XBridgeNG' software, which provided a set of Apache Ant Tasks with quite the same intention. The available WebService operations are most likely the "most wanted" ones, some of the for sure are "must have". This collection may overlap with other libraries. In summary the current version contains 8 WebServices with over 50 operations. + In complex IT environments it is often necessary to integrate + different information systems with each other, exchange data between + software tools and automate actions based on events arising from user + interaction. Web Services is a popular way to make remote functions + available to a broad range of clients. A WebService is independent + from platforms and programming languages. XML Messages are exchanged + through common protocols like TCP/IP or SMTP, processed and returned + (request/ response paradigm). + Because of their nature, WebServices are a great technology to + overcome system boundaries and to "orchestrate" your IT environment. + They make up the basis for SOA and are the pieces that assemble + automated business processes. + XServices is a collection of pre-build WebServices with the + intention to avoid duplicate work and "re-inventing the wheel". The + historical base for XServices is the 'XBridgeNG' software, which + provided a set of Apache Ant Tasks with quite the same intention. The + available WebService operations are most likely the "most wanted" + ones, some of them for sure are "must have". This collection may + overlap with other libraries. In summary the current version contains + 8 WebServices with over 50 operations. @@ -52,8 +69,7 @@
Installation - tbd. - Sun Java SE 1.6.0 + As of February 2013, XServices require Java 7. Older builds run against Java 5. Apache Tomcat 7 tbd. In short: Deploy .WAR file to Apache Tomcat @@ -110,13 +126,13 @@ Available Services List of available web services and their operations. -
+
ArchiveServices The ArchiveService bundles file packing operations. Its WSDL is located at http://server:port/XServices/ArchiveService?wsdl
-
+
DateServices The DateService bundles various date and time related operations. @@ -138,7 +154,7 @@ getDate Get current time and date. Sample request: - @@ -147,7 +163,7 @@ +]]> Sample response: @@ -171,7 +187,7 @@ getDateExtended Get current time and date (extended Version). Sample response: - + @@ -188,7 +204,7 @@ ]]> - +
@@ -224,7 +240,8 @@ getTimestamp Get current timestamp in milliseconds (epoch). Sample request: - + @@ -233,23 +250,27 @@ +]]> + Sample response: - + ]]>1325488875703 -]]> +]]> +
getTimestamp2 Get current timestamp in seconds (unix timestamp). Sample request: - + @@ -258,16 +279,19 @@ +]]> + Sample response: - + ]]>1325488876 -]]> +]]> +
@@ -3314,7 +3338,7 @@
-
+
ExecuteServices The ExecuteService bundles local and remote command execution operations. Its WSDL is located at @@ -3362,7 +3386,7 @@ No Any command including arguments - + timeout Long Yes @@ -3376,7 +3400,7 @@
Output parameters -
+
ReturnCode type The ReturnCode type is used as the generic answer type for most of the @@ -3466,7 +3490,7 @@ No Any command line arguments - + timeout Long Yes @@ -3480,7 +3504,7 @@
Output parameters -
+
ReturnCode type The ReturnCode type is used as the generic answer type for most of the @@ -3571,7 +3595,7 @@ No The command to execute. - + timeout Long Yes @@ -3585,7 +3609,7 @@
Output parameters -
+
ReturnCode type The ReturnCode type is used as the generic answer type for most of the @@ -3701,7 +3725,7 @@ No The prompt to expect after the command has been executed successfully. - + timeout Long Yes @@ -3714,7 +3738,7 @@
Output parameters -
+
ReturnCode type The ReturnCode type is used as the generic answer type for most of the @@ -3785,12 +3809,87 @@
-
+
FileServices The FileServces bundles various file operations. Its WSDL is located at http://server:port/XServices/FileService?wsdl +
+ downloadFile + Downloads a file as base64 encoded. + Sample request: + + + + + + + FILE + c:\temp\test.docx + + + + +]]> + Sample response: + + + + + ADQBNA[... snipp ...]wAApzcAAAAA + test.docx + + + +]]> + +Encoding files as base64 is very memory consuming! +
+
+ encodeFile + Encodes a file as base64. + Sample request: + + + + + + FILE + c:\temp\test.docx + + + + +]]> + Sample response: + + + + + ADQBNA[... snipp ...]wAApzcAAAAA + test.docx + + + +]]> + +DEPRECATED: Encoding files as base64 is very memory consuming! +
-
+
+ JobServices + The JobService bundles re-occuring or scheduled operations. Its WSDL is located at + http://server:port/XServices/JobService?wsdl + +
+
MailServices The MailService contains mail send and receive operations. Its WSDL is located at http://server:port/XServices/MailService?wsdl @@ -3799,7 +3898,7 @@ Send email.
-
+
MiscServices The MiscService bundles various operations. Its WSDL is located at http://server:port/XServices/MiscService?wsdl @@ -3878,6 +3977,334 @@ correctly.
+
+
+ StorageServices + The StorageService will provide get/ push operations to store and retrieve data from various backends. + This is currently under development and not yet released. + Its WSDL is located at + http://server:port/XServices/StorageService?wsdl +
+ ... + + Description here +
+ Input parameters + + + + Input parameters + + + + + + + + + parameter + type + required + description + + + + + host + HostConnection + Yes + + Host where to execute the command. See + HostConnection + . + + + + command + String + No + Any command including arguments + + + timeout + Long + Yes + Timeout in milliseconds. The command is forcefully terminated when timeout is reached. + + + +
+ +
+
+ Output parameters + +
+ 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 + + + + + + tns:antProperty + +]]> + + + Example XML + + <ReturnCode + xmlns:ns2="http://ws.xservices.brutex.net"> + <returnCode>0</returnCode> + <stdOut/> + <stdErr/> + <propertyList> + + See + tns:antProperty + for details about the <propertyList> elements. + + <name>key1</name> + <value>value1</value> + </propertyList> + <propertyList> + <name>key2</name> + <value>value2</value> + </propertyList> + </ReturnCode> + + +
+
+
+ +
+
+ StringServices + The StringService provides String manipulation capabilities. + Its WSDL is located at + http://server:port/XServices/StringService?wsdl +
+ replaceRegEx + Search and Replace using regular expression. + Sample request: + + + + + Hallo Welt + W.* + Brian + ig + + + +]]> + Sample response: + + + + + Hallo Brian + 1 + + + +]]> + +Allowed regexflags are case-insensitive (i) and global search (g). +
+ +
+
+ XmlServices + The XmlService provides operations to manipulate XML structures. + Its WSDL is located at + http://server:port/XServices/XmlService?wsdl +
+ insertNodes + Insert an xml fragment into other elements specified by an XPath expression. + This operation is namespace aware. + + Sample request: + + + + + + + Mensiok + Bello + + + Schwab + Rumsau + + + Dollibert + Rach + + + ]]]]> + utf-8 + + + + + + + + /books/author + + ]]]]> + + + +]]> + Sample response: + + + + + + + Mensiok + Bello + + + Schwab + Rumsau + + + Dollibert + Rach + + ]]]]> + + + +]]> + +
+
+ replaceNodes + Replace an xml fragment with another xml fragment. This operation is namespace aware. + + Sample request: + + + + + + + Mensiok + Bello + + + Schwab + Rumsau + + + Dollibert + Rach + + + ]]]]> + + utf-8 + + + + + + + + */name[text()='Schwab'] + + Meyer45]]]]> + + + +]]> + Sample response: + + + + + + + Mensiok + Bello + + + Meyer45 + Rumsau + + + Dollibert + Rach + + ]]]]> + + +]]> + +
+
+ wrapInCDATA + Simply wraps any data fragment into <![CDATA[ ... ]]> section. This can be useful if you + want to preserve indentation or line breaks. + + + Sample request: + + + + + Hello World, here is some <xml> data + + + +]]> + Sample response: + + + + <![CDATA[Hello World, here is some <xml> data]]> + + + +]]> + +
+
@@ -3886,7 +4313,7 @@ XML Types This chapter bundles the documentation for common XML types used by XServices web service. -
+
AntProperty type diff --git a/doc/BruteXServices_User_Guide.xml b/doc/BruteXServices_User_Guide.xml index dc6c876..c4394d2 100644 --- a/doc/BruteXServices_User_Guide.xml +++ b/doc/BruteXServices_User_Guide.xml @@ -7,7 +7,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude"> Brutex XServices Documentation - Januar 2012 + June 2014 Brian Rosenberger @@ -15,7 +15,7 @@ Brutex Network - 2012 + 2014 @@ -55,12 +55,16 @@ Available Services List of available web services and their operations. - - - - - - + + + + + + + + + + @@ -68,6 +72,6 @@ XML Types This chapter bundles the documentation for common XML types used by XServices web service. - + diff --git a/doc/DateServices.xml b/doc/DateServices/DateServices.xml similarity index 73% rename from doc/DateServices.xml rename to doc/DateServices/DateServices.xml index aa1cd6a..7662a1a 100644 --- a/doc/DateServices.xml +++ b/doc/DateServices/DateServices.xml @@ -18,11 +18,11 @@ - - - - - - - + + + + + + +
\ No newline at end of file diff --git a/doc/DateServices/getDate.xml b/doc/DateServices/getDate.xml index 31f3b89..fb017bb 100644 --- a/doc/DateServices/getDate.xml +++ b/doc/DateServices/getDate.xml @@ -8,7 +8,7 @@ getDate Get current time and date. Sample request: - @@ -17,7 +17,7 @@ +]]> Sample response: diff --git a/doc/DateServices/getDateExtended.xml b/doc/DateServices/getDateExtended.xml index 5884521..1e78c50 100644 --- a/doc/DateServices/getDateExtended.xml +++ b/doc/DateServices/getDateExtended.xml @@ -8,7 +8,7 @@ getDateExtended Get current time and date (extended Version). Sample response: - + @@ -25,7 +25,7 @@ ]]> - +
\ No newline at end of file diff --git a/doc/DateServices/getTimestamp.xml b/doc/DateServices/getTimestamp.xml index 2b357b9..54daafa 100644 --- a/doc/DateServices/getTimestamp.xml +++ b/doc/DateServices/getTimestamp.xml @@ -8,7 +8,8 @@ getTimestamp Get current timestamp in milliseconds (epoch). Sample request: - + @@ -17,15 +18,18 @@ +]]> + Sample response: - + ]]>1325488875703 -]]> +]]> +
\ No newline at end of file diff --git a/doc/DateServices/getTimestamp2.xml b/doc/DateServices/getTimestamp2.xml index 6bca734..e2d34b0 100644 --- a/doc/DateServices/getTimestamp2.xml +++ b/doc/DateServices/getTimestamp2.xml @@ -8,7 +8,8 @@ getTimestamp2 Get current timestamp in seconds (unix timestamp). Sample request: - + @@ -17,15 +18,18 @@ +]]> + Sample response: - + ]]>1325488876 -]]> +]]> +
\ No newline at end of file diff --git a/doc/ExecuteServices.xml b/doc/ExecuteServices/ExecuteServices.xml similarity index 60% rename from doc/ExecuteServices.xml rename to doc/ExecuteServices/ExecuteServices.xml index 03d4a74..07c9f25 100644 --- a/doc/ExecuteServices.xml +++ b/doc/ExecuteServices/ExecuteServices.xml @@ -6,8 +6,8 @@ The ExecuteService bundles local and remote command execution operations. Its WSDL is located at http://server:port/XServices/ExecuteService?wsdl - - - - + + + +
\ No newline at end of file diff --git a/doc/FileServices.xml b/doc/FileServices/FileServices.xml similarity index 75% rename from doc/FileServices.xml rename to doc/FileServices/FileServices.xml index 7f99c82..396b0ff 100644 --- a/doc/FileServices.xml +++ b/doc/FileServices/FileServices.xml @@ -5,4 +5,6 @@ FileServices The FileServces bundles various file operations. Its WSDL is located at http://server:port/XServices/FileService?wsdl + +
\ No newline at end of file diff --git a/doc/JobServices/JobServices.xml b/doc/JobServices/JobServices.xml new file mode 100644 index 0000000..c254a13 --- /dev/null +++ b/doc/JobServices/JobServices.xml @@ -0,0 +1,13 @@ + +
+ JobServices + The JobService bundles re-occuring or scheduled operations. Its WSDL is located at + http://server:port/XServices/JobService?wsdl + +
\ No newline at end of file diff --git a/doc/MailServices.xml b/doc/MailServices/MailServices.xml similarity index 81% rename from doc/MailServices.xml rename to doc/MailServices/MailServices.xml index 606b29d..f196896 100644 --- a/doc/MailServices.xml +++ b/doc/MailServices/MailServices.xml @@ -5,5 +5,5 @@ MailServices The MailService contains mail send and receive operations. Its WSDL is located at http://server:port/XServices/MailService?wsdl - +
\ No newline at end of file diff --git a/doc/MiscServices.xml b/doc/MiscServices/MiscServices.xml similarity index 64% rename from doc/MiscServices.xml rename to doc/MiscServices/MiscServices.xml index da9d081..7a9c368 100644 --- a/doc/MiscServices.xml +++ b/doc/MiscServices/MiscServices.xml @@ -5,7 +5,7 @@ MiscServices The MiscService bundles various operations. Its WSDL is located at http://server:port/XServices/MiscService?wsdl - - - + + +
\ No newline at end of file diff --git a/doc/StorageServices/StorageServices.xml b/doc/StorageServices/StorageServices.xml new file mode 100644 index 0000000..d383a3e --- /dev/null +++ b/doc/StorageServices/StorageServices.xml @@ -0,0 +1,12 @@ + +
+ StorageServices + The StorageService will provide get/ push operations to store and retrieve data from various backends. + This is currently under development and not yet released. + Its WSDL is located at + http://server:port/XServices/StorageService?wsdl + + +
\ No newline at end of file diff --git a/doc/StorageServices/operationName.xml b/doc/StorageServices/operationName.xml new file mode 100644 index 0000000..d696bee --- /dev/null +++ b/doc/StorageServices/operationName.xml @@ -0,0 +1,59 @@ + + +%myent; +]> +
+ ... + + Description here +
+ &inp; + + + + Input parameters + + + + + + + + + parameter + type + required + description + + + + + host + HostConnection + Yes + + Host where to execute the command. See + HostConnection + . + + + + command + String + No + Any command including arguments + + ¶m-timeout; + + +
+ +
+
+ &outp; + + +
+
\ No newline at end of file diff --git a/doc/StringServices/StringServices.xml b/doc/StringServices/StringServices.xml new file mode 100644 index 0000000..1289d9c --- /dev/null +++ b/doc/StringServices/StringServices.xml @@ -0,0 +1,11 @@ + +
+ StringServices + The StringService provides String manipulation capabilities. + Its WSDL is located at + http://server:port/XServices/StringService?wsdl + + +
\ No newline at end of file diff --git a/doc/Types.xml b/doc/Types.xml deleted file mode 100644 index 8872238..0000000 --- a/doc/Types.xml +++ /dev/null @@ -1,13 +0,0 @@ - -
- - - - - - - - - -
\ No newline at end of file diff --git a/doc/XmlServices/XmlServices.xml b/doc/XmlServices/XmlServices.xml new file mode 100644 index 0000000..0842b87 --- /dev/null +++ b/doc/XmlServices/XmlServices.xml @@ -0,0 +1,13 @@ + +
+ XmlServices + The XmlService provides operations to manipulate XML structures. + Its WSDL is located at + http://server:port/XServices/XmlService?wsdl + + + + +
\ No newline at end of file diff --git a/doc/XmlServices/insertNodes.xml b/doc/XmlServices/insertNodes.xml new file mode 100644 index 0000000..6ed090d --- /dev/null +++ b/doc/XmlServices/insertNodes.xml @@ -0,0 +1,74 @@ + + +%myent; +]> +
+ insertNodes + Insert an xml fragment into other elements specified by an XPath expression. + This operation is namespace aware. + + Sample request: + + + + + + + Mensiok + Bello + + + Schwab + Rumsau + + + Dollibert + Rach + + + ]]]]> + utf-8 + + + + + + + + /books/author + + ]]]]> + + + +]]> + Sample response: + + + + + + + Mensiok + Bello + + + Schwab + Rumsau + + + Dollibert + Rach + + ]]]]> + + + +]]> + +
\ No newline at end of file diff --git a/doc/XmlServices/operationName.xml b/doc/XmlServices/operationName.xml new file mode 100644 index 0000000..d696bee --- /dev/null +++ b/doc/XmlServices/operationName.xml @@ -0,0 +1,59 @@ + + +%myent; +]> +
+ ... + + Description here +
+ &inp; + + + + Input parameters + + + + + + + + + parameter + type + required + description + + + + + host + HostConnection + Yes + + Host where to execute the command. See + HostConnection + . + + + + command + String + No + Any command including arguments + + ¶m-timeout; + + +
+ +
+
+ &outp; + + +
+
\ No newline at end of file diff --git a/doc/XmlServices/replaceNodes.xml b/doc/XmlServices/replaceNodes.xml new file mode 100644 index 0000000..a2e5bf2 --- /dev/null +++ b/doc/XmlServices/replaceNodes.xml @@ -0,0 +1,74 @@ + + +%myent; +]> +
+ replaceNodes + Replace an xml fragment with another xml fragment. This operation is namespace aware. + + Sample request: + + + + + + + Mensiok + Bello + + + Schwab + Rumsau + + + Dollibert + Rach + + + ]]]]> + + utf-8 + + + + + + + + */name[text()='Schwab'] + + Meyer45]]]]> + + + +]]> + Sample response: + + + + + + + Mensiok + Bello + + + Meyer45 + Rumsau + + + Dollibert + Rach + + ]]]]> + + +]]> + +
\ No newline at end of file diff --git a/doc/XmlServices/wrapInCDATA.xml b/doc/XmlServices/wrapInCDATA.xml new file mode 100644 index 0000000..1606a47 --- /dev/null +++ b/doc/XmlServices/wrapInCDATA.xml @@ -0,0 +1,36 @@ + + +%myent; +]> +
+ wrapInCDATA + Simply wraps any data fragment into <![CDATA[ ... ]]> section. This can be useful if you + want to preserve indentation or line breaks. + + + Sample request: + + + + + Hello World, here is some <xml> data + + + +]]> + Sample response: + + + + <![CDATA[Hello World, here is some <xml> data]]> + + + +]]> + +
\ No newline at end of file diff --git a/doc/_template/_templateServices.xml b/doc/_template/_templateServices.xml new file mode 100644 index 0000000..76dfc3d --- /dev/null +++ b/doc/_template/_templateServices.xml @@ -0,0 +1,11 @@ + +
+ TemplateServices + The TemplateService bundles ... + Its WSDL is located at + http://server:port/XServices/TemplateService?wsdl + + +
\ No newline at end of file diff --git a/doc/_template/operationName.xml b/doc/_template/operationName.xml new file mode 100644 index 0000000..d696bee --- /dev/null +++ b/doc/_template/operationName.xml @@ -0,0 +1,59 @@ + + +%myent; +]> +
+ ... + + Description here +
+ &inp; + + + + Input parameters + + + + + + + + + parameter + type + required + description + + + + + host + HostConnection + Yes + + Host where to execute the command. See + HostConnection + . + + + + command + String + No + Any command including arguments + + ¶m-timeout; + + +
+ +
+
+ &outp; + + +
+
\ No newline at end of file diff --git a/doc/common/installation.xml b/doc/common/installation.xml index d5ad632..bc11ffe 100644 --- a/doc/common/installation.xml +++ b/doc/common/installation.xml @@ -5,8 +5,7 @@
Installation - tbd. - Sun Java SE 1.6.0 + As of February 2013, XServices require Java 7. Older builds run against Java 5. Apache Tomcat 7 tbd. In short: Deploy .WAR file to Apache Tomcat diff --git a/doc/types/Types.xml b/doc/types/Types.xml new file mode 100644 index 0000000..c16e10c --- /dev/null +++ b/doc/types/Types.xml @@ -0,0 +1,13 @@ + +
+ + + + + + + + + +
\ No newline at end of file