RabbitmqExtractionBusService

Instance Constructors

new RabbitmqExtractionBusService(files: FileService, spacesService: SpaceService, extractorsService: ExtractorService, datasetService: DatasetService, userService: UserService)

Annotations
@Inject()

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
var bindings: List[Binding]
def cancelPendingSubmission(id: UUID, queueName: String, msg_id: UUID): Unit

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
val cancellationDownloadQueueName: String
var cancellationQueue: Option[ActorRef]
var channel: Option[Channel]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(): Unit

Close connection to broker.
Close connection to broker. *

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def connect(): Boolean

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
var connection: Option[Connection]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
var event_filter: Option[ActorRef]
var exchange: String
var extractQueue: Option[ActorRef]
var extractorsHeartbeats: Option[ActorRef]
var factory: Option[ConnectionFactory]
def fileAddedToDataset(file: File, dataset: Dataset, host: String, requestAPIKey: Option[String]): Unit

Send message when a file is added to a dataset.
Send message when a file is added to a dataset. Use both old method using topic queues and new method using work queues and extractors registration in Clowder.
file
the file that was added to the dataset
dataset
the dataset it was added to
host
the Clowder host URL for sharing extractors across instances

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def fileCreated(file: TempFile, host: String, requestAPIKey: Option[String]): Unit

Send message when a new file is uploaded to the system.
Send message when a new file is uploaded to the system. This is the same as the method above but it supports TempFile instead of File. This is currently only used for multimedia queries.
file
the file that was just uploaded
host
the Clowder host URL for sharing extractors across instances

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def fileCreated(file: File, dataset: Option[Dataset], host: String, requestAPIKey: Option[String]): Unit

Publish to the proper queues when a new file is uploaded to the system.
Publish to the proper queues when a new file is uploaded to the system.
file
the file that was just uploaded
dataset
the dataset the file belongs to
host
the Clowder host URL for sharing extractors across instances

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def fileRemovedFromDataset(file: File, dataset: Dataset, host: String, requestAPIKey: Option[String]): Unit

Send message when file is removed from a dataset and deleted.
Send message when file is removed from a dataset and deleted.
file
dataset
host

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def fileSetAddedToDataset(dataset: Dataset, filelist: List[File], host: String, requestAPIKey: Option[String]): Unit

Send message when a group of files is added to a dataset via UI.
Send message when a group of files is added to a dataset via UI. Use both old method using topic queues and new method using work queues and extractors registration in Clowder.
dataset
the dataset it was added to
filelist
the list of files that were added to the dataset
host
the Clowder host URL for sharing extractors across instances

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getApiKey(requestAPIKey: Option[String], user: Option[User]): String

Return the API key to use in the submission.
Return the API key to use in the submission. If the one in the key is not set in the request then get the default extraction key for the user. If the user is not defined default to the global key. for the user
requestAPIKey
the API key from the request
user
the user from the request
returns
the API key to use
def getBindings: Future[Response]

Get the binding lists (lists of routing keys) from the rabbitmq broker
Get the binding lists (lists of routing keys) from the rabbitmq broker

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def getChannelInfo(cid: String): Future[Response]

Get Channel information from rabbitmq broker for given channel id 'cid'
def getChannelsList: Future[Response]

Get Channel list from rabbitmq broker
Get Channel list from rabbitmq broker

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getEmailNotificationEmailList(requestAPIKey: Option[String]): List[String]

a helper function to get user email address from user's request api key.
a helper function to get user email address from user's request api key.
requestAPIKey
user request apikey
returns
a list of email address
def getExchanges: Future[Response]

Get the exchange list for a given host
Get the exchange list for a given host

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def getQueueBindings(qname: String): Future[Response]

Get queue bindings for a given host and queue from rabbitmq broker
Get queue bindings for a given host and queue from rabbitmq broker

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def getQueueDetails(qname: String): Future[Response]

Get queue details for a given queue
Get queue details for a given queue

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def getQueuesNamesForAnExchange(exchange: String): Future[Response]

get list of queues attached to an exchange
get list of queues attached to an exchange

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def getRestEndPoint(path: String): Future[Response]
var globalAPIKey: String
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def metadataAddedToResource(metadataId: UUID, resourceRef: ResourceRef, extraInfo: Map[String, Any], host: String, requestAPIKey: Option[String], user: Option[User]): Unit

Metadata added to a resource (file or dataset).
Metadata added to a resource (file or dataset).
resourceRef
extraInfo
host

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def metadataRemovedFromResource(metadataId: UUID, resourceRef: ResourceRef, host: String, requestAPIKey: Option[String], user: Option[User]): Unit

Metadata removed from a resource (file or dataset).
Metadata removed from a resource (file or dataset).
resourceRef
host

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
var mgmtPort: String
def multimediaQuery(tempFileId: UUID, contentType: String, length: String, host: String, requestAPIKey: Option[String]): Unit

File upladed for multimedia query.
File upladed for multimedia query. Not a common used feature.
tempFileId
contentType
length
host

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def onStart(): Unit

On start connect to broker.
On start connect to broker.

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def onStop(): Unit

On stop clean up connection.
On stop clean up connection.

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
var password: String
def postSubmissionEvent(file_id: UUID, extractor_id: String): UUID

