org.xwiki.bridge
Interface DocumentAccessBridge

@ComponentRole
public interface DocumentAccessBridge

Exposes methods for accessing Document data. This is temporary until we remodel the Model classes and the Document services.

Since:

1.6M1

Version:

$Id$

Method Summary

boolean	exists(DocumentReference documentReference) Check if a document exists or not in the wiki.
boolean	exists(java.lang.String documentReference) Deprecated. replaced by exists(DocumentReference) since 2.2.1
java.io.InputStream	getAttachmentContent(AttachmentName attachmentName) Deprecated. replaced by getAttachmentContent(org.xwiki.model.reference.AttachmentReference) since 2.2M1
java.io.InputStream	getAttachmentContent(AttachmentReference attachmentReference) Returns the content of a document attachment.
byte[]	getAttachmentContent(java.lang.String documentReference, java.lang.String attachmentName) Deprecated. use getAttachmentContent(org.xwiki.model.reference.AttachmentReference) instead
java.util.List<AttachmentReference>	getAttachmentReferences(DocumentReference documentReference) Retrieves all attachments in the passed document.
java.util.List<AttachmentName>	getAttachments(DocumentName documentName) Deprecated. replaced by getAttachmentReferences(DocumentReference) since 2.2M1
java.lang.String	getAttachmentURL(AttachmentName attachmentName, boolean isFullURL) Deprecated. replaced by getAttachmentURL(AttachmentReference , boolean) since 2.2M1
java.lang.String	getAttachmentURL(AttachmentReference attachmentReference, boolean isFullURL) Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used to access an attachment.
java.lang.String	getAttachmentURL(AttachmentReference attachmentReference, java.lang.String queryString, boolean isFullURL) Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used to access an attachment.
java.lang.String	getAttachmentURL(java.lang.String documentReference, java.lang.String attachmentFilename) Deprecated. use getAttachmentURL(org.xwiki.model.reference.AttachmentReference , boolean) instead
java.util.List<java.lang.String>	getAttachmentURLs(DocumentName documentName, boolean isFullURL) Deprecated. use getAttachmentReferences(org.xwiki.model.reference.DocumentReference) instead
java.util.List<java.lang.String>	getAttachmentURLs(DocumentReference documentReference, boolean isFullURL) Deprecated. use getAttachmentReferences(org.xwiki.model.reference.DocumentReference) instead
java.lang.String	getAttachmentVersion(AttachmentReference attachmentReference) Returns the current version of a document attachment.
DocumentName	getCurrentDocumentName() Deprecated. replaced by getCurrentDocumentReference() since 2.2M1
DocumentReference	getCurrentDocumentReference() Get the reference to the current document (found in the Context).
java.lang.String	getCurrentUser() Utility method to retrieve the current user.
java.lang.String	getCurrentWiki() Deprecated. replaced by ModelContext.getCurrentEntityReference() since 2.2M1
java.lang.String	getDefaultEncoding()
DocumentModelBridge	getDocument(DocumentName documentName) Deprecated. replaced by getDocument(org.xwiki.model.reference.DocumentReference) since 2.2M1
DocumentModelBridge	getDocument(DocumentReference documentReference) Get the document object associated with the passed document name.
DocumentModelBridge	getDocument(java.lang.String documentReference) Deprecated. use getDocument(org.xwiki.model.reference.DocumentReference) instead
java.lang.String	getDocumentContent(DocumentReference documentReference, java.lang.String language) Retrieves the textual content of the document, in the given language.
java.lang.String	getDocumentContent(java.lang.String documentReference) Deprecated. replaced by getDocument(DocumentReference) and DocumentModelBridge.getContent() since 2.2.1
java.lang.String	getDocumentContent(java.lang.String documentReference, java.lang.String language) Deprecated. replaced by getDocumentContent(DocumentReference, String) since 2.2.1
java.lang.String	getDocumentContentForDefaultLanguage(DocumentReference documentReference) Retrieves the textual content of the document, in the document's default language.
java.lang.String	getDocumentContentForDefaultLanguage(java.lang.String documentReference) Deprecated. replaced by getDocumentContentForDefaultLanguage(DocumentReference) since 2.2.1
DocumentName	getDocumentName(java.lang.String documentName) Deprecated. replaced by DocumentReferenceResolver since 2.2M1
java.lang.String	getDocumentSyntaxId(java.lang.String documentReference) Deprecated. replaced by getDocument(DocumentReference) and DocumentModelBridge.getSyntaxId() since 2.2.1
java.lang.String	getDocumentURL(DocumentReference documentReference, java.lang.String action, java.lang.String queryString, java.lang.String anchor) Retrieves the internal (without the hostname) URL that can be used to access a document, using a specific action.
java.lang.String	getDocumentURL(DocumentReference documentReference, java.lang.String action, java.lang.String queryString, java.lang.String anchor, boolean isFullURL) Retrieves the relitive (without the hostname) or absolute (with the hostname) URL that can be used to access a document, using a specific action.
java.util.List<java.lang.Object>	getProperties(java.lang.String documentReference, java.lang.String className)
java.lang.Object	getProperty(DocumentReference documentReference, DocumentReference classReference, java.lang.String propertyName) Retrieves the value for an object property, from the first object of the given class.
java.lang.Object	getProperty(java.lang.String documentReference, java.lang.String propertyName) Retrieves the value for an object property, from the first object of any class that has a property with that name.
java.lang.Object	getProperty(java.lang.String documentReference, java.lang.String className, int objectNumber, java.lang.String propertyName) Retrieves the value for an object property.
java.lang.Object	getProperty(java.lang.String documentReference, java.lang.String className, java.lang.String propertyName) Deprecated. since 2.2M1 use getProperty(DocumentReference, DocumentReference, String) instead
java.lang.String	getPropertyType(java.lang.String className, java.lang.String propertyName)
java.lang.String	getURL(java.lang.String documentReference, java.lang.String action, java.lang.String queryString, java.lang.String anchor) Deprecated. replaced by getDocumentURL(DocumentReference, String, String, String) since 2.2.1
boolean	hasProgrammingRights()
boolean	isDocumentEditable(DocumentReference documentReference)
boolean	isDocumentEditable(java.lang.String documentReference) Deprecated. use isDocumentEditable(org.xwiki.model.reference.DocumentReference) instead
boolean	isDocumentViewable(DocumentReference documentReference)
boolean	isDocumentViewable(java.lang.String documentReference) Deprecated. use isDocumentViewable(org.xwiki.model.reference.DocumentReference) instead
boolean	isPropertyCustomMapped(java.lang.String className, java.lang.String propertyName)
void	popDocumentFromContext(java.util.Map<java.lang.String,java.lang.Object> backupObjects) Restore values saved in a backup object in the XWiki Context and restore the current document with the same value before pushDocumentInContext(Map, String) was called.
void	pushDocumentInContext(java.util.Map<java.lang.String,java.lang.Object> backupObjects, DocumentReference documentReference) Sets the passed document as the current document in the XWiki Context and saves current values related to the current document into a backup object.
void	pushDocumentInContext(java.util.Map<java.lang.String,java.lang.Object> backupObjects, java.lang.String documentReference) Deprecated. use pushDocumentInContext(Map, DocumentReference) instead
void	setAttachmentContent(AttachmentReference attachmentReference, byte[] attachmentData) Sets the content of a document attachment.
void	setAttachmentContent(java.lang.String documentReference, java.lang.String attachmentFilename, byte[] attachmentData) Deprecated. replaced by getAttachmentContent(AttachmentReference) since 2.2.1
void	setCurrentUser(java.lang.String userName) Utility method to set the current user.
void	setDocumentContent(DocumentReference documentReference, java.lang.String content, java.lang.String editComment, boolean isMinorEdit) Updates the target document with the new content provided.
void	setDocumentContent(java.lang.String documentReference, java.lang.String content, java.lang.String editComment, boolean isMinorEdit) Deprecated. replaced by setDocumentContent(DocumentReference, String, String, boolean) since 2.2.1
void	setDocumentParentReference(DocumentReference documentReference, DocumentReference parentReference) Sets the parent document name attribute for this document.
void	setDocumentSyntaxId(DocumentReference documentReference, java.lang.String syntaxId) Changes the syntax Id of the target document to the given syntaxId.
void	setDocumentSyntaxId(java.lang.String documentReference, java.lang.String syntaxId) Deprecated. replaced by setDocumentSyntaxId(DocumentReference, String) since 2.2.1
void	setDocumentTitle(DocumentReference documentReference, java.lang.String title) Sets the title of this document.
void	setProperty(DocumentReference documentReference, DocumentReference classReference, java.lang.String propertyName, java.lang.Object propertyValue) Sets the given property of the first object (of the given class) attached to the document.
void	setProperty(java.lang.String documentReference, java.lang.String className, java.lang.String propertyName, java.lang.Object propertyValue) Deprecated. use {@link DocumentAccessBridge#setProperty(DocumentReference, DocumentReference, String, Object)

Method Detail

getDocument

@Deprecated
DocumentModelBridge getDocument(java.lang.String documentReference)
                                throws java.lang.Exception

Deprecated. use getDocument(org.xwiki.model.reference.DocumentReference) instead

Get the document object associated with the passed document name.

Parameters:

documentReference - the String reference of the document to find

Returns:

the document object matching the passed document name

Throws:

java.lang.Exception - when the storage cannot be accessed

getDocument

DocumentModelBridge getDocument(DocumentReference documentReference)
                                throws java.lang.Exception

Get the document object associated with the passed document name.

Parameters:

documentReference - the name of the document to find

Returns:

the document object matching the passed document name

Throws:

java.lang.Exception - when the storage cannot be accessed

Since:

2.2M1

getDocument

@Deprecated
DocumentModelBridge getDocument(DocumentName documentName)
                                throws java.lang.Exception

Deprecated. replaced by getDocument(org.xwiki.model.reference.DocumentReference) since 2.2M1

Get the document object associated with the passed document name.

Parameters:

documentName - the name of the document to find

Returns:

the document object matching the passed document name

Throws:

java.lang.Exception - when the storage cannot be accessed

getDocumentName

@Deprecated
DocumentName getDocumentName(java.lang.String documentName)

Deprecated. replaced by DocumentReferenceResolver since 2.2M1

Get the different parts of a document name (wiki, space, page).

Parameters:

documentName - the name of the document for which to return name information

Returns:

the document name object containing the information

getCurrentDocumentName

@Deprecated
DocumentName getCurrentDocumentName()

Deprecated. replaced by getCurrentDocumentReference() since 2.2M1

Get the different parts of a the current document name (wiki, space, page).

The current document is found in the context.

Returns:

the document name object containing the information

getCurrentDocumentReference

DocumentReference getCurrentDocumentReference()

Get the reference to the current document (found in the Context).

Returns:

the reference to the current document

Since:

2.2M1

exists

boolean exists(DocumentReference documentReference)

Check if a document exists or not in the wiki.

Parameters:

documentReference - The reference of the document to check.

Returns:

true if the document already exists, false otherwise.

Since:

2.2.1

exists

@Deprecated
boolean exists(java.lang.String documentReference)

Deprecated. replaced by exists(DocumentReference) since 2.2.1

Check if a document exists or not in the wiki.

Parameters:

documentReference - The reference of the document to check.

Returns:

true if the document already exists, false otherwise.

setDocumentContent

void setDocumentContent(DocumentReference documentReference,
                        java.lang.String content,
                        java.lang.String editComment,
                        boolean isMinorEdit)
                        throws java.lang.Exception

Updates the target document with the new content provided. If the target document does not exists, a new one will be created.

Parameters:

documentReference - the reference to the target document

content - Content to be set.

editComment - Comment describing this particular change.

isMinorEdit - Flag indicating if this change is a minor one.

Throws:

java.lang.Exception - if the storage cannot be accessed.

Since:

2.2.1

setDocumentContent

@Deprecated
void setDocumentContent(java.lang.String documentReference,
                                   java.lang.String content,
                                   java.lang.String editComment,
                                   boolean isMinorEdit)
                        throws java.lang.Exception

Deprecated. replaced by setDocumentContent(DocumentReference, String, String, boolean) since 2.2.1

Updates the target document with the new content provided. If the target document does not exists, a new one will be created.

Parameters:

documentReference - the reference to the target document

content - Content to be set.

editComment - Comment describing this particular change.

isMinorEdit - Flag indicating if this change is a minor one.

Throws:

java.lang.Exception - if the storage cannot be accessed.

getDocumentContent

@Deprecated
java.lang.String getDocumentContent(java.lang.String documentReference)
                                    throws java.lang.Exception

Deprecated. replaced by getDocument(DocumentReference) and DocumentModelBridge.getContent() since 2.2.1

Retrieves the textual content of the document, in the current language.

Parameters:

documentReference - the reference of the document to access

Returns:

The document's content.

Throws:

java.lang.Exception - If the document cannot be accessed.

getDocumentSyntaxId

@Deprecated
java.lang.String getDocumentSyntaxId(java.lang.String documentReference)
                                     throws java.lang.Exception

Deprecated. replaced by getDocument(DocumentReference) and DocumentModelBridge.getSyntaxId() since 2.2.1

Get the syntax Id of the target document. If the target document does not exists, the default syntax of a new document is returned.

Parameters:

documentReference - the reference of the target document

Returns:

the syntax id.

Throws:

java.lang.Exception - If the storage cannot be accessed.

setDocumentSyntaxId

void setDocumentSyntaxId(DocumentReference documentReference,
                         java.lang.String syntaxId)
                         throws java.lang.Exception

Changes the syntax Id of the target document to the given syntaxId. If the target document does not exists, a new one will be created.

Parameters:

documentReference - the reference of the target document

syntaxId - New syntax Id.

Throws:

java.lang.Exception - If the storage cannot be accessed.

Since:

2.2.1

setDocumentSyntaxId

@Deprecated
void setDocumentSyntaxId(java.lang.String documentReference,
                                    java.lang.String syntaxId)
                         throws java.lang.Exception

Deprecated. replaced by setDocumentSyntaxId(DocumentReference, String) since 2.2.1

Changes the syntax Id of the target document to the given syntaxId. If the target document does not exists, a new one will be created.

Parameters:

documentReference - the reference of the target document

syntaxId - New syntax Id.

Throws:

java.lang.Exception - If the storage cannot be accessed.

setDocumentParentReference

void setDocumentParentReference(DocumentReference documentReference,
                                DocumentReference parentReference)
                                throws java.lang.Exception

Sets the parent document name attribute for this document.

Parameters:

documentReference - the reference of the target document

parentReference - name of the parent document.

Throws:

java.lang.Exception - If the storage cannot be accessed.

Since:

2.2

setDocumentTitle

void setDocumentTitle(DocumentReference documentReference,
                      java.lang.String title)
                      throws java.lang.Exception

Sets the title of this document.

Parameters:

documentReference - the reference of the target document

title - the title to be set.

Throws:

java.lang.Exception - If the storage cannot be accessed.

Since:

2.2

getDocumentContentForDefaultLanguage

java.lang.String getDocumentContentForDefaultLanguage(DocumentReference documentReference)
                                                      throws java.lang.Exception

Retrieves the textual content of the document, in the document's default language.

Note: you should always use getDocumentContent(String) unless you really need specifically the document's content for default language of the document.

Parameters:

documentReference - the reference of the document to access

Returns:

The document's content.

Throws:

java.lang.Exception - If the document cannot be accessed.

Since:

2.2.1

getDocumentContentForDefaultLanguage

@Deprecated
java.lang.String getDocumentContentForDefaultLanguage(java.lang.String documentReference)
                                                      throws java.lang.Exception

Deprecated. replaced by getDocumentContentForDefaultLanguage(DocumentReference) since 2.2.1

Retrieves the textual content of the document, in the document's default language.

Note: you should always use getDocumentContent(String) unless you really need specifically the document's content for default language of the document.

Parameters:

documentReference - the reference of the document to access

Returns:

The document's content.

Throws:

java.lang.Exception - If the document cannot be accessed.

getDocumentContent

java.lang.String getDocumentContent(DocumentReference documentReference,
                                    java.lang.String language)
                                    throws java.lang.Exception

Retrieves the textual content of the document, in the given language.

Parameters:

documentReference - the referenc of the document to access

language - The desired translation of the document.

Returns:

The document's content.

Throws:

java.lang.Exception - If the document cannot be accessed.

Since:

2.2.1

getDocumentContent

@Deprecated
java.lang.String getDocumentContent(java.lang.String documentReference,
                                               java.lang.String language)
                                    throws java.lang.Exception

Deprecated. replaced by getDocumentContent(DocumentReference, String) since 2.2.1

Retrieves the textual content of the document, in the given language.

Parameters:

documentReference - the referenc of the document to access

language - The desired translation of the document.

Returns:

The document's content.

Throws:

java.lang.Exception - If the document cannot be accessed.

getProperty

java.lang.Object getProperty(java.lang.String documentReference,
                             java.lang.String className,
                             int objectNumber,
                             java.lang.String propertyName)

Retrieves the value for an object property.

Parameters:

documentReference - the reference of the document to access

className - The name of the class.

objectNumber - The number of the object from the given class.

propertyName - The name of the property to retrieve.

Returns:

the property value or null if it doesn't exist or an error occurred while looking for the property (the document doesn't exist for example)

