ExtractorRoutingService

Instance Constructors

new ExtractorRoutingService()

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
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def containsOperation(operations: List[String], operation: String): Boolean

Check if given operation matches any existing records cached in ExtractorInfo.
Check if given operation matches any existing records cached in ExtractorInfo. Note, dataset operation is in the format of "x.y", mimetype of files is in the format of "x/y" this functino expects to parse on delimeters: . or / this function will return false in case of wrong format
operations
mimetypes cached in ExtractorInfo, either operations of dataset or mimetypes of files
operation
dataset operation like "file.added" or mimetype of files, like "image/bmp"
returns
true if matches any existing recorder. otherwise, false.
def contentTypeToRoutingKey(contentType: String): String

Escape various characters in content type when creating a routing key
Escape various characters in content type when creating a routing key
contentType
original content type in standar form, for example text/csv
returns
escaped routing key
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
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
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
def fileCreated(file: File, dataset: Option[Dataset], host: String, requestAPIKey: Option[String]): Option[UUID]

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
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
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
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
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 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
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
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def postSubmissionEvent(file_id: UUID, extractor_id: String, user_id: UUID): (UUID, Option[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
def submitDatasetManually(host: String, queue: String, extraInfo: Map[String, Any], datasetId: UUID, newFlags: String, requestAPIKey: Option[String], user: Option[User]): Option[UUID]

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
def submitFileManually(originalId: UUID, file: File, host: String, queue: String, extraInfo: Map[String, Any], datasetId: UUID, newFlags: String, requestAPIKey: Option[String], user: Option[User]): Option[UUID]

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
def submitSectionPreviewManually(preview: Preview, sectionId: UUID, host: String, requestAPIKey: Option[String]): Unit

Preview creted for section.
Preview creted for section.
preview
sectionId
host
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 ExtractorRoutingService extends AnyRef

Instance Constructors

new ExtractorRoutingService()

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

def clone(): AnyRef

def containsOperation(operations: List[String], operation: String): Boolean

def contentTypeToRoutingKey(contentType: String): String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

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]): Option[UUID]

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

final def getClass(): Class[_]

def getEmailNotificationEmailList(requestAPIKey: Option[String]): List[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

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 postSubmissionEvent(file_id: UUID, extractor_id: String, user_id: UUID): (UUID, Option[UUID])

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

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

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

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped