Subversion Repositories XServices

Compare Revisions

No changes between revisions

Ignore whitespace Rev 85 → Rev 84

/xservices/trunk/doc/MailServices/sendMailSimple.xml
File deleted
\ No newline at end of file
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/MailServices.xml
File deleted
\ No newline at end of file
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/BruteXServices_User_Guide.dbk
1,7 → 1,7
<?xml version="1.0" encoding="UTF-8"?><book xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0">
<title>Brutex XServices Documentation</title>
<bookinfo>
<date>Januar 2012</date>
<date>February, 16th 2010</date>
<author>
<firstname>Brian</firstname>
<surname>Rosenberger</surname>
9,7 → 9,7
</author>
<corpname>Brutex Network</corpname>
<copyright>
<year>2012</year>
<year>2011</year>
</copyright>
<legalnotice>
<para>
20,29 → 20,66
</para>
</legalnotice>
<legalnotice>
<para>
<literallayout>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</literallayout></para>
<para>Apache Tomcat and Apache Ant are trademarks of the Apache
Software Foundation.</para>
</legalnotice>
<abstract xml:base="common/abstract.xml">
<title>Abstract</title>
<para>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).</para>
<para>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.</para>
<para>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.</para>
</abstract>
<title>Abstract</title>
<para>In complex IT environments it is necessary to integrate
different information systems with each other, exchange data
between
tools and automate actions and function calls depending
on events
arising from user interaction. To meet the requirements
of
integration building usually means to implement APIs and to
create
tool-to-tool bridges. Web Services can help to clean up
bridges into
interfaces as well as to abstract functions from
their underlying
platform and implementation.</para>
<para>These are the major goals of the loosely coupled
integration
strategy which is in turn one essential idea of a
service-oriented
architecture (SOA).</para>
<para>provide a low level set of functions and web services.
These can
be orchestrated into services and used in business
processes which
make up the execution part of a SOA
environment.</para>
<para>is an add-on to XBridgeNG 2.0. It runs standalone or in
combination with XBridgeNG. Pure XBridgeNG has two
components:</para>
<para>
<itemizedlist>
<listitem>
<para>XML Schema for item based data types (e.g. tickets
from a bug
tracker system or a database record)</para>
</listitem>
<listitem>
<para>Set of Apache Ant tasks to function as a bridge
between the
XBridgeNG XML format at legacy 3rd party
software (e.g. HP Quality
Center, Serena TeamTrack,
...)</para>
</listitem>
<listitem>
<para>The add Web Services (SOAP) wrapper around Apache Ant
tasks
(since XBridgeNG 2.0)</para>
</listitem>
</itemizedlist>
</para>
<para>The current focus is on file-based operations. do not
contain an
integration server or a process execution
engine.</para>
</abstract>
</bookinfo>
<chapter id="installation">
<beginpage/>
3313,7 → 3350,7
]]></programlisting>
</para>
</section>
</section>
</section>
<section id="executeservices" version="5.0" xml:base="ExecuteServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>ExecuteServices</title>
<para>The ExecuteService bundles local and remote command
3790,15 → 3827,6
<para>The FileServces bundles various file operations. Its WSDL is located at
http://server:port/XServices/FileService?wsdl</para>
</section>
<section id="mailservices" version="5.0" xml:base="MailServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>MailServices</title>
<para>The MailService contains mail send and receive operations. Its WSDL is located at
http://server:port/XServices/MailService?wsdl</para>
<section version="5.0" xml:base="MailServices/sendMailSimple.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>sendMailSimple</title>
<para>Send email.</para>
</section>
</section>
<section id="miscservices" version="5.0" xml:base="MiscServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>MiscServices</title>
<para>The MiscService bundles various operations. Its WSDL is located at
3869,16 → 3897,7
]]></screen>
</para>
</section>
<section version="5.0" xml:base="MiscServices/sleep.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>sleep</title>
<para>Delays the response by the given minutes/ seconds. Please note,
that it may take more time to perform the server roundtrip (network
delays, parsing, etc.). Also you may have a network timeout set up in
Tomcat or your client that prevents this web service to respond
correctly.
</para>
</section>
</section>
</section>
</chapter>
 
