org.igniterealtime.jbosh

Class ComposableBody

java.lang.Object

org.igniterealtime.jbosh.AbstractBody

org.igniterealtime.jbosh.ComposableBody

public final class ComposableBody
extends AbstractBody

Implementation of the AbstractBody class which allows for the definition of messages from individual elements of a body.

A message is constructed by creating a builder, manipulating the configuration of the builder, and then building it into a class instance, as in the following example:

 ComposableBody body = ComposableBody.builder()
     .setNamespaceDefinition("foo", "http://foo.com/bar")
     .setPayloadXML("Data to send to remote server")
     .build();
 

Class instances can also be "rebuilt", allowing them to be used as templates when building many similar messages:

 ComposableBody body2 = body.rebuild()
     .setPayloadXML("More data to send")
     .build();
 

This class does only minimal syntactic and semantic checking with respect to what the generated XML will look like. It is up to the developer to protect against the definition of malformed XML messages when building instances of this class.

Instances of this class are immutable and thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComposableBody.Builder Class instance builder, after the builder pattern.

Method Summary

Modifier and Type	Method and Description
static ComposableBody.Builder	builder() Create a builder instance to build new instances of this class.
Map<BodyQName,String>	getAttributes() Get a map of all defined attribute names with their corresponding values.
String	getPayloadXML() Get the paylaod XML in String form.
ComposableBody.Builder	rebuild() If this ComposableBody instance is a dynamic instance, uses this ComposableBody instance as a starting point, create a builder which can be used to create another ComposableBody instance based on this one.
String	toXML() Get an XML String representation of this message.

Methods inherited from class org.igniterealtime.jbosh.AbstractBody

getAttribute, getAttributeNames

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ComposableBody.Builder builder()

Create a builder instance to build new instances of this class.

Returns:

AbstractBody instance

rebuild

public ComposableBody.Builder rebuild()

If this ComposableBody instance is a dynamic instance, uses this ComposableBody instance as a starting point, create a builder which can be used to create another ComposableBody instance based on this one. This allows a ComposableBody instance to be used as a template. Note that the use of the returned builder in no way modifies or manipulates the current ComposableBody instance.

Returns:

builder instance which can be used to build similar ComposableBody instances

getAttributes

public Map<BodyQName,String> getAttributes()

Get a map of all defined attribute names with their corresponding values.

Specified by:

getAttributes in class AbstractBody

Returns:

map of qualified attributes

toXML

public String toXML()

Get an XML String representation of this message.

Specified by:

toXML in class AbstractBody

Returns:

XML string representing the body message

getPayloadXML

public String getPayloadXML()

Get the paylaod XML in String form.

Returns:

payload XML