com.lf.commons.web.msg

Class UpdateMessage

java.lang.Object

com.lf.commons.web.msg.XMLMessage

com.lf.commons.web.msg.UpdateMessage

All Implemented Interfaces:

AbstractMessage

public class UpdateMessage
extends XMLMessage

Represents an update response message in XML format based on 'update_message.dtd'.

Since:

1.6

Version:

$Revision: 1.9 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UPDATE_MESSAGE_DOCNAME The name of the root element.
static java.lang.String	UPDATE_MESSAGE_DTD The underlying DTD.

Fields inherited from class com.lf.commons.web.msg.XMLMessage

docname, document, dtd, encoding, format

Constructor Summary

Constructors

Constructor and Description
UpdateMessage() Constructs an instance based on a given DTD.
UpdateMessage(java.lang.String version, java.util.Properties props, WebApplication[] updates, java.util.Properties config) Constructs a message instance based on the given update parameters.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Vector<java.util.Properties>	getReleases() Provides the number of update releases.
int	getUpdateCount() Provides the number of update releases.

Methods inherited from class com.lf.commons.web.msg.XMLMessage

canProcess, getAttribute, getAttributeValue, getContents, getDocument, getDTD, getElement, getElements, getElementValue, getEncoding, getIntFunctionResult, isArmed, isValid, printDocument, read, read, setEncoding, setFormat, write, write

Methods inherited from class java.lang.Object

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

Field Detail

UPDATE_MESSAGE_DTD

public static final java.lang.String UPDATE_MESSAGE_DTD

The underlying DTD.

See Also:

Constant Field Values

UPDATE_MESSAGE_DOCNAME

public static final java.lang.String UPDATE_MESSAGE_DOCNAME

The name of the root element.

See Also:

Constant Field Values

Constructor Detail

UpdateMessage

public UpdateMessage()

Constructs an instance based on a given DTD.

UpdateMessage

public UpdateMessage(java.lang.String version,
             java.util.Properties props,
             WebApplication[] updates,
             java.util.Properties config)

Constructs a message instance based on the given update parameters.

This convenience constructor gets the update parameters and embeds them into an XML file based on 'update_message.dtd'.

Parameters:

version - Currently only "1.0"

props - The request parameters

updates - Array with available updates, may be empty

config - The optional config updates for the running application

Method Detail

getUpdateCount

public int getUpdateCount()

Provides the number of update releases.

Returns:

Number of updates, may be 0

getReleases

public java.util.Vector<java.util.Properties> getReleases()

Provides the number of update releases.

Returns:

Release properties, may be null or empty