Post the event of SUBMITTED
Post the event of SUBMITTED
file_id
the UUID of file
extractor_id
the extractor queue name to be submitted
var rabbitmquri: String
var restURL: Option[String]
def resubmitPendingRequests(cancellationQueueConsumer: QueueingConsumer, channel: Channel, cancellationSearchTimeout: Long): Unit

loop through the queue and dispatch the message via the routing key.
loop through the queue and dispatch the message via the routing key.
cancellationQueueConsumer
the queue consumer to download the requests from the cancellation downloaded queue
channel
the channel connecting to the rabbitmq
cancellationSearchTimeout
the timeout of downloading the requests from the rabbitmq

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def submitDatasetManually(host: String, queue: String, extraInfo: Map[String, Any], datasetId: UUID, newFlags: String, requestAPIKey: Option[String], user: Option[User]): Boolean

An existing dataset was manually submitted to the extraction bus by a user.
An existing dataset was manually submitted to the extraction bus by a user.
host
queue
extraInfo
datasetId
newFlags

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def submitFileManually(originalId: UUID, file: File, host: String, queue: String, extraInfo: Map[String, Any], datasetId: UUID, newFlags: String, requestAPIKey: Option[String], user: Option[User]): Boolean

An existing file was manually submitted to the extraction bus by a user.
An existing file was manually submitted to the extraction bus by a user.
originalId
file
host
queue
extraInfo
datasetId
newFlags

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
def submitSectionPreviewManually(preview: Preview, sectionId: UUID, host: String, requestAPIKey: Option[String]): Unit

Preview creted for section.
Preview creted for section.
preview
sectionId
host

Definition Classes
RabbitmqExtractionBusService → ExtractionBusService
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
var username: String
var vhost: String
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

class RabbitmqExtractionBusService extends ExtractionBusService

Instance Constructors

new RabbitmqExtractionBusService(files: FileService, spacesService: SpaceService, extractorsService: ExtractorService, datasetService: DatasetService, userService: UserService)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

var bindings: List[Binding]

def cancelPendingSubmission(id: UUID, queueName: String, msg_id: UUID): Unit

val cancellationDownloadQueueName: String

var cancellationQueue: Option[ActorRef]

var channel: Option[Channel]

def clone(): AnyRef

def close(): Unit

def connect(): Boolean

var connection: Option[Connection]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

var event_filter: Option[ActorRef]

var exchange: String

var extractQueue: Option[ActorRef]

var extractorsHeartbeats: Option[ActorRef]

var factory: Option[ConnectionFactory]

def fileAddedToDataset(file: File, dataset: Dataset, host: String, requestAPIKey: Option[String]): Unit

def fileCreated(file: TempFile, host: String, requestAPIKey: Option[String]): Unit

def fileCreated(file: File, dataset: Option[Dataset], host: String, requestAPIKey: Option[String]): Unit

def fileRemovedFromDataset(file: File, dataset: Dataset, host: String, requestAPIKey: Option[String]): Unit

def fileSetAddedToDataset(dataset: Dataset, filelist: List[File], host: String, requestAPIKey: Option[String]): Unit

def finalize(): Unit

def getApiKey(requestAPIKey: Option[String], user: Option[User]): String

def getBindings: Future[Response]

def getChannelInfo(cid: String): Future[Response]

def getChannelsList: Future[Response]

final def getClass(): Class[_]

def getEmailNotificationEmailList(requestAPIKey: Option[String]): List[String]

def getExchanges: Future[Response]

def getQueueBindings(qname: String): Future[Response]

def getQueueDetails(qname: String): Future[Response]

def getQueuesNamesForAnExchange(exchange: String): Future[Response]

def getRestEndPoint(path: String): Future[Response]

var globalAPIKey: String

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def metadataAddedToResource(metadataId: UUID, resourceRef: ResourceRef, extraInfo: Map[String, Any], host: String, requestAPIKey: Option[String], user: Option[User]): Unit

def metadataRemovedFromResource(metadataId: UUID, resourceRef: ResourceRef, host: String, requestAPIKey: Option[String], user: Option[User]): Unit

var mgmtPort: String

def multimediaQuery(tempFileId: UUID, contentType: String, length: String, host: String, requestAPIKey: Option[String]): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def onStart(): Unit

def onStop(): Unit

var password: String

def postSubmissionEvent(file_id: UUID, extractor_id: String): UUID

var rabbitmquri: String

var restURL: Option[String]

def resubmitPendingRequests(cancellationQueueConsumer: QueueingConsumer, channel: Channel, cancellationSearchTimeout: Long): Unit

def submitDatasetManually(host: String, queue: String, extraInfo: Map[String, Any], datasetId: UUID, newFlags: String, requestAPIKey: Option[String], user: Option[User]): Boolean

def submitFileManually(originalId: UUID, file: File, host: String, queue: String, extraInfo: Map[String, Any], datasetId: UUID, newFlags: String, requestAPIKey: Option[String], user: Option[User]): Boolean

def submitSectionPreviewManually(preview: Preview, sectionId: UUID, host: String, requestAPIKey: Option[String]): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

var username: String

var vhost: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from ExtractionBusService

Inherited from AnyRef

Inherited from Any

Ungrouped