org.apache.jackrabbit.webdav.transaction

Class TransactionInfo

java.lang.Object

org.apache.jackrabbit.webdav.transaction.TransactionInfo

All Implemented Interfaces:

TransactionConstants, XmlSerializable

public class TransactionInfo
extends java.lang.Object
implements TransactionConstants, XmlSerializable

TransactionInfo class encapsulates the information present in the TransactionConstants.XML_TRANSACTIONINFO element that forms the request body of the UNLOCk request for a transaction lock.

See Also:

TransactionConstants.XML_TRANSACTIONINFO, TransactionConstants.XML_TRANSACTION

Field Summary

Fields inherited from interface org.apache.jackrabbit.webdav.transaction.TransactionConstants

GLOBAL, HEADER_TRANSACTIONID, LOCAL, NAMESPACE, TRANSACTION, XML_COMMIT, XML_GLOBAL, XML_LOCAL, XML_ROLLBACK, XML_TRANSACTION, XML_TRANSACTIONINFO, XML_TRANSACTIONSTATUS

Constructor Summary

Constructors

Constructor and Description
TransactionInfo(boolean isCommit) Creates a TransactionInfo object
TransactionInfo(org.w3c.dom.Element transactionInfo) Creates a TransactionInfo object from the given 'transactionInfo' element.

Method Summary

Modifier and Type	Method and Description
boolean	isCommit() Returns true, if this info requires a 'commit' action, false otherwise (i.e.
org.w3c.dom.Element	toXml(org.w3c.dom.Document document) Returns the xml representation of the implementing object as Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionInfo

public TransactionInfo(boolean isCommit)

Creates a TransactionInfo object

Parameters:

isCommit -

TransactionInfo

public TransactionInfo(org.w3c.dom.Element transactionInfo)
                throws DavException

Creates a TransactionInfo object from the given 'transactionInfo' element. The 'transactionInfo' must have the following form:

  <!ELEMENT transactioninfo (transactionstatus) >
  <!ELEMENT transactionstatus ( commit | rollback ) >
  <!ELEMENT commit EMPTY >
  <!ELEMENT rollback EMPTY >
 

Parameters:

transactionInfo - as present in the UNLOCK request body.

Throws:

java.lang.IllegalArgumentException - if the given transactionInfo element is not valid.

DavException

Method Detail

isCommit

public boolean isCommit()

Returns true, if this info requires a 'commit' action, false otherwise (i.e. 'rollback' is requested).

Returns:

true if a 'commit' element was present. false otherwise.

See Also:

TransactionConstants.XML_COMMIT, TransactionConstants.XML_ROLLBACK

toXml

public org.w3c.dom.Element toXml(org.w3c.dom.Document document)

Description copied from interface: XmlSerializable

Returns the xml representation of the implementing object as Element. The given Document is used as factory and represents the owner document of the returned DOM element.

Specified by:

toXml in interface XmlSerializable

Parameters:

document -

Returns:

a w3c element representing this object

See Also:

XmlSerializable.toXml(Document)