org.kuali.ole.describe.service

Class DocstoreHelperService

java.lang.Object

org.kuali.ole.describe.service.DocstoreHelperService

public class DocstoreHelperService
extends Object

DocstoreHelperService is the service class to access Docstore services

Constructor Summary

Constructors

Constructor and Description
DocstoreHelperService()

Method Summary

Methods

Modifier and Type	Method and Description
RequestDocument	buildRequestDocument(String bibXML, String uuid)
String	buildRequestIdsForDelete(List bibIdsList)
String	buildReuestDocXMLForIngest(String bibXML, String instanceXML)
String	buildReuestDocXMLForUpdate(String itemXML, String itemUUID)
boolean	checkItemStatus(List<String> uuids, List<String> fieldValueList)
boolean	checkItemStatusForInstances(List<String> instanceIds, List<String> fieldValueList)
ResponseDocument	checkOutDocument(String docCategory, String docType, String docFormat, String uuid)
String	createItemForInstanceRecord(String instanceUuid, String docType, String xmlContent) Method to add NEW ITEM for existing Instance record
String	createItemForInstanceRecord(String instanceUuid, String docType, String xmlContent, AdditionalAttributes additionalAttributes)
String	deleteDocstoreRecord(String uuid) This method used to delete a docstore record based on uuid
String	deleteInstanceRecord(Instance instance) This method used to delete a instance record
String	deleteItemrecord(String uuid)
BibliographicRecord	getBibliographicRecord(String bibUUID)
String	getContentFromDocStore(String uuid)
DocstoreClientLocator	getDocstoreClientLocator()
String	getDocstoreData(String uuid)
String	getDocstoreData(String docCategory, String docType, String docFormat, String uuid)
DocumentConfig	getDocumentConfigObj()
HoldingOlemlRecordProcessor	getHoldingOlemlRecordProcessor()
List<WorkBibDocument>	getInfoForBibTree(List<WorkBibDocument> bibDocumentList)
WorkBibDocument	getInfoForBibTree(WorkBibDocument workBibDocument)
InstanceCollection	getInstanceCollection(String instanceUUID)
void	getInstanceLocation(OLEInstanceSearch instanceSearch)
InstanceOlemlRecordProcessor	getInstanceOlemlRecordProcessor()
String	getInstanceXML(BibliographicRecord bibliographicRecord)
String	getInstanceXML(LineItemOrder lineItemOrder, BibliographicRecord bibliographicRecord)
Item	getItemPojo(String itemXml) Converts item xml to item pojo.
String	getItemXML(String itemUUID) Retrieves item xml using itemuuid.
OleHoldings	getOleHolding(BibliographicRecord bibliographicRecord)
OleHoldings	getOleHoldings(String instanceUUID) Retrieves Holding Object for given instance UUID.
List<OLEInstanceSearch>	getOleInstanceSearchList(Map<String,String> searchCriteria)
Item	getOleItem(BibliographicRecord bibliographicRecord)
Item	getOleItem(LineItemOrder lineItemOrder, BibliographicRecord bibliographicRecord)
List<OleItemSearch>	getOleItemSearchList(Map<String,String> searchCriteria)
Item	getPO(String itemXml)
String	getResponseContent(Response response)
String	instanceRecordCallToDocstore(String content, String uuid, String format) Method to generate Request XML and ingest Instance record to docstore
boolean	isItemAvailableInDocStore(OleDeliverRequestBo oleDeliverRequestBo) Thsi method is to check whether the item is available in doc store or not
Response	performRestFulOperation(String docCategory, String docType, String docFormat, String ids)
String	persistNewToDocstoreForIngest(BibliographicRecord bibliographicRecord, Item item, OleHoldings oleHoldings)
String	persistNewToDocstoreForIngest(BibliographicRecord bibliographicRecord, List<ProfileAttributeBo> profileAttributes)
String	persistNewToDocstoreForIngest(LineItemOrder lineItemOrder, BibliographicRecord bibliographicRecord, List<ProfileAttributeBo> profileAttributes)
String	persistToDocstoreForEditor(String content, String uuid, String format)
String	persistToDocstoreFromUnifiedEditor(String reqContent, String uuid, String format)
String	persistToDocstoreWithAdditionalAttributesForEditor(String content, AdditionalAttributes additionalAttributes, String uuid, String format)
static String	postData(String target, String content)
void	rollbackData(String xmlForRollback)
void	transferInstances(String requestXML)
String	transferItems(String requestXML)
String	updateInstanceRecord(String uuid, String docType, String xmlContent) Method to update Holding or Item record of an Instance record
String	updateInstanceRecord(String uuid, String docType, String xmlContent, AdditionalAttributes additionalAttributes)
String	updateInstanceToDocstore(InstanceCollection instanceCollection)
String	updateItem(BibliographicRecord bibliographicRecord, String itemUUID)
String	updateOleHoldingToDocstore(OleHoldings oleHoldings)
String	updateOleItemToDocstore(Item item)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocstoreHelperService

