au.com.redboxresearchdata.fascinator.storage.mongo

Class MongoStorage

java.lang.Object

au.com.redboxresearchdata.fascinator.storage.mongo.MongoStorage

All Implemented Interfaces:

com.googlecode.fascinator.api.Plugin, com.googlecode.fascinator.api.storage.JsonStorage, com.googlecode.fascinator.api.storage.Storage

public class MongoStorage
extends java.lang.Object
implements com.googlecode.fascinator.api.storage.JsonStorage

This plugin provides MongoDB storage.

Configuration

Option	Description	Required	Default
url	Base URL of a Fedora Commons server	Yes	http://localhost:8080/fedora
username	Fedora user account with read/write access	Yes (depending on server setup)	fedoraAdmin
password	Password for the above user account	Yes (depending on server setup)	fedoraAdmin
namespace	Namespace to use for Fedora Object PIDs	No	uuid

Sample configuration

 {
     "storage": {

     }
 }
 

Author:

Shilo Banihit

Constructor Summary

Constructors

Constructor and Description
MongoStorage()

Method Summary

Methods

Modifier and Type	Method and Description
com.mongodb.client.AggregateIterable<org.bson.Document>	aggregate(java.lang.String collection, java.util.List<org.bson.BsonDocument> pipeline) Calls Mongo's aggregate function
com.googlecode.fascinator.api.storage.DigitalObject	createObject(java.lang.String oid)
com.googlecode.fascinator.api.storage.JsonDigitalObject	createObject(java.lang.String oid, java.lang.String collectionName)
void	dropDb()
java.lang.String	getId()
java.lang.String	getName()
com.googlecode.fascinator.api.storage.DigitalObject	getObject(java.lang.String oid)
com.googlecode.fascinator.api.storage.JsonDigitalObject	getObject(java.lang.String oid, java.lang.String collectionName)
java.util.Set<java.lang.String>	getObjectIdList()
com.googlecode.fascinator.api.PluginDescription	getPluginDetails()
void	init(java.io.File jsonFile)
void	init(java.lang.String jsonString)
com.googlecode.fascinator.common.JsonSimple	pagedQuery(java.lang.String collection, java.lang.String filterString)
com.googlecode.fascinator.common.JsonSimple	pagedQuery(java.lang.String collection, java.lang.String filterString, int startIndex, int rows, java.lang.String sort)
com.mongodb.client.FindIterable<org.bson.Document>	query(java.lang.String collection, java.lang.String filterString)
void	removeObject(java.lang.String oid)
void	removeObject(java.lang.String oid, java.lang.String collectionName)
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoStorage

public MongoStorage()

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface com.googlecode.fascinator.api.Plugin

getName

public java.lang.String getName()

Specified by:

getName in interface com.googlecode.fascinator.api.Plugin

getPluginDetails

public com.googlecode.fascinator.api.PluginDescription getPluginDetails()

Specified by:

getPluginDetails in interface com.googlecode.fascinator.api.Plugin

init

public void init(java.io.File jsonFile)
          throws com.googlecode.fascinator.api.PluginException

Specified by:

init in interface com.googlecode.fascinator.api.Plugin

Throws:

com.googlecode.fascinator.api.PluginException

init

public void init(java.lang.String jsonString)
          throws com.googlecode.fascinator.api.PluginException

Specified by:

init in interface com.googlecode.fascinator.api.Plugin

Throws:

com.googlecode.fascinator.api.PluginException

shutdown

public void shutdown()
              throws com.googlecode.fascinator.api.PluginException

Specified by:

shutdown in interface com.googlecode.fascinator.api.Plugin

Throws:

com.googlecode.fascinator.api.PluginException

createObject

public com.googlecode.fascinator.api.storage.DigitalObject createObject(java.lang.String oid)
                                                                 throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

createObject in interface com.googlecode.fascinator.api.storage.Storage

Throws:

com.googlecode.fascinator.api.storage.StorageException

createObject

public com.googlecode.fascinator.api.storage.JsonDigitalObject createObject(java.lang.String oid,
                                                                   java.lang.String collectionName)
                                                                     throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

createObject in interface com.googlecode.fascinator.api.storage.JsonStorage

Throws:

com.googlecode.fascinator.api.storage.StorageException

getObject

public com.googlecode.fascinator.api.storage.DigitalObject getObject(java.lang.String oid)
                                                              throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

getObject in interface com.googlecode.fascinator.api.storage.Storage

Throws:

com.googlecode.fascinator.api.storage.StorageException

getObject

public com.googlecode.fascinator.api.storage.JsonDigitalObject getObject(java.lang.String oid,
                                                                java.lang.String collectionName)
                                                                  throws com.googlecode.fascinator.api.storage.StorageException

Throws:

com.googlecode.fascinator.api.storage.StorageException

removeObject

public void removeObject(java.lang.String oid)
                  throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

removeObject in interface com.googlecode.fascinator.api.storage.Storage

Throws:

com.googlecode.fascinator.api.storage.StorageException

removeObject

public void removeObject(java.lang.String oid,
                java.lang.String collectionName)
                  throws com.googlecode.fascinator.api.storage.StorageException

Throws:

com.googlecode.fascinator.api.storage.StorageException

getObjectIdList

public java.util.Set<java.lang.String> getObjectIdList()

Specified by:

getObjectIdList in interface com.googlecode.fascinator.api.storage.Storage

dropDb

public void dropDb()
            throws java.lang.Exception

Throws:

java.lang.Exception

pagedQuery

public com.googlecode.fascinator.common.JsonSimple pagedQuery(java.lang.String collection,
                                                     java.lang.String filterString)
                                                       throws java.io.IOException

Throws:

java.io.IOException

pagedQuery

public com.googlecode.fascinator.common.JsonSimple pagedQuery(java.lang.String collection,
                                                     java.lang.String filterString,
                                                     int startIndex,
                                                     int rows,
                                                     java.lang.String sort)
                                                       throws java.io.IOException

Throws:

java.io.IOException

query

public com.mongodb.client.FindIterable<org.bson.Document> query(java.lang.String collection,
                                                       java.lang.String filterString)

aggregate

public com.mongodb.client.AggregateIterable<org.bson.Document> aggregate(java.lang.String collection,
                                                                java.util.List<org.bson.BsonDocument> pipeline)

Calls Mongo's aggregate function

Parameters:

collection -

pipeline -

Returns: