org.kuali.ole.docstore.document.jcr

Class JcrAbstractDocumentManager

java.lang.Object

org.kuali.ole.docstore.document.AbstractDocumentManager

org.kuali.ole.docstore.document.jcr.JcrAbstractDocumentManager

All Implemented Interfaces:

DocumentManager

Direct Known Subclasses:

JcrWorkBibDocumentManager, JcrWorkInstanceDocumentManager, JcrWorkLicenseDocumentManager

public abstract class JcrAbstractDocumentManager
extends AbstractDocumentManager

Provides the common and basic implementation for the DocumentManager interface.

Version:

%I%, %G% Date: 28/8/12 Time: 12:22 PM

Author:

tirumalesh.b

Field Summary

Fields

Modifier and Type	Field and Description
static DocCategory	docCategory
static DocFormat	docFormat
static DocType	docType
protected NodeManager	nodeManager
protected RepositoryManager	repositoryManager

Constructor Summary

Constructors

Constructor and Description
JcrAbstractDocumentManager()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addNewRecordsToDocStore(RequestDocument requestDocument, javax.jcr.Session session)
List<String>	batchIngest(BulkProcessRequest bulkProcessRequest, List<RequestDocument> requestDocuments, javax.jcr.Session session)
ResponseDocument	bind(RequestDocument requestDocument, Object object, String operation)
protected void	buildLinkedResponseDocuments(RequestDocument requestDocument, ResponseDocument responseDocument)
ResponseDocument	buildResponseDocument(RequestDocument requestDocument)
void	buildResponseDocument(RequestDocument requestDocument, javax.jcr.Session session, ResponseDocument responseDocument)
List<ResponseDocument>	buildResponseDocuments(List<RequestDocument> requestDocuments)
void	bulkIngest(BulkProcessRequest bulkProcessRequest, List<RequestDocument> requestDocuments) Performs bulk ingest as per the details in the given bulkProcessRequest.
List<ResponseDocument>	checkin(List<RequestDocument> requestDocuments, Object object)
ResponseDocument	checkin(RequestDocument requestDocument, Object object, ResponseDocument respDoc)
boolean	checkInstanceForBoundsWith(String instanceIdentifier, RequestDocument requestDocument, javax.jcr.Session session, ResponseDocument responseDocument)
boolean	checkInstancesOrItemsExistsInOLE(List<String> uuidsList)
boolean	checkInstancesOrItemsExistsInOLE(String instanceIdentifier, javax.jcr.Session session)
boolean	checkItemsExists()
List<ResponseDocument>	checkout(List<RequestDocument> requestDocuments, Object object)
ResponseDocument	checkout(RequestDocument requestDocument, Object object)
protected String	checkOutContent(javax.jcr.Node nodeByUUID, String format, String user)
protected byte[]	convertContentToBytes(RequestDocument reqDoc)
List<ResponseDocument>	delete(List<RequestDocument> requestDocuments, Object object)
protected void	delete(List<RequestDocument> requestDocuments, javax.jcr.Session session)
ResponseDocument	delete(RequestDocument requestDocument, Object object)
protected void	deleteFromRepository(List<String> uuidsList, javax.jcr.Session session)
void	deleteIndex(List<RequestDocument> requestDocuments)
javax.jcr.version.VersionManager	getVersionManager(javax.jcr.Session session)
void	index(List<RequestDocument> requestDocuments, boolean commit) Indexes the given documents in discovery.
List<ResponseDocument>	ingest(List<RequestDocument> requestDocuments, Object object) Ingests (stores and indexes) the given documents.
ResponseDocument	ingest(RequestDocument requestDocument, Object object, ResponseDocument respDoc) Ingests (stores and indexes) the given document.
boolean	isVersioningEnabled()
protected void	modifyAdditionalAttributes(RequestDocument requestDocument, javax.jcr.Node node)
protected void	modifyContent(RequestDocument reqDoc, javax.jcr.Session session, javax.jcr.Node node)
protected void	modifyDocumentContent(RequestDocument requestDocument, String nodeIdentifier, String parentNodeIdentifier)
RequestDocument	prepareRequestDocument(ResponseDocument responseDocument)
protected void	setResponseParameters(ResponseDocument responseDocument, RequestDocument docStoreDocument)
void	store(List<RequestDocument> requestDocuments, javax.jcr.Session session)
void	store(RequestDocument requestDocument, javax.jcr.Session session)
javax.jcr.Node	storeDocument(RequestDocument requestDocument, Object object, ResponseDocument responseDocument) Deletes the given documents, along with linked documents, from the discovery.
protected void	storeLinkedDocuments(RequestDocument requestDocument, javax.jcr.Node node, javax.jcr.Session session, ResponseDocument responseDocument)
ResponseDocument	unbind(RequestDocument requestDocument, Object object, String operation)
protected void	updateContentToNode(RequestDocument reqDoc, javax.jcr.Session session, byte[] documentBytes, javax.jcr.Node nodeByUUID)
String	updateDocstore(RequestDocument reqDoc, javax.jcr.Session session)
protected String	updateIndex(RequestDocument requestDocument)
protected String	updateRecord(RequestDocument requestDocument)
protected String	updateVersion(javax.jcr.Session session, javax.jcr.Node nodeByUUID)