<chapter id="xmltypes">
/xservices/trunk/doc/MiscServices/sleep.xml
File deleted
\ No newline at end of file
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/BruteXServices_User_Guide.xml
7,7 → 7,7
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Brutex XServices Documentation</title>
<bookinfo>
<date>Januar 2012</date>
<date>February, 16th 2010</date>
<author>
<firstname>Brian</firstname>
<surname>Rosenberger</surname>
15,7 → 15,7
</author>
<corpname>Brutex Network</corpname>
<copyright>
<year>2012</year>
<year>2011</year>
</copyright>
<legalnotice>
<para>
26,20 → 26,6
</para>
</legalnotice>
<legalnotice>
<para>
<literallayout>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</literallayout></para>
<para>Apache Tomcat and Apache Ant are trademarks of the Apache
Software Foundation.</para>
</legalnotice>
49,7 → 35,7
<beginpage />
<title>Getting started</title>
<para>This chapter describes the installation process.</para>
<xi:include href="common/installation.xml" />
<xi:include href="common/installation.xml"/>
</chapter>
<chapter id="services">
<beginpage />
56,11 → 42,10
<title>Available Services</title>
<para>List of available web services and their operations.</para>
<xi:include href="ArchiveServices.xml" />
<xi:include href="DateServices.xml" />
<xi:include href="DateServices.xml" />
<xi:include href="ExecuteServices.xml" />
<xi:include href="FileServices.xml" />
<xi:include href="MailServices.xml" />
<xi:include href="MiscServices.xml" />
<xi:include href="MiscServices.xml" />
</chapter>
 
<chapter id="xmltypes">
/xservices/trunk/doc/MiscServices.xml
7,5 → 7,4
http://server:port/XServices/MiscService?wsdl</para>
<xi:include href="MiscServices/generateUUID.xml" />
<xi:include href="MiscServices/getHostinfo.xml" />
<xi:include href="MiscServices/sleep.xml" />
</section>
/xservices/trunk/doc/common/abstract.xml
1,8 → 1,59
<?xml version="1.0" encoding="UTF-8"?>
<abstract>
<title>Abstract</title>
<para>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).</para>
<para>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.</para>
<para>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.</para>
</abstract>
<title>Abstract</title>
<para>In complex IT environments it is necessary to integrate
different information systems with each other, exchange data
between
tools and automate actions and function calls depending
on events
arising from user interaction. To meet the requirements
of
integration building usually means to implement APIs and to
create
tool-to-tool bridges. Web Services can help to clean up
bridges into
interfaces as well as to abstract functions from
their underlying
platform and implementation.</para>
<para>These are the major goals of the loosely coupled
integration
strategy which is in turn one essential idea of a
service-oriented
architecture (SOA).</para>
<para>provide a low level set of functions and web services.
These can
be orchestrated into services and used in business
processes which
make up the execution part of a SOA
environment.</para>
<para>is an add-on to XBridgeNG 2.0. It runs standalone or in
combination with XBridgeNG. Pure XBridgeNG has two
components:</para>
<para>
<itemizedlist>
<listitem>
<para>XML Schema for item based data types (e.g. tickets
from a bug
tracker system or a database record)</para>
</listitem>
<listitem>
<para>Set of Apache Ant tasks to function as a bridge
between the
XBridgeNG XML format at legacy 3rd party
software (e.g. HP Quality
Center, Serena TeamTrack,
...)</para>
</listitem>
<listitem>
<para>The add Web Services (SOAP) wrapper around Apache Ant
tasks
(since XBridgeNG 2.0)</para>
</listitem>
</itemizedlist>
</para>
<para>The current focus is on file-based operations. do not
contain an
integration server or a process execution
engine.</para>
</abstract>
/xservices/trunk/src/java/net/brutex/xservices/ws/MailService.java
File deleted
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/src/java/net/brutex/xservices/ws/impl/MailServiceImpl.java
File deleted
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/src/java/net/brutex/xservices/ws/impl/MiscServiceImpl.java
37,13 → 37,10
import org.apache.tools.ant.taskdefs.email.EmailTask;
 
