Host

Config

<config>
	<service-dir>C:/service_state</service-dir>
	<http-port>8081</http-port>
</config>

Service

<service>
	<uri>http://localhost:8081/myservice</uri>
</service>

Blueprint

Read more about Blueprints.

Partial Blueprint: a partial blueprint can be used for service classes that were defined using Dream attributes .

<blueprint>
	<assembly>dream.tutorial.8ball</assembly>
	<class>MindTouch.Dream.Tutorial.EightBallService</class>
</blueprint>

Complete Blueprint: a complete blueprint specifies all the information required to instantiate a Dream service.  The service class only needs to implement the IDreamService interface.

<blueprint>
    <assembly Version="1.0.0.0" Culture="neutral" PublicKeyToken="null">dream.tutorial.8ball</assembly>
    <class>MindTouch.Dream.Tutorial.EightBallService</class>
    <name>Dream Tutorial 8-Ball</name>
    <copyright>Copyright (c) 2006, 2007 MindTouch, Inc.</copyright>
    <info>http://doc.opengarden.org/Dream_SDK/Tutorials/8-Ball</info>

    <!-- the configuration element describes how to configure the service -->
    <configuration>
        <entry>
            <xpath>nolog</xpath>
            <valuetype>void?</valuetype>
            <description>When present, service will not create a log sub-service at /@log.</description>
        </entry>
        <entry>
            <xpath>uri.host</xpath>
            <valuetype>uri?</valuetype>
            <description>Uri for host service (provided by Host).</description>
        </entry>
        <entry>
            <xpath>uri.self</xpath>
            <valuetype>uri</valuetype>
            <description>Uri for current service (provided by Host).</description>
        </entry>
    </configuration>

    <!-- the 'features' element list all service features -->
    <features>
        <feature>
            <pattern>GET:</pattern>
            <description>Returns a random 8-ball message</description>
            <info>http://doc.opengarden.org/Dream_SDK/Tutorials/8-Ball</info>
            <method>GetAnswer</method>
            <statusfilter>2xx</statusfilter>
        </feature>
    </features>
</blueprint>

InitConfig

<config>
	<path>8ball</path>
	<class>MindTouch.Dream.Tutorial.EightBallService</class>
</config>

Script

<script>
	<action verb="POST" path="/host/register">
		<blueprint>
			<assembly>dream.tutorial.8ball</assembly>
			<class>MindTouch.Dream.Tutorial.EightBallService</class>
		</blueprint>
	</action>
	<action verb="POST" path="/host/start">
		<config>
			<path>8ball</path>
			<class>MindTouch.Dream.Tutorial.EightBallService</class>
		</config>
	</action>
</script>

ScriptResults

<results>...</results>

GET:blueprints

Retrieve list of all registered blueprints.

POST:blueprints

Register a service blueprint.

GET:blueprints/{sid-or-typename}

Retrieve the blueprint of a given serice type.

DELETE:blueprints/{sid-or-typename}

Remove a service blueprint.

POST:convert

This feature is simply a passthrough.  That is, it replies with whatever document is in the request body.  Combined with the built-in Dream request processing parameters, it can be used to convert from any standard Dream format to any other.

POST:execute

Execute an XML script.

POST:load

Load an assembly and register all contained services.

POST:register (OBSOLETE)

Register a service blueprint.

GET:services

Retrieves a list of all running services.

POST:services

Start a service instance.

POST:shutdown

    ---    ---

Shutdown host service and all running services.

POST:start (OBSOLETE)

Start a service instance.

POST:stop

Stop a service instance.

*:test

This feature responds to any HTTP verb (GET, PUT, POST, etc.).   The request body is optional and can be any valid XML document.  The response is an XML document built from the requeset body and all included request headers.  The response status code can be specified by the status query argument.

This feature has multiple uses:

• to test if the Host service is running by doing a simple GET:test/
• to inspect what kind of headers were sent by the client since these are reflected in the response message
• to test the client response handlers by overwriting the response status code

POST:unregister (OBSOLETE)

Remove a service blueprint.

GET:versions

Retrieve version information about Dream assemblies.

POST:xmltransform

This feature applies the XSLT document provided by URI to the XML document in the request body.