[Index]

web:ui-server

Provide an Oddjob Web UI Server. This provides an incredibly simple Server to get up and running quickly. For Basic Authentication or SSL then the web:server must be used with an web:remote-handler.

Property Summary

allowCrossOrigin	Is cross-origin content allowed?
classLoader	The classloader passed to Jetty.
jmxServer	An Oddjob JMX Server.
multiPartConfig	Set parameters for MultiPartConfig so that file upload from a form works.
name	The name of service.
port	The port number the server listens on.
root	The root component to expose.
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 Summary

Example 1

The simplest web server without any handlers.

Property Detail

allowCrossOrigin

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

Is cross-origin content allowed?

classLoader

Configured By	ELEMENT
Access	READ_WRITE
Required	No.

The classloader passed to Jetty. If not set then Jetty and RESTEasy use the Thread context classloader. This is set by Oddjob's service adapter to be the classloader that loaded this component which will be the Oddball classloader. Setting this classloader will be complicated as it may require the Oddball classloader as a parent.

jmxServer

Configured By	ATTRIBUTE
Access	READ_WRITE
Required	No, creates a default internal one.

An Oddjob JMX Server.

multiPartConfig

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

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

name

Configured By	ATTRIBUTE
Access	READ_WRITE
Required	No.

The name of service. Can be any text.

port

Configured By	ATTRIBUTE
Access	READ_WRITE
Required	No, uses a random available port.

The port number the server listens on.

root

Configured By	ATTRIBUTE
Access	READ_WRITE
Required	No, but a Jmx Server must be provided instead.

The root component to expose.

uploadDirectory

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

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

webappDir

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.

webappResource

Configured By	ATTRIBUTE
Access	READ_WRITE
Required	No. Defaults to /dist on the class path.

The class path to the html files for oddjob web.

Examples

Example 1

The simplest web server without any handlers.

<oddjob id="this">
  <job>
    <web:server id="server" xmlns:web="oddjob:web"/>
  </job>
</oddjob>