XML-Element  <web_service>     (Konfiguration)

Web-Dienste lassen sich einrichten, um Aufträge oder Tasks zu erzeugen. Die angenommene Anforderung wird sofort beantwortet. Das Ergebnis des Auftrags oder der Task kann zu einem anderen Web-Dienst weitergeleitet werden.

Der TCP-Port des HTTP-Servers wird mit <config tcp_port="…"> festgelegt.

Zwei Arten von Web-Services werden unterschieden:

• Web-Service mit job_chain
• Web-Service mit request_xslt_stylesheet

Web-Service mit job_chain

Beispiel  

<web_service 
   name      = "my_web_service" 
   url_path  = "/web_service"
   job_chain = "web_service" 
   timeout   = "900"
/>

Ein HTTP-POST auf den URL-Pfad des Web-Dienstes lässt den Scheduler einen Auftrag erzeugen und ihn in die angegebene Jobkette einreihen. Die Jobs haben Zugriff auf die HTTP-Daten über Order.web_service_operation. Die HTTP-Anfrage wird mit Web_service_response.send() beantwortet.

Web-Service mit request_xslt_stylesheet

Beispiel  

<web_service 
   name                     = "my_web_service" 
   url_path                 = "/web_service"
   request_xslt_stylesheet  = "$SCHEDULER_DIR/web_service_request.xsl"
   response_xslt_stylesheet = "$SCHEDULER_DIR/web_service_response.xsl"
   forward_xslt_stylesheet  = "$SCHEDULER_DIR/web_service_forward.xsl"
/>

Ein HTTP-POST auf den URL-Pfad des Web-Dienstes löst folgende Schritte aus.

1. Das mit HTTP-POST übergebene XML-Dokument packt der Scheduler in ein <service_request>.

   <service_request>
       <web_service name="service_name" url_path="url_path"/>
       <content>…xmldata…</content>
   </service_request>

2. Das <service_request> wird mit dem Stylesheet request_xslt_stylesheet in ein XML-Kommando transformiert, in der Regel <add_order> oder <start_job>.
3. Der Scheduler führt das XML-Kommando aus.
4. Die Antwort des XML-Kommandos (<spooler><answer>, die auch eine Fehlermeldung <ERROR> enthalten kann) wird mit dem response_xslt_stylesheet zu einem <service_response> transformiert. Der Scheduler liefert den Inhalt von <content> über die offene HTTP-Verbindung zurück.

   <service_response>
       <content>…xmldata…</content>
   </service_response>

5. Um eine ungültige Anforderung zu beantworten, kann das Stylesheet request_xslt_stylesheet sofort ein <service_response> liefern.

Fehlerbehandlung

Wenn mit POST kein XML-Dokument übergeben worden ist, führt das zum HTTP-Fehlercode "404 Bad Request".
Ein Fehler in der Transformation führt zum HTTP-Fehlercode "500 Internal Server Error".

Ergebnis der Ausführung weiterleiten (Forwarding)

Aufträge und Tasks können einem Web-Dienst zugeordnet sein. Die Kommandos <add_order> und <start_job> erhalten dazu das neue Attribut web_service="service_name".

Solche Aufträge und Tasks werden, wenn sie enden und dem Web-Dienst ein forward_xslt_stylesheet zugeordnet ist, mit diesem als <order> bzw. <task> übergeben:

<order service="service_name" last_job="job_name" …>
    <payload>
        <params>
            …
        </params>
    </payload>
    <log last_error="…" last_warning="…"/>
    …
</order>

bzw.

<task job="…" …>
    <log last_error="…" last_warning="…"/>
    …
</task>

Ergebnis der Transformation ist ein <service_request>:

<service_request url="url">
    <content>…data…</content>
</service_request>

Jobkette scheduler_service_forwarding

Der Scheduler packt das <service_request> in die Payload eines neuen Auftrags und übergibt diesen der vordefinierten Jobkette scheduler_service_forwarding.

Job scheduler_service_forwarder

Der einzige Job der Jobkette, scheduler_service_forwarder, baut mit dem URL eine HTTP-Verbindung auf, überträgt mit POST die Daten, wartet die Antwort ab und protokolliert sie.

Eigenschaften des Jobs können in der Konfigurationsdatei eingestellt werden, wie wenn der Job mit <base> bekannt gemacht worden wäre. Ein Beispiel:

<job name="scheduler_service_forwarder">
    <delay_order_after_setback setback_count="1" delay="00:01"/>
    <delay_order_after_setback setback_count="2" delay="01:00"/>
    <delay_order_after_setback setback_count="3" delay="24:00"/>
    <run_time>
        <period begin="07:00" end="17:00"/>
    </run_time>
</job>

Implementiert ist der Job in Java (siehe auch <web_service forward_xslt_stylesheet="…">).

Verhalten mit <base>

Ergänzt ein Element <web_service> an der entsprechenden Stelle aus der Basiskonfiguration. In <web_service> angegebene Attribute überschreiben die aus der Basiskonfiguration.

Eltern-Elemente

Attribute

name="name" Name des Dienstes im Scheduler

url_path="url_path" URL-Pfad, unter dem der Web-Dienst ansprechbar ist

job_chain="job_chain" Jobkette, die Web-Service-Operationen ausführt

timeout="seconds" Frist

request_xslt_stylesheet="path" Transformiert die Anforderung in ein Scheduler-Kommando

response_xslt_stylesheet="path" Transformiert die Antwort des Kommandos in die Antwort des Web-Dienstes

forward_xslt_stylesheet="path" Zur Weiterleitung am Ende des Auftrags bzw. der Task

debug="yes|no" (Initialwert: no)    

Kind-Elemente

<web_service … request_xslt_stylesheet="…/web_service_request.xsl" …>
    <params>
        <param name="job_chain" value="my_job_chain"/>
    <params>
</web_service>

<xsl:stylesheet xmlns:xsl = "http://www.w3.org/1999/XSL/Transform" version="1.0">
    <xsl:param name="job_chain"/>

    <xsl:template match="/service_request">
        <xsl:element name="add_order">
            <xsl:attribute name="job_chain"><xsl:value-of select="$job_chain"/></xsl:attribute>
            <xsl:attribute name="web_service"><xsl:value-of select="web_service/@name"/></xsl:attribute>
            <params>…</params>
        </xsl:element>
    </xsl:template>
</xsl:stylesheet>

Meldungen