Package com.xpn.xwiki.doc

Class DefaultDocumentAccessBridge

java.lang.Object

com.xpn.xwiki.doc.DefaultDocumentAccessBridge

All Implemented Interfaces:

DocumentAccessBridge

@Component
@Singleton
public class DefaultDocumentAccessBridge
extends Object
implements DocumentAccessBridge

Exposes methods for accessing Document data. This is temporary until we remodel the Model classes and the Document services. The implementation is inside the old core, and not in a component because it has dependencies on the old core.

Since:

1.6M1

Version:

$Id: e5fb8263b1567ed0d518a96226a942c09e5f72e1 $

Constructor Summary

Constructors

Constructor	Description
DefaultDocumentAccessBridge()

Method Summary

Modifier and Type	Method	Description
boolean	exists(String documentReference)	Deprecated.
boolean	exists(DocumentReference documentReference)
byte[]	getAttachmentContent(String documentReference, String attachmentFilename)	Deprecated.
InputStream	getAttachmentContent(AttachmentReference attachmentReference)	Deprecated.
InputStream	getAttachmentContent(EntityReference reference)
List<AttachmentReference>	getAttachmentReferences(DocumentReference documentReference)
String	getAttachmentURL(String documentReference, String attachmentName)	Deprecated.
String	getAttachmentURL(AttachmentReference attachmentReference, boolean isFullURL)
String	getAttachmentURL(AttachmentReference attachmentReference, String queryString, boolean isFullURL)
List<String>	getAttachmentURLs(DocumentReference documentReference, boolean isFullURL)	Deprecated.
String	getAttachmentVersion(AttachmentReference attachmentReference)
DocumentReference	getCurrentAuthorReference()
DocumentReference	getCurrentDocumentReference()
String	getCurrentUser()	Deprecated.
DocumentReference	getCurrentUserReference()
String	getCurrentWiki()
String	getDefaultEncoding()
DocumentModelBridge	getDocument(String documentReference)	Deprecated.
DocumentModelBridge	getDocument(DocumentReference documentReference)	Deprecated.
String	getDocumentContent(String documentReference)	Deprecated.
String	getDocumentContent(String documentReference, String language)	Deprecated.
String	getDocumentContent(DocumentReference documentReference, String language)
String	getDocumentContentForDefaultLanguage(String documentReference)	Deprecated.
String	getDocumentContentForDefaultLanguage(DocumentReference documentReference)
DocumentModelBridge	getDocumentInstance(DocumentReference documentReference)
DocumentModelBridge	getDocumentInstance(EntityReference reference)
DocumentReference	getDocumentReference(EntityReference entityReference)
String	getDocumentSyntaxId(String documentReference)	Deprecated.
String	getDocumentURL(DocumentReference documentReference, String action, String queryString, String anchor)
String	getDocumentURL(DocumentReference documentReference, String action, String queryString, String anchor, boolean isFullURL)
String	getDocumentURL(EntityReference entityReference, String action, String queryString, String anchor)
String	getDocumentURL(EntityReference entityReference, String action, String queryString, String anchor, boolean isFullURL)
int	getObjectNumber(DocumentReference documentReference, DocumentReference classReference, String propertyName, String valueToMatch)
List<Object>	getProperties(String documentReference, String className)
Object	getProperty(String documentReference, String propertyName)
Object	getProperty(String documentReference, String className, int objectNumber, String propertyName)
Object	getProperty(String documentReference, String className, String propertyName)	Deprecated.
Object	getProperty(DocumentReference documentReference, DocumentReference classReference, int objectNumber, String propertyName)
Object	getProperty(DocumentReference documentReference, DocumentReference classReference, String propertyName)
Object	getProperty(ObjectPropertyReference objectPropertyReference)
Object	getProperty(ObjectReference objectReference, String propertyName)
String	getPropertyType(String className, String propertyName)
DocumentModelBridge	getTranslatedDocumentInstance(DocumentModelBridge document)
DocumentModelBridge	getTranslatedDocumentInstance(DocumentReference documentReference)
DocumentModelBridge	getTranslatedDocumentInstance(EntityReference entityReference)
String	getURL(String documentReference, String action, String queryString, String anchor)	Deprecated.
boolean	hasProgrammingRights()
boolean	isAdvancedUser()
boolean	isAdvancedUser(EntityReference userReference)
boolean	isDocumentEditable(String documentReference)	Deprecated.
boolean	isDocumentEditable(DocumentReference documentReference)
boolean	isDocumentViewable(String documentReference)	Deprecated.
boolean	isDocumentViewable(DocumentReference documentReference)
boolean	isPropertyCustomMapped(String className, String property)
void	popDocumentFromContext(Map<String,Object> backupObjects)
void	pushDocumentInContext(Map<String,Object> backupObjects, String documentReference)	Deprecated.
void	pushDocumentInContext(Map<String,Object> backupObjects, DocumentModelBridge document)
void	pushDocumentInContext(Map<String,Object> backupObjects, DocumentReference documentReference)
void	setAttachmentContent(String documentReference, String attachmentFilename, byte[] attachmentData)	Deprecated.
void	setAttachmentContent(AttachmentReference attachmentReference, byte[] attachmentData)
void	setCurrentUser(String userName)
void	setDocumentContent(String documentReference, String content, String editComment, boolean isMinorEdit)	Deprecated.
void	setDocumentContent(DocumentReference documentReference, String content, String editComment, boolean isMinorEdit)
void	setDocumentParentReference(DocumentReference documentReference, DocumentReference parentReference)
void	setDocumentSyntaxId(String documentReference, String syntaxId)	Deprecated.
void	setDocumentSyntaxId(DocumentReference documentReference, String syntaxId)
void	setDocumentTitle(DocumentReference documentReference, String title)
void	setProperty(String documentReference, String className, String propertyName, Object propertyValue)	Deprecated.
void	setProperty(DocumentReference documentReference, DocumentReference classReference, String propertyName, Object propertyValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDocumentAccessBridge

public DefaultDocumentAccessBridge()

Method Detail

getDocumentReference

public DocumentReference getDocumentReference(EntityReference entityReference)

Specified by:

getDocumentReference in interface DocumentAccessBridge

getDocument

@Deprecated
public DocumentModelBridge getDocument(String documentReference)
                                throws Exception

Deprecated.

Specified by:

getDocument in interface DocumentAccessBridge

Throws:

Exception

getDocument

@Deprecated
public DocumentModelBridge getDocument(DocumentReference documentReference)
                                throws Exception

Deprecated.

Specified by:

getDocument in interface DocumentAccessBridge

Throws:

Exception

getDocumentInstance

public DocumentModelBridge getDocumentInstance(DocumentReference documentReference)
                                        throws Exception

Specified by:

getDocumentInstance in interface DocumentAccessBridge

Throws:

Exception

getDocumentInstance

public DocumentModelBridge getDocumentInstance(EntityReference reference)
                                        throws Exception

Specified by:

getDocumentInstance in interface DocumentAccessBridge

Throws:

Exception

getTranslatedDocumentInstance

public DocumentModelBridge getTranslatedDocumentInstance(DocumentReference documentReference)
                                                  throws Exception

Specified by:

getTranslatedDocumentInstance in interface DocumentAccessBridge

Throws:

Exception

getTranslatedDocumentInstance

public DocumentModelBridge getTranslatedDocumentInstance(EntityReference entityReference)
                                                  throws Exception

Specified by:

getTranslatedDocumentInstance in interface DocumentAccessBridge

Throws:

Exception

getTranslatedDocumentInstance

public DocumentModelBridge getTranslatedDocumentInstance(DocumentModelBridge document)
                                                  throws Exception

Specified by:

getTranslatedDocumentInstance in interface DocumentAccessBridge

Throws:

Exception

getCurrentDocumentReference

public DocumentReference getCurrentDocumentReference()

Specified by:

getCurrentDocumentReference in interface DocumentAccessBridge

getDocumentContent

@Deprecated
public String getDocumentContent(String documentReference)
                          throws Exception

Deprecated.

Specified by:

getDocumentContent in interface DocumentAccessBridge

Throws:

Exception

getDocumentContentForDefaultLanguage

public String getDocumentContentForDefaultLanguage(DocumentReference documentReference)
                                            throws Exception

Specified by:

getDocumentContentForDefaultLanguage in interface DocumentAccessBridge

Throws:

Exception

getDocumentContentForDefaultLanguage

@Deprecated
public String getDocumentContentForDefaultLanguage(String documentReference)
                                            throws Exception

Deprecated.

Specified by:

getDocumentContentForDefaultLanguage in interface DocumentAccessBridge

Throws:

Exception

getDocumentContent

public String getDocumentContent(DocumentReference documentReference,
                                 String language)
                          throws Exception

Specified by:

getDocumentContent in interface DocumentAccessBridge

Throws:

Exception

getDocumentContent

@Deprecated
public String getDocumentContent(String documentReference,
                                 String language)
                          throws Exception

Deprecated.

Specified by:

getDocumentContent in interface DocumentAccessBridge

Throws:

Exception

exists

public boolean exists(DocumentReference documentReference)
               throws XWikiException

Specified by:

exists in interface DocumentAccessBridge

Throws:

XWikiException

exists

@Deprecated
public boolean exists(String documentReference)
               throws XWikiException

Deprecated.

Specified by:

exists in interface DocumentAccessBridge

Throws:

XWikiException

setDocumentContent

public void setDocumentContent(DocumentReference documentReference,
                               String content,
                               String editComment,
                               boolean isMinorEdit)
                        throws Exception

Specified by:

setDocumentContent in interface DocumentAccessBridge

Throws:

Exception

setDocumentContent

@Deprecated
public void setDocumentContent(String documentReference,
                               String content,
                               String editComment,
                               boolean isMinorEdit)
                        throws Exception

Deprecated.

Specified by:

setDocumentContent in interface DocumentAccessBridge

Throws:

Exception

getDocumentSyntaxId

@Deprecated
public String getDocumentSyntaxId(String documentReference)
                           throws Exception

Deprecated.

Specified by:

getDocumentSyntaxId in interface DocumentAccessBridge

Throws:

Exception

setDocumentSyntaxId

public void setDocumentSyntaxId(DocumentReference documentReference,
                                String syntaxId)
                         throws Exception

Specified by:

setDocumentSyntaxId in interface DocumentAccessBridge

Throws:

Exception

setDocumentSyntaxId

@Deprecated
public void setDocumentSyntaxId(String documentReference,
                                String syntaxId)
                         throws Exception

Deprecated.

Specified by:

setDocumentSyntaxId in interface DocumentAccessBridge

Throws:

Exception

setDocumentParentReference

public void setDocumentParentReference(DocumentReference documentReference,
                                       DocumentReference parentReference)
                                throws Exception

Specified by:

setDocumentParentReference in interface DocumentAccessBridge

Throws:

Exception

setDocumentTitle

public void setDocumentTitle(DocumentReference documentReference,
                             String title)
                      throws Exception

Specified by:

setDocumentTitle in interface DocumentAccessBridge

Throws:

Exception

getObjectNumber

public int getObjectNumber(DocumentReference documentReference,
                           DocumentReference classReference,
                           String propertyName,
                           String valueToMatch)

Specified by:

getObjectNumber in interface DocumentAccessBridge

getProperty

public Object getProperty(ObjectPropertyReference objectPropertyReference)

Specified by:

getProperty in interface DocumentAccessBridge

getProperty

public Object getProperty(ObjectReference objectReference,
                          String propertyName)

Specified by:

getProperty in interface DocumentAccessBridge

getProperty

public Object getProperty(String documentReference,
                          String className,
                          int objectNumber,
                          String propertyName)

Specified by:

getProperty in interface DocumentAccessBridge

getProperty

@Deprecated
public Object getProperty(String documentReference,
                          String className,
                          String propertyName)

Deprecated.

Specified by:

getProperty in interface DocumentAccessBridge

getProperty

public Object getProperty(DocumentReference documentReference,
                          DocumentReference classReference,
                          String propertyName)

Specified by:

getProperty in interface DocumentAccessBridge

getProperty

public Object getProperty(DocumentReference documentReference,
                          DocumentReference classReference,
                          int objectNumber,
                          String propertyName)

Specified by:

getProperty in interface DocumentAccessBridge

getProperty

public Object getProperty(String documentReference,
                          String propertyName)

Specified by:

getProperty in interface DocumentAccessBridge

getProperties

public List<Object> getProperties(String documentReference,
                                  String className)

Specified by:

getProperties in interface DocumentAccessBridge

getPropertyType

public String getPropertyType(String className,
                              String propertyName)
                       throws Exception

Specified by:

getPropertyType in interface DocumentAccessBridge

Throws:

Exception

isPropertyCustomMapped

public boolean isPropertyCustomMapped(String className,
                                      String property)
                               throws Exception

Specified by:

isPropertyCustomMapped in interface DocumentAccessBridge

Throws:

Exception

setProperty

@Deprecated
public void setProperty(String documentReference,
                        String className,
                        String propertyName,
                        Object propertyValue)
                 throws Exception

Deprecated.

Specified by:

setProperty in interface DocumentAccessBridge

Throws:

Exception

setProperty

public void setProperty(DocumentReference documentReference,
                        DocumentReference classReference,
                        String propertyName,
                        Object propertyValue)
                 throws Exception

Specified by:

setProperty in interface DocumentAccessBridge

Throws:

Exception

getAttachmentContent

@Deprecated
public byte[] getAttachmentContent(String documentReference,
                                   String attachmentFilename)
                            throws Exception

Deprecated.

Specified by:

getAttachmentContent in interface DocumentAccessBridge

Throws:

Exception

getAttachmentContent

@Deprecated(since="14.7RC1")
public InputStream getAttachmentContent(AttachmentReference attachmentReference)
                                 throws Exception

Deprecated.

Specified by:

getAttachmentContent in interface DocumentAccessBridge

Throws:

Exception

getAttachmentContent

public InputStream getAttachmentContent(EntityReference reference)
                                 throws Exception

Specified by:

getAttachmentContent in interface DocumentAccessBridge

Throws:

Exception

setAttachmentContent

public void setAttachmentContent(AttachmentReference attachmentReference,
                                 byte[] attachmentData)
                          throws Exception

Specified by:

setAttachmentContent in interface DocumentAccessBridge

Throws:

Exception

setAttachmentContent

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

Deprecated.

Specified by:

setAttachmentContent in interface DocumentAccessBridge

Throws:

Exception

getAttachmentReferences

public List<AttachmentReference> getAttachmentReferences(DocumentReference documentReference)
                                                  throws Exception

Specified by:

getAttachmentReferences in interface DocumentAccessBridge

Throws:

Exception

getAttachmentVersion

public String getAttachmentVersion(AttachmentReference attachmentReference)
                            throws Exception

Specified by:

getAttachmentVersion in interface DocumentAccessBridge

Throws:

Exception

getDocumentURL

public String getDocumentURL(DocumentReference documentReference,
                             String action,
                             String queryString,
                             String anchor)

Specified by:

getDocumentURL in interface DocumentAccessBridge

getDocumentURL

public String getDocumentURL(DocumentReference documentReference,
                             String action,
                             String queryString,
                             String anchor,
                             boolean isFullURL)

Specified by:

getDocumentURL in interface DocumentAccessBridge

getDocumentURL

public String getDocumentURL(EntityReference entityReference,
                             String action,
                             String queryString,
                             String anchor)

Specified by:

getDocumentURL in interface DocumentAccessBridge

getDocumentURL

public String getDocumentURL(EntityReference entityReference,
                             String action,
                             String queryString,
                             String anchor,
                             boolean isFullURL)

Specified by:

getDocumentURL in interface DocumentAccessBridge

getURL

@Deprecated
public String getURL(String documentReference,
                     String action,
                     String queryString,
                     String anchor)

Deprecated.

Specified by:

getURL in interface DocumentAccessBridge

getAttachmentURL

@Deprecated
public String getAttachmentURL(String documentReference,
                               String attachmentName)

Deprecated.

Specified by:

getAttachmentURL in interface DocumentAccessBridge

getAttachmentURL

public String getAttachmentURL(AttachmentReference attachmentReference,
                               boolean isFullURL)

Specified by:

getAttachmentURL in interface DocumentAccessBridge

getAttachmentURL

public String getAttachmentURL(AttachmentReference attachmentReference,
                               String queryString,
                               boolean isFullURL)

Specified by:

getAttachmentURL in interface DocumentAccessBridge

getAttachmentURLs

@Deprecated
public List<String> getAttachmentURLs(DocumentReference documentReference,
                                      boolean isFullURL)
                               throws Exception

Deprecated.

Specified by:

getAttachmentURLs in interface DocumentAccessBridge

Throws:

Exception

isDocumentViewable

public boolean isDocumentViewable(DocumentReference documentReference)

Specified by:

isDocumentViewable in interface DocumentAccessBridge

isDocumentViewable

@Deprecated
public boolean isDocumentViewable(String documentReference)

Deprecated.

Specified by:

isDocumentViewable in interface DocumentAccessBridge

isDocumentEditable

@Deprecated
public boolean isDocumentEditable(String documentReference)

Deprecated.

Specified by:

isDocumentEditable in interface DocumentAccessBridge

isDocumentEditable

public boolean isDocumentEditable(DocumentReference documentReference)

Specified by:

isDocumentEditable in interface DocumentAccessBridge

hasProgrammingRights

public boolean hasProgrammingRights()

Specified by:

hasProgrammingRights in interface DocumentAccessBridge

getCurrentUser

@Deprecated
public String getCurrentUser()

Deprecated.

Specified by:

getCurrentUser in interface DocumentAccessBridge

getCurrentUserReference

public DocumentReference getCurrentUserReference()

Specified by:

getCurrentUserReference in interface DocumentAccessBridge

isAdvancedUser

public boolean isAdvancedUser()

Specified by:

isAdvancedUser in interface DocumentAccessBridge

isAdvancedUser

public boolean isAdvancedUser(EntityReference userReference)

Specified by:

isAdvancedUser in interface DocumentAccessBridge

setCurrentUser

public void setCurrentUser(String userName)

Specified by:

setCurrentUser in interface DocumentAccessBridge

getDefaultEncoding

public String getDefaultEncoding()

Specified by:

getDefaultEncoding in interface DocumentAccessBridge

popDocumentFromContext

public void popDocumentFromContext(Map<String,Object> backupObjects)

Specified by:

popDocumentFromContext in interface DocumentAccessBridge

pushDocumentInContext

@Deprecated
public void pushDocumentInContext(Map<String,Object> backupObjects,
                                  String documentReference)
                           throws Exception

Deprecated.

Specified by:

pushDocumentInContext in interface DocumentAccessBridge

Throws:

Exception

pushDocumentInContext

public void pushDocumentInContext(Map<String,Object> backupObjects,
                                  DocumentReference documentReference)
                           throws Exception

Specified by:

pushDocumentInContext in interface DocumentAccessBridge

Throws:

Exception

pushDocumentInContext

public void pushDocumentInContext(Map<String,Object> backupObjects,
                                  DocumentModelBridge document)
                           throws Exception

Specified by:

pushDocumentInContext in interface DocumentAccessBridge

Throws:

Exception

getCurrentWiki

public String getCurrentWiki()

Specified by:

getCurrentWiki in interface DocumentAccessBridge

getCurrentAuthorReference

public DocumentReference getCurrentAuthorReference()

Specified by:

getCurrentAuthorReference in interface DocumentAccessBridge