[Index]

web:oddjob-rest

Provide the Oddjob REST Service.

The actual service API is defined in org.oddjob.rest.OddjobApi.

Property Summary

allowCrossOrigin	Is cross origin content allowed?
contextPath	The context path.
multiPartConfig	Set parameters for MultiPartConfig so that file upload from a form works.
root	The root Oddjob component to expose via the web service.
servicePath	The context path for the Oddjob web service.
uploadDirectory	Upload directory.

Example Summary

Example 1

Provide an Oddjob web service only without the client.

Property Detail

allowCrossOrigin

Configured By	ATTRIBUTE
Access	READ_WRITE
Required	No. Default to false.

Is cross origin content allowed?

contextPath

Configured By	ATTRIBUTE
Access	READ_WRITE
Required	No.

The context path.

multiPartConfig

Configured By	ELEMENT
Access	READ_WRITE
Required	No. Defaults are used.

Set parameters for MultiPartConfig so that file upload from a form works.

root

Configured By	ATTRIBUTE
Access	READ_WRITE
Required	Yes.

The root Oddjob component to expose via the web service.

servicePath

Configured By	ATTRIBUTE
Access	READ_WRITE
Required	No. Defaults to '/'

The context path for the Oddjob web service.

uploadDirectory

Configured By	ELEMENT
Access	READ_WRITE
Required	No. Defaults tmp dir.

Upload directory. Required for an action form that specifies a file.

Examples

Example 1

Provide an Oddjob web service only without the client.

<oddjob>
  <job>
    <sequential>
      <jobs>
        <web:server id="server" xmlns:web="oddjob:web">
          <handler>
            <web:oddjob-rest root="${jobs}"/>
          </handler>
        </web:server>
        <sequential id="jobs">
          <jobs>
            <echo name="Echo 1">Hello</echo>
            <echo name="Echo 2">Hello</echo>
          </jobs>
        </sequential>
      </jobs>
    </sequential>
  </job>
</oddjob>