public DocstoreHelperService()

Method Detail

getDocstoreClientLocator

public DocstoreClientLocator getDocstoreClientLocator()

getInstanceOlemlRecordProcessor

public InstanceOlemlRecordProcessor getInstanceOlemlRecordProcessor()

getHoldingOlemlRecordProcessor

public HoldingOlemlRecordProcessor getHoldingOlemlRecordProcessor()

persistToDocstoreForEditor

public String persistToDocstoreForEditor(String content,
                                String uuid,
                                String format)
                                  throws Exception

Throws:

Exception

persistToDocstoreFromUnifiedEditor

public String persistToDocstoreFromUnifiedEditor(String reqContent,
                                        String uuid,
                                        String format)
                                          throws Exception

Throws:

Exception

persistToDocstoreWithAdditionalAttributesForEditor

public String persistToDocstoreWithAdditionalAttributesForEditor(String content,
                                                        AdditionalAttributes additionalAttributes,
                                                        String uuid,
                                                        String format)
                                                          throws Exception

Throws:

Exception

persistNewToDocstoreForIngest

public String persistNewToDocstoreForIngest(BibliographicRecord bibliographicRecord,
                                   List<ProfileAttributeBo> profileAttributes)
                                     throws Exception

Throws:

Exception

persistNewToDocstoreForIngest

public String persistNewToDocstoreForIngest(LineItemOrder lineItemOrder,
                                   BibliographicRecord bibliographicRecord,
                                   List<ProfileAttributeBo> profileAttributes)
                                     throws Exception

Throws:

Exception

getDocstoreData

public String getDocstoreData(String uuid)
                       throws Exception

Throws:

Exception

getDocstoreData

public String getDocstoreData(String docCategory,
                     String docType,
                     String docFormat,
                     String uuid)
                       throws Exception

Throws:

Exception

checkOutDocument

public ResponseDocument checkOutDocument(String docCategory,
                                String docType,
                                String docFormat,
                                String uuid)
                                  throws Exception

Throws:

Exception

getResponseContent

public String getResponseContent(Response response)

postData

public static String postData(String target,
              String content)
                       throws Exception

Throws:

Exception

buildReuestDocXMLForIngest

public String buildReuestDocXMLForIngest(String bibXML,
                                String instanceXML)

getInstanceXML

public String getInstanceXML(BibliographicRecord bibliographicRecord)

getInstanceXML

public String getInstanceXML(LineItemOrder lineItemOrder,
                    BibliographicRecord bibliographicRecord)

getOleHolding

public OleHoldings getOleHolding(BibliographicRecord bibliographicRecord)

getOleItem

public Item getOleItem(BibliographicRecord bibliographicRecord)

getOleItem

public Item getOleItem(LineItemOrder lineItemOrder,
              BibliographicRecord bibliographicRecord)

rollbackData

public void rollbackData(String xmlForRollback)
                  throws Exception

Throws:

Exception

updateItem

public String updateItem(BibliographicRecord bibliographicRecord,
                String itemUUID)

buildReuestDocXMLForUpdate

public String buildReuestDocXMLForUpdate(String itemXML,
                                String itemUUID)

instanceRecordCallToDocstore

public String instanceRecordCallToDocstore(String content,
                                  String uuid,
                                  String format)
                                    throws Exception

Method to generate Request XML and ingest Instance record to docstore

Parameters:

content -

uuid -

format -

Returns:

Docstore response for Ingesting New Instance Record

Throws:

Exception

updateInstanceRecord

public String updateInstanceRecord(String uuid,
                          String docType,
                          String xmlContent)
                            throws Exception

Method to update Holding or Item record of an Instance record

Parameters:

uuid -

docType -

xmlContent -

Returns:

Docstore XML response with success/failure status

Throws:

Exception

updateInstanceRecord

public String updateInstanceRecord(String uuid,
                          String docType,
                          String xmlContent,
                          AdditionalAttributes additionalAttributes)
                            throws Exception

Throws:

Exception

deleteInstanceRecord

public String deleteInstanceRecord(Instance instance)
                            throws Exception

This method used to delete a instance record

Parameters:

instance -

Returns:

Throws:

Exception

deleteDocstoreRecord