Methods inherited from class org.kuali.ole.docstore.document.AbstractDocumentManager

addResourceId, getDate, getTimeStampFromString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.ole.docstore.document.DocumentManager

deleteVerify, deleteVerify, validateInput

Field Detail

docCategory

public static DocCategory docCategory

docType

public static DocType docType

docFormat

public static DocFormat docFormat

repositoryManager

protected RepositoryManager repositoryManager

nodeManager

protected NodeManager nodeManager

Constructor Detail

JcrAbstractDocumentManager

public JcrAbstractDocumentManager()

Method Detail

ingest

public List<ResponseDocument> ingest(List<RequestDocument> requestDocuments,
                            Object object)
                              throws OleDocStoreException

Description copied from interface: DocumentManager

Ingests (stores and indexes) the given documents. Either all documents are saved or none.

Returns:

list of ResponseDocuments, if all RequestDocuments are ingested successfully.

Throws:

OleDocStoreException

ingest

public ResponseDocument ingest(RequestDocument requestDocument,
                      Object object,
                      ResponseDocument respDoc)
                        throws OleDocStoreException

Description copied from interface: DocumentManager

Ingests (stores and indexes) the given document.

Returns:

Throws:

OleDocStoreException

checkout

public List<ResponseDocument> checkout(List<RequestDocument> requestDocuments,
                              Object object)
                                throws OleDocStoreException

Throws:

OleDocStoreException

checkout

public ResponseDocument checkout(RequestDocument requestDocument,
                        Object object)
                          throws OleDocStoreException

Throws:

OleDocStoreException

checkOutContent

protected String checkOutContent(javax.jcr.Node nodeByUUID,
                     String format,
                     String user)
                          throws javax.jcr.RepositoryException,
                                 OleDocStoreException,
                                 FileNotFoundException

Throws:

javax.jcr.RepositoryException

OleDocStoreException

FileNotFoundException

checkin

public List<ResponseDocument> checkin(List<RequestDocument> requestDocuments,
                             Object object)
                               throws OleDocStoreException

Throws:

OleDocStoreException

checkin

public ResponseDocument checkin(RequestDocument requestDocument,
                       Object object,
                       ResponseDocument respDoc)
                         throws OleDocStoreException

Throws:

OleDocStoreException

addNewRecordsToDocStore

protected void addNewRecordsToDocStore(RequestDocument requestDocument,
                           javax.jcr.Session session)
                                throws OleDocStoreException

Throws:

OleDocStoreException

updateDocstore

public String updateDocstore(RequestDocument reqDoc,
                    javax.jcr.Session session)
                      throws OleDocStoreException,
                             javax.jcr.RepositoryException,
                             FileNotFoundException

Throws:

OleDocStoreException

javax.jcr.RepositoryException

FileNotFoundException

modifyContent

protected void modifyContent(RequestDocument reqDoc,
                 javax.jcr.Session session,
                 javax.jcr.Node node)
                      throws javax.jcr.RepositoryException,
                             FileNotFoundException,
                             OleDocStoreException

Throws:

javax.jcr.RepositoryException

FileNotFoundException

OleDocStoreException

updateVersion

protected String updateVersion(javax.jcr.Session session,
                   javax.jcr.Node nodeByUUID)
                        throws javax.jcr.RepositoryException,
                               OleDocStoreException

Throws:

javax.jcr.RepositoryException

OleDocStoreException

updateContentToNode

protected void updateContentToNode(RequestDocument reqDoc,
                       javax.jcr.Session session,
                       byte[] documentBytes,
                       javax.jcr.Node nodeByUUID)
                            throws javax.jcr.RepositoryException,
                                   OleDocStoreException

Throws:

javax.jcr.RepositoryException

OleDocStoreException

convertContentToBytes

protected byte[] convertContentToBytes(RequestDocument reqDoc)
                                throws OleDocStoreException

Throws:

OleDocStoreException

updateIndex

protected String updateIndex(RequestDocument requestDocument)
                      throws OleDocStoreException

Throws:

OleDocStoreException

updateRecord

protected String updateRecord(RequestDocument requestDocument)

delete

public List<ResponseDocument> delete(List<RequestDocument> requestDocuments,
                            Object object)
                              throws OleDocStoreException

Throws:

OleDocStoreException

delete

public ResponseDocument delete(RequestDocument requestDocument,
                      Object object)
                        throws Exception

Throws:

Exception

bulkIngest