getProperty

@Deprecated
java.lang.Object getProperty(java.lang.String documentReference,
                                        java.lang.String className,
                                        java.lang.String propertyName)

Deprecated. since 2.2M1 use getProperty(DocumentReference, DocumentReference, String) instead

Retrieves the value for an object property, from the first object of the given class.

Parameters:

documentReference - the reference of the document to access

className - The name of the class.

propertyName - The name of the property to retrieve.

Returns:

the property value or null if it doesn't exist or an error occurred while looking for the property (the document doesn't exist for example)

getProperty

java.lang.Object getProperty(DocumentReference documentReference,
                             DocumentReference classReference,
                             java.lang.String propertyName)

Retrieves the value for an object property, from the first object of the given class.

Parameters:

documentReference - the reference of the document to access

classReference - the reference to the XWiki Class

propertyName - The name of the property to retrieve.

Returns:

the property value or null if it doesn't exist or an error occurred while looking for the property (the document doesn't exist for example)

Since:

2.2M1

getProperty

java.lang.Object getProperty(java.lang.String documentReference,
                             java.lang.String propertyName)

Retrieves the value for an object property, from the first object of any class that has a property with that name.

Parameters:

documentReference - the reference of the document to access

propertyName - The name of the property to retrieve.

Returns:

the property value or null if it doesn't exist or an error occurred while looking for the property (the document doesn't exist for example)