public String deleteDocstoreRecord(String uuid)
                            throws Exception

This method used to delete a docstore record based on uuid

Parameters:

uuid -

Returns:

Throws:

Exception

createItemForInstanceRecord

public String createItemForInstanceRecord(String instanceUuid,
                                 String docType,
                                 String xmlContent)
                                   throws Exception

Method to add NEW ITEM for existing Instance record

Parameters:

instanceUuid -

docType -

xmlContent -

Returns:

Docstore XML response with success/failure status

Throws:

Exception

createItemForInstanceRecord

public String createItemForInstanceRecord(String instanceUuid,
                                 String docType,
                                 String xmlContent,
                                 AdditionalAttributes additionalAttributes)
                                   throws Exception

Throws:

Exception

transferInstances

public void transferInstances(String requestXML)
                       throws Exception

Throws:

Exception

transferItems

public String transferItems(String requestXML)
                     throws Exception

Throws:

Exception

deleteItemrecord

public String deleteItemrecord(String uuid)
                        throws Exception

Throws:

Exception

getInfoForBibTree

public WorkBibDocument getInfoForBibTree(WorkBibDocument workBibDocument)

getInfoForBibTree

public List<WorkBibDocument> getInfoForBibTree(List<WorkBibDocument> bibDocumentList)

getBibliographicRecord

public BibliographicRecord getBibliographicRecord(String bibUUID)
                                           throws Exception

Throws:

Exception

getInstanceCollection

public InstanceCollection getInstanceCollection(String instanceUUID)
                                         throws Exception

Throws:

Exception

updateInstanceToDocstore

public String updateInstanceToDocstore(InstanceCollection instanceCollection)
                                throws Exception

Throws:

Exception

updateOleHoldingToDocstore

public String updateOleHoldingToDocstore(OleHoldings oleHoldings)
                                  throws Exception

Throws:

Exception

updateOleItemToDocstore

public String updateOleItemToDocstore(Item item)
                               throws Exception

Throws:

Exception

persistNewToDocstoreForIngest

public String persistNewToDocstoreForIngest(BibliographicRecord bibliographicRecord,
                                   Item item,
                                   OleHoldings oleHoldings)

getItemPojo

public Item getItemPojo(String itemXml)
                 throws Exception

Converts item xml to item pojo.

Parameters:

itemXml -

Returns:

Throws:

Exception

getItemXML

public String getItemXML(String itemUUID)
                  throws Exception

Retrieves item xml using itemuuid.

Parameters:

itemUUID -

Returns:

Throws:

Exception

getOleHoldings

public OleHoldings getOleHoldings(String instanceUUID)
                           throws Exception

Retrieves Holding Object for given instance UUID.

Parameters:

instanceUUID -

Returns:

Throws:

Exception

isItemAvailableInDocStore

public boolean isItemAvailableInDocStore(OleDeliverRequestBo oleDeliverRequestBo)

Thsi method is to check whether the item is available in doc store or not

Parameters:

oleDeliverRequestBo -

Returns:

boolean

getOleItemSearchList

public List<OleItemSearch> getOleItemSearchList(Map<String,String> searchCriteria)

getDocumentConfigObj

public DocumentConfig getDocumentConfigObj()

checkItemStatus

public boolean checkItemStatus(List<String> uuids,
                      List<String> fieldValueList)
                        throws org.apache.solr.client.solrj.SolrServerException

Parameters:

uuids -

fieldValueList -

Returns:

Throws:

org.apache.solr.client.solrj.SolrServerException

checkItemStatusForInstances

public boolean checkItemStatusForInstances(List<String> instanceIds,
                                  List<String> fieldValueList)
                                    throws org.apache.solr.client.solrj.SolrServerException

Parameters:

instanceIds -

fieldValueList -

Returns:

Throws:

org.apache.solr.client.solrj.SolrServerException

getOleInstanceSearchList

public List<OLEInstanceSearch> getOleInstanceSearchList(Map<String,String> searchCriteria)

getInstanceLocation

public void getInstanceLocation(OLEInstanceSearch instanceSearch)

getContentFromDocStore

public String getContentFromDocStore(String uuid)
                              throws IOException

Throws:

IOException

buildRequestIdsForDelete

public String buildRequestIdsForDelete(List bibIdsList)

performRestFulOperation

public Response performRestFulOperation(String docCategory,
                               String docType,
                               String docFormat,
                               String ids)
                                 throws Exception

Throws:

Exception

buildRequestDocument

public RequestDocument buildRequestDocument(String bibXML,
                                   String uuid)

getPO

public Item getPO(String itemXml)
           throws Exception

Throws:

Exception