public void bulkIngest(BulkProcessRequest bulkProcessRequest,
              List<RequestDocument> requestDocuments)
                throws OleDocStoreException

Description copied from interface: DocumentManager

Performs bulk ingest as per the details in the given bulkProcessRequest.

requestDocuments - documents to be processed in the current invocation.

Throws:

OleDocStoreException

deleteFromRepository

protected void deleteFromRepository(List<String> uuidsList,
                        javax.jcr.Session session)
                             throws Exception

Throws:

Exception

batchIngest

public List<String> batchIngest(BulkProcessRequest bulkProcessRequest,
                       List<RequestDocument> requestDocuments,
                       javax.jcr.Session session)

store

public void store(List<RequestDocument> requestDocuments,
         javax.jcr.Session session)
           throws OleDocStoreException

Throws:

OleDocStoreException

index

public void index(List<RequestDocument> requestDocuments,
         boolean commit)
           throws OleDocStoreException

Description copied from interface: DocumentManager

Indexes the given documents in discovery.

commit - indicates whether to commit the changes.

Throws:

OleDocStoreException

delete

protected void delete(List<RequestDocument> requestDocuments,
          javax.jcr.Session session)

deleteIndex

public void deleteIndex(List<RequestDocument> requestDocuments)
                 throws OleDocStoreException

Throws:

OleDocStoreException

store

public void store(RequestDocument requestDocument,
         javax.jcr.Session session)
           throws OleDocStoreException

Throws:

OleDocStoreException

storeDocument

public javax.jcr.Node storeDocument(RequestDocument requestDocument,
                           Object object,
                           ResponseDocument responseDocument)
                             throws OleDocStoreException

Description copied from interface: DocumentManager

Deletes the given documents, along with linked documents, from the discovery.

Throws:

OleDocStoreException

storeLinkedDocuments

protected void storeLinkedDocuments(RequestDocument requestDocument,
                        javax.jcr.Node node,
                        javax.jcr.Session session,
                        ResponseDocument responseDocument)
                             throws OleDocStoreException

Throws:

OleDocStoreException

buildResponseDocuments

public List<ResponseDocument> buildResponseDocuments(List<RequestDocument> requestDocuments)

buildResponseDocument

public ResponseDocument buildResponseDocument(RequestDocument requestDocument)

buildResponseDocument

public void buildResponseDocument(RequestDocument requestDocument,
                         javax.jcr.Session session,
                         ResponseDocument responseDocument)

buildLinkedResponseDocuments

protected void buildLinkedResponseDocuments(RequestDocument requestDocument,
                                ResponseDocument responseDocument)

setResponseParameters

protected void setResponseParameters(ResponseDocument responseDocument,
                         RequestDocument docStoreDocument)

modifyAdditionalAttributes

protected void modifyAdditionalAttributes(RequestDocument requestDocument,
                              javax.jcr.Node node)

bind

public ResponseDocument bind(RequestDocument requestDocument,
                    Object object,
                    String operation)
                      throws OleDocStoreException,
                             javax.jcr.RepositoryException,
                             OleException,
                             FileNotFoundException

Throws:

OleDocStoreException

javax.jcr.RepositoryException

OleException

FileNotFoundException

unbind

public ResponseDocument unbind(RequestDocument requestDocument,
                      Object object,
                      String operation)
                        throws OleDocStoreException,
                               javax.jcr.RepositoryException,
                               OleException,
                               FileNotFoundException

Throws:

OleDocStoreException

javax.jcr.RepositoryException

OleException

FileNotFoundException

modifyDocumentContent

protected void modifyDocumentContent(RequestDocument requestDocument,
                         String nodeIdentifier,
                         String parentNodeIdentifier)

isVersioningEnabled

public boolean isVersioningEnabled()

getVersionManager

public javax.jcr.version.VersionManager getVersionManager(javax.jcr.Session session)
                                                   throws OleDocStoreException,
                                                          javax.jcr.RepositoryException

Throws:

OleDocStoreException

javax.jcr.RepositoryException

checkItemsExists

public boolean checkItemsExists()
                         throws Exception

Throws:

Exception

checkInstancesOrItemsExistsInOLE

public boolean checkInstancesOrItemsExistsInOLE(List<String> uuidsList)

checkInstancesOrItemsExistsInOLE

public boolean checkInstancesOrItemsExistsInOLE(String instanceIdentifier,
                                       javax.jcr.Session session)
                                         throws Exception

Throws:

Exception

checkInstanceForBoundsWith

public boolean checkInstanceForBoundsWith(String instanceIdentifier,
                                 RequestDocument requestDocument,
                                 javax.jcr.Session session,
                                 ResponseDocument responseDocument)
                                   throws Exception

Throws:

Exception

prepareRequestDocument

public RequestDocument prepareRequestDocument(ResponseDocument responseDocument)