Jetty has moved!
Jetty is a project at the Eclipse Foundation.
Homepage:http://www.eclipse.org/jetty
Downloads: http://download.eclipse.org/jetty/
Documentation:http://www.eclipse.org/jetty/documentation/current/
About:http://www.eclipse.org/jetty/about.php
Jetty Powered:http://www.eclipse.org/jetty/powered/
Contact the core Jetty developers at www.webtide.com
private support for your internal/customer projects ... custom extensions and distributions ... versioned snapshots for indefinite support ... scalability guidance for your apps and Ajax/Comet projects ... development services from 1 day to full product delivery
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Configure.dtd 

This is the document type descriptor for the org.mortbay.util.XmlConfiguration class.  It allows a java object to be configured by with a sequence of Set, Put and Call elements.  These tags are mapped to methods on the object to be configured as follows:

    <Set  name="Test">value</Set>                          ==  obj.setTest("value");
    <Put  name="Test">value</Put>                           ==  obj.put("Test","value");
    <Call name="test"><Arg>value</Arg></Call>       ==  obj.test("value");

Values themselves are matched to arguments on a best effort approach, but types may be specified if a match is not achieved.

Configure Element

This is the root element that specifies the class of object that can be configured:

    <Configure class="org.mortbay.jetty.Server> . . . </Configure>

The Configure element can contain the Set, Put or Call elements.

Set Element

This element maps to a call to a set method on the current object.  The name and optional type attributes are used to select the set method.  If the name given is xxx, then a setXxx method is used, or the xxx field is used of setXxx cannot be found. 

A Set element can contain value text and/or the value elements Call, New and SystemProperty.  If no value type is specified, then white space is trimmed out of the value.  If it contains multiple value elements they are added as strings before being converted to any specified type.

A Set with a class attribute is treated as a static set method invocation.

    <Set name="xyz">
            . . .
    </Set>

Get Element

This element maps to a call to a get method of field on the current object.  The name attribute is used to select the get method.  If the name given is xxx, then a getXxx method is used, or the xxx field is used of setXxx cannot be found. 

A Get element can contain Set, Put and/or Call elements which act on the object returned by the get call.

    <Get name="xyz">
              <Set name="xyzMethod"><New class="org.mortbay.jetty.xyz"/></Set>
    </Get>

A Get with a class attribute is treated as a static get method or field.

Put Element

This element maps to a call to a put method on the current object, which must implement the Map interface.  The name attribute is used as the put key and the optional type attribute can force the type of  the value. 

A Put element can contain value text and/or the value elements Call, New and SystemProperty.  If no value type is specified, the white space is trimmed out of the value.  If it contains multiple value elements, they are added as strings before being converted to any specified type.

     <Put name="admin">admin</Put>

Call Element

This element maps to an arbitrary call to a method on the current object.  The name attribute and Arg elements are used to select the method.

A Call element can contain a sequence of Arg elements followed by a sequence of Set, Put and/or Call elements which act on any object returned by the original call:

<Call name="test"><Arg>value1</Arg><Set name="Test">Value2</Set></Call>

    This is equivalent to:

        Object o2 = o1.test("value1");
        o2.setTest("value2");

A Call with a class attribute is treated as a static call.

Arg Element

This element defines a positional argument for the Call element.  The optional type attribute can force the type of the value.

An Arg element can contain value text and/or the value elements Call, New and SystemProperty. If no value type is specified, then white space is trimmed out of the value. If it contains multiple value elements they are added as strings before being converted to any specified type.

    <Arg><Ref id="Server"/></Arg>
    <Arg>./webapps</Arg>
    <Arg>org/mortbay/jetty/webapp/webdefault.xml</Arg>
    <Arg type="boolean">True</Arg>
    <Arg type="boolean">False</Arg> 

   The Ref tag here points to the Call element referring to a class

New Element

This element allows the creation of a new object as part of a value of a Set, Put or Arg element. The class attribute determines the type of the new object and the contained Arg elements are used to select the constructor for the new object.

A New element can contain a sequence of Arg elements followed bya sequence of Set, Put and/or Call elements which act on the new object:

<New class="com.acme.MyClass">
        <Arg>value1</Arg><Set name="Test">Value2</Set>
    </New>

    This is equivalent to:

        Object o = new com.acme.MyClass("value1");
        o.setTest("value2");

Ref Element

This element allows a previously created object to be referenced by id.

A Ref element can contain a sequence of Set, Put and/or Call elements which act on the referenced object:

            <Ref id="myobject" />
                <Set name="Test">Value2</Set>
        </New>

Array Element

This element allows the creation of a new array as part of a value of a Set, Put or Arg element. The type attribute determines the type of the new array and the contained Item elements are used for each element of the array.

<Array type="java.lang.String">
        <Item>value0</Item>
        <Item><New class="java.lang.String"><Arg>value1</Arg></New></Item>
    </Array>

    This is equivalent to String[] a = new String[]

Unknown macro: {"value0", new String("value1")}

;

Map Element

This element allows the creation of a new array as part of a value of a Set, Put or Arg element. The type attribute determines the type of the new array and the contained Item elements are used for each element of the array

<Map>
        <Entry>
            <Item>keyName</Item>
            <Item><New class="java.lang.String"><Arg>value1</Arg></New></Item>
        </Entry>
    </Map>

    This is equivalent to String[] a = new String[]

Unknown macro: { "value0", new String("value1") }

;

 Item Element

This element defines an entry for the Array or Map Entry elements. The optional type attribute can force the type of the value.

An Item element can contain value text and/or the value elements Call, New and SystemProperty. If no value type is specified, then white space is trimmed out of the value. If it contains multiple value elements they are added as strings before being converted to any specified type.

    <Item>
        <New class="org.mortbay.jetty.nio.SelectChannelConnector">
            <Set name="port">8080</Set>
            <Set name="maxIdleTime">30000</Set>
            <Set name="Acceptors">10</Set>
        </New>
    </Item>

SystemProperty Element

This element allows JVM System properties to be retrieved as part of the value of a Set, Put or Arg element.  The name attribute specifies the property name and the optional default argument provides a default value.
   

<SystemProperty name="Test" default="value"/>

    This is equivalent to:

        System.getProperty("Test","value");

  • No labels
Contact the core Jetty developers at www.webtide.com
private support for your internal/customer projects ... custom extensions and distributions ... versioned snapshots for indefinite support ... scalability guidance for your apps and Ajax/Comet projects ... development services from 1 day to full product delivery