Package org.apache.jackrabbit.webdav.jcr.version.report

Class RepositoryDescriptorsReport

java.lang.Object

org.apache.jackrabbit.webdav.version.report.AbstractReport

org.apache.jackrabbit.webdav.jcr.version.report.AbstractJcrReport

org.apache.jackrabbit.webdav.jcr.version.report.RepositoryDescriptorsReport

All Implemented Interfaces:

org.apache.jackrabbit.commons.webdav.JcrRemotingConstants, ItemResourceConstants, org.apache.jackrabbit.webdav.version.report.Report, org.apache.jackrabbit.webdav.xml.XmlSerializable

public class RepositoryDescriptorsReport
extends AbstractJcrReport
implements ItemResourceConstants

RepositoryDescriptorsReport allows to retrieve the repository descriptors. The request body must be an empty 'dcr:repositorydescriptors' element:

 <!ELEMENT repositorydescriptors EMPTY >
 

The response body must match the following format

 <!ELEMENT repositorydescriptors-report ( descriptor )* >
 <!ELEMENT descriptor ( descriptorkey, descriptorvalue+ ) >
 <!ELEMENT descriptorkey (#PCDATA) >
 <!ELEMENT descriptorvalue (#PCDATA) >
 <!ATTLIST descriptorvalue
      type ( Reference | Path | Name | Boolean | String | Date | Double |
               Long | Binary | WeakReference | URI | Decimal )
   >
 

See Also:

Repository.getDescriptorKeys(), Repository.getDescriptor(String), Repository.getDescriptorValue(String), Repository.getDescriptorValues(String)

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.jackrabbit.webdav.version.report.ReportType	REPOSITORY_DESCRIPTORS_REPORT	The registered type of this report.

Fields inherited from interface org.apache.jackrabbit.webdav.jcr.ItemResourceConstants

EXCLUSIVE_SESSION, JCR_DEFINITION, JCR_DEPTH, JCR_GET_STRING, JCR_INDEX, JCR_ISMODIFIED, JCR_ISNEW, JCR_LENGTH, JCR_LENGTHS, JCR_MIXINNODETYPES, JCR_NAME, JCR_NAMESPACES, JCR_NODETYPES_CND, JCR_PARENT, JCR_PATH, JCR_PRIMARYITEM, JCR_PRIMARYNODETYPE, JCR_REFERENCES, JCR_SELECTOR_NAME, JCR_TYPE, JCR_UUID, JCR_VALUE, JCR_VALUES, JCR_VERSIONABLEUUID, JCR_WEAK_REFERENCES, JCR_WORKSPACE_NAME, METHODS, NAMESPACE, PRIVILEGE_JCR_ADD_NODE, PRIVILEGE_JCR_READ, PRIVILEGE_JCR_REMOVE, PRIVILEGE_JCR_SET_PROPERTY

Fields inherited from interface org.apache.jackrabbit.commons.webdav.JcrRemotingConstants

ATTR_VALUE_TYPE, IMPORT_UUID_BEHAVIOR, JCR_DEFINITION_LN, JCR_DEPTH_LN, JCR_GET_STRING_LN, JCR_INDEX_LN, JCR_ISMODIFIED_LN, JCR_ISNEW_LN, JCR_LENGTH_LN, JCR_LENGTHS_LN, JCR_MIXINNODETYPES_LN, JCR_NAME_LN, JCR_NAMESPACES_LN, JCR_NODETYPES_CND_LN, JCR_PARENT_LN, JCR_PATH_LN, JCR_PRIMARYITEM_LN, JCR_PRIMARYNODETYPE_LN, JCR_QUERY_RESULT_LN, JCR_REFERENCES_LN, JCR_SELECTOR_NAME_LN, JCR_TYPE_LN, JCR_UUID_LN, JCR_VALUE_LN, JCR_VALUES_LN, JCR_VERSIONABLEUUID_LN, JCR_WEAK_REFERENCES_LN, JCR_WORKSPACE_NAME_LN, NS_PREFIX, NS_URI, RELATION_REMOTE_SESSION_ID, RELATION_USER_DATA, REPORT_EXPORT_VIEW, REPORT_LOCATE_BY_UUID, REPORT_LOCATE_CORRESPONDING_NODE, REPORT_NODETYPES, REPORT_PRIVILEGES, REPORT_REGISTERED_NAMESPACES, REPORT_REPOSITORY_DESCRIPTORS, ROOT_ITEM_PATH, ROOT_ITEM_RESOURCEPATH, VERSIONSTORAGE_PATH, XML_ALLOWUPDATE, XML_CND, XML_DESCRIPTOR, XML_DESCRIPTORKEY, XML_DESCRIPTORVALUE, XML_EXCLUSIVE_SESSION_SCOPED, XML_LENGTH, XML_NAMESPACE, XML_NODETYPENAME, XML_PREFIX, XML_PRIMARYNODETYPE, XML_QUERY_RESULT_COLUMN, XML_RELPATH, XML_REMOVEEXISTING, XML_URI, XML_VALUE

Constructor Summary

Constructors

Constructor	Description
RepositoryDescriptorsReport()

Method Summary

Modifier and Type	Method	Description
org.apache.jackrabbit.webdav.version.report.ReportType	getType()	Returns REPOSITORY_DESCRIPTORS_REPORT type.
void	init(org.apache.jackrabbit.webdav.DavResource resource, org.apache.jackrabbit.webdav.version.report.ReportInfo info)	Performs basic validation checks common to all JCR specific reports.
boolean	isMultiStatusReport()	Always returns false.
Element	toXml(Document document)	Returns a Xml representation of the repository descriptors according to the info object.

Methods inherited from class org.apache.jackrabbit.webdav.version.report.AbstractReport

normalizeResourceHref

Methods inherited from class java.lang.Object

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

Field Detail

REPOSITORY_DESCRIPTORS_REPORT

public static final org.apache.jackrabbit.webdav.version.report.ReportType REPOSITORY_DESCRIPTORS_REPORT

The registered type of this report.

Constructor Detail

RepositoryDescriptorsReport

public RepositoryDescriptorsReport()

Method Detail

getType

public org.apache.jackrabbit.webdav.version.report.ReportType getType()

Returns REPOSITORY_DESCRIPTORS_REPORT type.

Specified by:

getType in interface org.apache.jackrabbit.webdav.version.report.Report

Returns:

REPOSITORY_DESCRIPTORS_REPORT

See Also:

Report.getType()

isMultiStatusReport

public boolean isMultiStatusReport()

Always returns false.

Specified by:

isMultiStatusReport in interface org.apache.jackrabbit.webdav.version.report.Report

Returns:

false

See Also:

Report.isMultiStatusReport()

init

public void init(org.apache.jackrabbit.webdav.DavResource resource,
                 org.apache.jackrabbit.webdav.version.report.ReportInfo info)
          throws org.apache.jackrabbit.webdav.DavException

Description copied from class: AbstractJcrReport

Performs basic validation checks common to all JCR specific reports.

Specified by:

init in interface org.apache.jackrabbit.webdav.version.report.Report

Overrides:

init in class AbstractJcrReport

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

Report.init(DavResource, ReportInfo)

toXml

public Element toXml(Document document)

Returns a Xml representation of the repository descriptors according to the info object.

Specified by:

toXml in interface org.apache.jackrabbit.webdav.xml.XmlSerializable

Parameters:

document -

Returns:

Xml representation of the repository descriptors

See Also:

XmlSerializable.toXml(Document)