The actual service API is defined in org.oddjob.rest.OddjobApi
.
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. |
serviceOnly | Only enable the Oddjob Web Service, not the accompanying html. |
servicePath | The context path for the Oddjob web service. |
uploadDirectory | Upload directory. |
webappDir | The directory for the html files for oddjob web. |
webappResource | The class path to the html files for oddjob web. |
Example 1 | Provide an Oddjob web client. |
Example 2 | Provide an Oddjob web service only without the client. |
Configured By | ATTRIBUTE |
Access | READ_WRITE |
Required | No. Default to false. |
Is cross origin content allowed?
Configured By | ATTRIBUTE |
Access | READ_WRITE |
Required | No. |
The context path.
Configured By | ELEMENT |
Access | READ_WRITE |
Required | No. Defaults are used. |
Set parameters for MultiPartConfig so that file upload from a form works.
Configured By | ATTRIBUTE |
Access | READ_WRITE |
Required | Yes. |
The root Oddjob component to expose via the web service.
Configured By | ATTRIBUTE |
Access | READ_WRITE |
Required | No. |
Only enable the Oddjob Web Service, not the accompanying html.
Configured By | ATTRIBUTE |
Access | READ_WRITE |
Required | No. Defaults to '/' |
The context path for the Oddjob web service.
Configured By | ELEMENT |
Access | READ_WRITE |
Required | No. Defaults tmp dir. |
Upload directory. Required for an action form that specifies a file.
Configured By | ELEMENT |
Access | READ_WRITE |
Required | No. |
The directory for the html files for oddjob web. Mainly used for development to save stopping and starting Jetty.
Configured By | ATTRIBUTE |
Access | READ_WRITE |
Required | No. Defaults to the webapp in the jar at org/oddjob/webapp. |
The class path to the html files for oddjob web.
Provide an Oddjob web client.
<oddjob id="this"> <job> <sequential> <jobs> <web:server id="server" port="${server.port}" xmlns:web="oddjob:web"> <handlers> <web:oddjob-web root="${jobs}"/> </handlers> </web:server> <sequential id="jobs"> <jobs> <echo name="Echo 1">Hello</echo> <echo name="Echo 2">Hello</echo> </jobs> </sequential> </jobs> </sequential> </job> </oddjob>
Provide an Oddjob web service only without the client.
<oddjob> <job> <sequential> <jobs> <web:server id="server" xmlns:web="oddjob:web"> <handlers> <web:oddjob-web serviceOnly="true" root="${jobs}"/> </handlers> </web:server> <sequential id="jobs"> <jobs> <echo name="Echo 1">Hello</echo> <echo name="Echo 2">Hello</echo> </jobs> </sequential> </jobs> </sequential> </job> </oddjob>