getProperties

java.util.List<java.lang.Object> getProperties(java.lang.String documentReference,
                                               java.lang.String className)

Parameters:

documentReference - the reference of the document to access

className - the name of the class in the passed document from which to get the properties

Returns:

the list of properties available in the passed document and class names

getPropertyType

java.lang.String getPropertyType(java.lang.String className,
                                 java.lang.String propertyName)
                                 throws java.lang.Exception

Parameters:

className - The name of the class.

propertyName - The name of the property.

Returns:

class name of the property object or null if property is not found. For example StringProperty, IntegerProperty.

Throws:

java.lang.Exception - if class cannot be accessed

isPropertyCustomMapped

boolean isPropertyCustomMapped(java.lang.String className,
                               java.lang.String propertyName)
                               throws java.lang.Exception

Parameters:

className - The name of the class.

propertyName - The name of the property of the class.

Returns:

is the property stored in a special custom mapped class.

Throws:

java.lang.Exception - if class cannot be accessed

setProperty

@Deprecated
void setProperty(java.lang.String documentReference,
                            java.lang.String className,
                            java.lang.String propertyName,
                            java.lang.Object propertyValue)
                 throws java.lang.Exception

Deprecated. use {@link DocumentAccessBridge#setProperty(DocumentReference, DocumentReference, String, Object)

Sets the given property of the first object (of the given class) attached to the document. If no such object exists, this method will create a new object of the given class, attach it to the document and set the property.

Parameters:

documentReference - the reference of the document to access

className - name of the class.

propertyName - name of the property to set.

propertyValue - value of the property to set.

Throws:

java.lang.Exception - if the document cannot be accessed.

setProperty

void setProperty(DocumentReference documentReference,
                 DocumentReference classReference,
                 java.lang.String propertyName,
                 java.lang.Object propertyValue)
                 throws java.lang.Exception

Sets the given property of the first object (of the given class) attached to the document. If no such object exists, this method will create a new object of the given class, attach it to the document and set the property.

Parameters:

documentReference - the reference of the document to access

classReference - the reference of the class.

propertyName - name of the property to set.

propertyValue - value of the property to set.

Throws:

java.lang.Exception - if the document cannot be accessed.

getAttachmentContent

@Deprecated
byte[] getAttachmentContent(java.lang.String documentReference,
                                       java.lang.String attachmentName)
                            throws java.lang.Exception

Deprecated. use getAttachmentContent(org.xwiki.model.reference.AttachmentReference) instead

Returns the content of a document attachment.

Parameters:

documentReference - the reference of the document to access

attachmentName - The filename of the attachment to access.

Returns:

The content of the attachment, as an array of bytes, which is empty if the attachment does not exist.

Throws:

java.lang.Exception - If the document cannot be accessed.

getAttachmentContent

java.io.InputStream getAttachmentContent(AttachmentReference attachmentReference)
                                         throws java.lang.Exception

Returns the content of a document attachment.

Parameters:

attachmentReference - the name of the attachment to access

Returns:

The content of the attachment, as an array of bytes, which is empty if the attachment does not exist

Throws:

java.lang.Exception - If the document cannot be accessed.

Since:

2.2M1

getAttachmentContent

@Deprecated
java.io.InputStream getAttachmentContent(AttachmentName attachmentName)
                                         throws java.lang.Exception

Deprecated. replaced by getAttachmentContent(org.xwiki.model.reference.AttachmentReference) since 2.2M1

Returns the content of a document attachment.

Parameters:

attachmentName - the name of the attachment to access

Returns:

The content of the attachment, as an array of bytes, which is empty if the attachment does not exist

Throws:

java.lang.Exception - If the document cannot be accessed.

setAttachmentContent

void setAttachmentContent(AttachmentReference attachmentReference,
                          byte[] attachmentData)
                          throws java.lang.Exception

Sets the content of a document attachment. If the document or the attachment does not exist, both will be created newly.

Parameters:

attachmentReference - the name of the attachment to access

attachmentData - Attachment content.

Throws:

java.lang.Exception - If the storage cannot be accessed.

Since:

2.2.1

setAttachmentContent

@Deprecated
void setAttachmentContent(java.lang.String documentReference,
                                     java.lang.String attachmentFilename,
                                     byte[] attachmentData)
                          throws java.lang.Exception

Deprecated. replaced by getAttachmentContent(AttachmentReference) since 2.2.1

Sets the content of a document attachment. If the document or the attachment does not exist, both will be created newly.

Parameters:

documentReference - the reference to the target document name

attachmentFilename - the name of the attachment

attachmentData - Attachment content.

Throws:

java.lang.Exception - If the storage cannot be accessed.

getAttachmentVersion

java.lang.String getAttachmentVersion(AttachmentReference attachmentReference)
                                      throws java.lang.Exception

Returns the current version of a document attachment.

Parameters:

attachmentReference - identifies the attachment to access

Returns:

the current version of the specified attachment, null if the attachment does not exist

Throws:

java.lang.Exception - if the document cannot be accessed

Since:

2.5M2

getDocumentURL

java.lang.String getDocumentURL(DocumentReference documentReference,
                                java.lang.String action,
                                java.lang.String queryString,
                                java.lang.String anchor)

Retrieves the internal (without the hostname) URL that can be used to access a document, using a specific action.

Parameters:

documentReference - the reference of the document to access

action - The "mode" in which the document is accessed, for example view to view the document, edit to open the document for modifications, etc.

queryString - An optional query string to append to the URL, use null or an empty string to skip.

anchor - An optional URL fragment to append to the URL, use null or an empty string to skip.

Returns:

A String representation of the URL, starting with the path segment of the URL (without protocol, host and port), for example /xwiki/bin/save/Main/WebHome?content=abc.

Since:

2.2.1

getDocumentURL

java.lang.String getDocumentURL(DocumentReference documentReference,
                                java.lang.String action,
                                java.lang.String queryString,
                                java.lang.String anchor,
                                boolean isFullURL)

Retrieves the relitive (without the hostname) or absolute (with the hostname) URL that can be used to access a document, using a specific action.

Parameters:

documentReference - the reference of the document to access

action - The "mode" in which the document is accessed, for example view to view the document, edit to open the document for modifications, etc.

queryString - An optional query string to append to the URL, use null or an empty string to skip.

anchor - An optional URL fragment to append to the URL, use null or an empty string to skip.

isFullURL - if true then the URL will be an absolute URL which contains the host name, and protocol.

Returns:

A String representation of the URL, starting with the path segment of the URL (without protocol, host and port), for example /xwiki/bin/save/Main/WebHome?content=abc.

Since:

2.5M1

getURL

@Deprecated
java.lang.String getURL(java.lang.String documentReference,
                                   java.lang.String action,
                                   java.lang.String queryString,
                                   java.lang.String anchor)

Deprecated. replaced by getDocumentURL(DocumentReference, String, String, String) since 2.2.1

Retrieves the internal (without the hostname) URL that can be used to access a document, using a specific action.

Parameters:

documentReference - the reference of the document to access

action - The "mode" in which the document is accessed, for example view to view the document, edit to open the document for modifications, etc.

queryString - An optional query string to append to the URL, use null or an empty string to skip.

anchor - An optional URL fragment to append to the URL, use null or an empty string to skip.

Returns:

A String representation of the URL, starting with the path segment of the URL (without protocol, host and port), for example /xwiki/bin/save/Main/WebHome?content=abc.

getAttachmentReferences

java.util.List<AttachmentReference> getAttachmentReferences(DocumentReference documentReference)
                                                            throws java.lang.Exception

Retrieves all attachments in the passed document.

Parameters:

documentReference - the reference to the document for which to retrieve all attachment references

Returns:

the list of attachment names in the passed document

Throws:

java.lang.Exception - in case of a storage issue finding all attachments for the document matching the passed name

Since:

2.2M1

getAttachments

@Deprecated
java.util.List<AttachmentName> getAttachments(DocumentName documentName)
                                              throws java.lang.Exception

Deprecated. replaced by getAttachmentReferences(DocumentReference) since 2.2M1

Retrieves all attachments in the passed document.

Parameters:

documentName - the document for which to retrieve all attachment names

Returns:

the list of attachment names in the passed document

Throws:

java.lang.Exception - in case of a storage issue finding all attachments for the document matching the passed name

getAttachmentURL

@Deprecated
java.lang.String getAttachmentURL(java.lang.String documentReference,
                                             java.lang.String attachmentFilename)

Deprecated. use getAttachmentURL(org.xwiki.model.reference.AttachmentReference , boolean) instead

Retrieves the relative URL (ie the path without the hostname and port) that can be used to access an attachment.

Parameters:

documentReference - the reference to the document containing the attachment (eg "wiki:Space.Page")

attachmentFilename - the attachment name (eg "my.png")

Returns:

the attachment URL

getAttachmentURL

java.lang.String getAttachmentURL(AttachmentReference attachmentReference,
                                  boolean isFullURL)

Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used to access an attachment.

Parameters:

attachmentReference - the attachment name for which to find the URL

isFullURL - whether the returned URL will a relative URL or the full URL

Returns:

the attachment URL

Since:

2.2M1

getAttachmentURL

java.lang.String getAttachmentURL(AttachmentReference attachmentReference,
                                  java.lang.String queryString,
                                  boolean isFullURL)

Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used to access an attachment.

Parameters:

attachmentReference - the attachment name for which to find the URL

queryString - An optional query string to append to the URL, use null or an empty string to skip.

isFullURL - whether the returned URL will a relative URL or the full URL

Returns:

the attachment URL

Since:

2.5RC1

getAttachmentURL

@Deprecated
java.lang.String getAttachmentURL(AttachmentName attachmentName,
                                             boolean isFullURL)

Deprecated. replaced by getAttachmentURL(AttachmentReference , boolean) since 2.2M1

Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used to access an attachment.

Parameters:

attachmentName - the attachment name for which to find the URL

isFullURL - whether the returned URL will a relative URL or the full URL

Returns:

the attachment URL

getAttachmentURLs

@Deprecated
java.util.List<java.lang.String> getAttachmentURLs(DocumentReference documentReference,
                                                              boolean isFullURL)
                                                   throws java.lang.Exception

Deprecated. use getAttachmentReferences(org.xwiki.model.reference.DocumentReference) instead

Parameters:

documentReference - the document for which to retrieve all attachment URLs

isFullURL - whether the returned URL will a relative URL or the full URL

Returns:

the list of attachment URLs (either relative ie the path without the hostname and port, or the full URL) for all attachments in the passed document

Throws:

java.lang.Exception - in case of a storage issue finding all attachments for the document matching the passed name

Since:

2.2M1

getAttachmentURLs

@Deprecated
java.util.List<java.lang.String> getAttachmentURLs(DocumentName documentName,
                                                              boolean isFullURL)
                                                   throws java.lang.Exception

Deprecated. use getAttachmentReferences(org.xwiki.model.reference.DocumentReference) instead

Parameters:

documentName - the document for which to retrieve all attachment URLs

isFullURL - whether the returned URL will a relative URL or the full URL

Returns:

the list of attachment URLs (either relative ie the path without the hostname and port, or the full URL) for all attachments in the passed document

Throws:

java.lang.Exception - in case of a storage issue finding all attachments for the document matching the passed name

isDocumentViewable

boolean isDocumentViewable(DocumentReference documentReference)

Parameters:

documentReference - the reference of the document to access

Returns:

true if current user can view provided document.

Since:

2.2.1

isDocumentViewable

@Deprecated
boolean isDocumentViewable(java.lang.String documentReference)

Deprecated. use isDocumentViewable(org.xwiki.model.reference.DocumentReference) instead

Parameters:

documentReference - the reference of the document to access

Returns:

true if current user can view provided document.

isDocumentEditable

@Deprecated
boolean isDocumentEditable(java.lang.String documentReference)

Deprecated. use isDocumentEditable(org.xwiki.model.reference.DocumentReference) instead

Parameters:

documentReference - the reference of the document to be edited

Returns:

True if current user has 'edit' access on the target document.

isDocumentEditable

boolean isDocumentEditable(DocumentReference documentReference)

Parameters:

documentReference - the name of the document to be edited.

Returns:

True if current user has 'edit' access on the target document.

Since:

2.2M1

hasProgrammingRights

boolean hasProgrammingRights()

Returns:

true if the current document's author has programming rights.

getCurrentUser

java.lang.String getCurrentUser()

Utility method to retrieve the current user.

Returns:

the current user full reference.

setCurrentUser

void setCurrentUser(java.lang.String userName)

Utility method to set the current user.

Parameters:

userName - the current user

Since:

2.4M2

getDefaultEncoding

java.lang.String getDefaultEncoding()

Returns:

The default encoding for the current wiki.

pushDocumentInContext

@Deprecated
void pushDocumentInContext(java.util.Map<java.lang.String,java.lang.Object> backupObjects,
                                      java.lang.String documentReference)
                           throws java.lang.Exception

Deprecated. use pushDocumentInContext(Map, DocumentReference) instead

Sets the passed document as the current document in the XWiki Context and saves current values related to the current document into a backup object.

Parameters:

backupObjects - the object in which to some context properties will be saved

documentReference - the reference to the document to set as the current document

Throws:

java.lang.Exception - in case of an error like a problem loading the document from the database

pushDocumentInContext

void pushDocumentInContext(java.util.Map<java.lang.String,java.lang.Object> backupObjects,
                           DocumentReference documentReference)
                           throws java.lang.Exception

Sets the passed document as the current document in the XWiki Context and saves current values related to the current document into a backup object.

Parameters:

backupObjects - the object in which to some context properties will be saved

documentReference - the reference to the document to set as the current document

Throws:

java.lang.Exception - in case of an error like a problem loading the document from the database

Since:

2.2.1

popDocumentFromContext

void popDocumentFromContext(java.util.Map<java.lang.String,java.lang.Object> backupObjects)

Restore values saved in a backup object in the XWiki Context and restore the current document with the same value before pushDocumentInContext(Map, String) was called.

Parameters:

backupObjects - the object containing the backed-up context properties to restore

getCurrentWiki

@Deprecated
java.lang.String getCurrentWiki()

Deprecated. replaced by ModelContext.getCurrentEntityReference() since 2.2M1

Returns:

the current wiki