/**
* Implements the web service
*
* @author Brian Rosenberger, bru@brutex.de
*/
@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES,
endpointInterface = "net.brutex.xservices.ws.MiscService",
serviceName = "MiscService")
@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES, endpointInterface = "net.brutex.xservices.ws.MiscService", serviceName = "MiscService")
public class MiscServiceImpl implements MiscService {
 
public HostinfoType getHostinfo(String hostname) {
52,7 → 49,6
RunTask runner = new RunTask(info);
info.setHost(hostname);
// info.setPrefix(prefix);
// TODO: Does not work for IP Addresses?
ReturnCode ret = runner.postTask();
HostinfoType infotype = new HostinfoType(
ret.getProperty("NAME"),
/xservices/trunk/src/java/net/brutex/xservices/ws/MiscService.java
30,7 → 30,6
import org.apache.cxf.annotations.WSDLDocumentation;
 
/**
* Bundles various methods
*
* @author Brian Rosenberger, bru@brutex.de
* @since 0.4.0
39,9 → 38,9
@WSDLDocumentation("Various service operations.")
public interface MiscService {
 
/**
* Get IP address from host name.
*
/**
* @param hostname
* @return ReturnCode
*/
50,10 → 49,78
public HostinfoType getHostinfo(
@WebParam(name = "hostname") @XmlElement(minOccurs="1", nillable=false ) String hostname);
 
/**
* Delay execution for a given time.
*
*
* @param mailhost
* @param from
* @param tolist
* @param subject
* @param message
* @return ReturnCode
*/
@WebMethod(operationName = "sendMailSimple")
@WSDLDocumentation(value = "Send an email (simple).")
public ReturnCode sendMailSimple(
@WebParam(name = "mailhost") @XmlElement(minOccurs="1", nillable=false) HostConnection mailhost,
@WebParam(name = "from") @XmlElement(minOccurs="1", nillable=false) String from,
@WebParam(name = "to") @XmlElement(minOccurs="1", nillable=false) String tolist,
@WebParam(name = "subject") String subject,
@WebParam(name = "message") String message);
 
/**
*
* @param mailhost
* @param from
* @param tolist
* @param subject
* @param message
* @param res
* @return ReturnCode
*/
@WebMethod(operationName = "sendMailSimpleWithAttachment")
@WSDLDocumentation(value = "Send an email with attachment (simple).")
public ReturnCode sendMailSimpleWithAttachment(
@WebParam(name = "mailhost") @XmlElement(minOccurs="1", nillable=false) HostConnection mailhost,
@WebParam(name = "from") @XmlElement(minOccurs="1", nillable=false) String from,
@WebParam(name = "to") @XmlElement(minOccurs="1", nillable=false) String tolist,
@WebParam(name = "subject") String subject,
@WebParam(name = "message") String message,
@WebParam(name = "attachments") FileSetResource res);
 
/**
*
* @param mailhost
* @param from
* @param tolist
* @param cclist
* @param bcclist
* @param subject
* @param mimetype
* @param charset
* @param message
* @param res
* @param ssl
* @param tls
* @return ReturnCode
*/
@WebMethod(operationName = "sendMail")
@WSDLDocumentation(value = "Send an email (advanced).")
public ReturnCode sendMail(
@WebParam(name = "mailhost") @XmlElement(minOccurs="1", nillable=false) HostConnection mailhost,
@WebParam(name = "from") @XmlElement(minOccurs="1", nillable=false) String from,
@WebParam(name = "to") @XmlElement(minOccurs="1", nillable=false) String tolist,
@WebParam(name = "cc") String cclist,
@WebParam(name = "bcc") String bcclist,
@WebParam(name = "subject") String subject,
@WebParam(name = "mimetype") MailMimeType mimetype,
@WebParam(name = "charset") String charset,
@WebParam(name = "message") String message,
@WebParam(name = "attachments") FileSetResource res,
@WebParam(name = "useSSL") boolean ssl,
@WebParam(name = "useStartTLS") boolean tls);
 
/**
*
* @param minutes
* @param seconds
* @return ReturnCode
/xservices/trunk/src/java/net/brutex/xservices/ws/XServicesFault.java
28,10 → 28,8
import net.brutex.xservices.util.BrutexNamespaces;
 
/**
* Generic web service fault.
*
* @author Brian Rosenberger, bru@brutex.de
* since 0.4.0
*/
@WebFault(targetNamespace=BrutexNamespaces.WS_XSERVICES)
public class XServicesFault extends Exception {
/xservices/trunk/web/WEB-INF/cxf-beans.xml
47,10 → 47,7
implementor="net.brutex.xservices.ws.impl.JobServiceImpl" address="/JobService">
</jaxws:endpoint>
 
<jaxws:endpoint id="mailservice"
implementor="net.brutex.xservices.ws.impl.MailServiceImpl" address="/MailService">
</jaxws:endpoint>
 
<jaxws:endpoint id="miscservice"
implementor="net.brutex.xservices.ws.impl.MiscServiceImpl" address="/MiscService">
</jaxws:endpoint>