ClammyBodyParsers

Type Members

type ClamResponse = Either[ClamError, FileOk]
type ClammyGridFSBody = (Future[(ClammyBodyParsers.this)#ClamResponse], Future[ReadFile[BSONValue]])

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
def allowDuplicateFiles: Boolean

Indicates whether or not to allow storing duplicate file names...
Indicates whether or not to allow storing duplicate file names... default value is true

Definition Classes
ClammyParserConfig
final def asInstanceOf[T0]: T0

Definition Classes
Any
def canRemoveInfectedFiles: Boolean

Remove file if it is infected...
Remove file if it is infected... defaults value is true

Definition Classes
ClammyParserConfig
def canRemoveOnError: Boolean

Remove file if an error occurred during scanning...
Remove file if an error occurred during scanning... defaults to true, but will be overridden and set to false if shouldFailOnError = false

Definition Classes
ClammyParserConfig
val cbpLogger: Logger
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val disabled: String

Definition Classes
ConfigKeys
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
val failOnErrorKey: String

Definition Classes
ConfigKeys
val filenameRegex: String

Definition Classes
ConfigKeys
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def futureGridFSFile(implicit request: Request[MultipartFormData[(ClammyBodyParsers.this)#ClammyGridFSBody]]): Future[ReadFile[BSONValue]]

Convenience function for retrieving the actual FilePart from the request, after scanning and saving has been completed.
Convenience function for retrieving the actual FilePart from the request, after scanning and saving has been completed.
Since the scan results have been validated as part of the parsing, we can be sure that the it passed through successfully.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val gridfsDuplicateFilesKey: String

Definition Classes
ConfigKeys
def hashCode(): Int

Definition Classes
AnyRef → Any
val hostKey: String

Definition Classes
ConfigKeys
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val portKey: String

Definition Classes
ConfigKeys
val removeInfectedKey: String

Definition Classes
ConfigKeys
val removeOnErrorKey: String

Definition Classes
ConfigKeys
def scanAndParseAsGridFS[S, R[_], W[_], Id <: BSONValue](gfs: GridFS[S, R, W], fileName: Option[String] = None, metaData: Option[BSONDocument], allowDuplicates: Boolean = allowDuplicateFiles)(fileExists: (String) ⇒ Boolean)(implicit readFileReader: R[ReadFile[BSONValue]], sWriter: W[BSONDocument], ec: ExecutionContext): BodyParser[MultipartFormData[(ClammyBodyParsers.this)#ClammyGridFSBody]]

Gets a body parser that will save a file, with specified metadata and filename, sent with multipart/form-data into the given GridFS store.
Gets a body parser that will save a file, with specified metadata and filename, sent with multipart/form-data into the given GridFS store.
First the stream is sent to both the ClamScan Iteratee and the GridFS Iteratee using Enumeratee.zip. Then, when both Iteratees are done and none of them ended up in an Error state, the response is validated to check for the presence of a ClamError. If this is found in the result, the file is removed from GridFS and a JSON Result is returned.
S => Structure R => Reader W => Writer Id => extends BSONValue
def scanAndParseAsTempFile(implicit ec: ExecutionContext): BodyParser[MultipartFormData[(Future[Either[ClamError, FileOk]], TemporaryFile)]]

Scans file for virus and buffers to a temporary file.
Scans file for virus and buffers to a temporary file. Temp file is removed if file is infected.
def scanDisabled: Boolean

Disables all virus scanning...
Disables all virus scanning... defaults to false

Definition Classes
ClammyParserConfig
def scanOnly(implicit ec: ExecutionContext): BodyParser[MultipartFormData[Future[(ClammyBodyParsers.this)#ClamResponse]]]

Mostly for convenience this.
Mostly for convenience this. If you need a service for just scanning a file for infections, this is it.
def shouldFailOnError: Boolean

Whether or not to cause the body parser to stop uploading if we cannot connect to clamd...
Whether or not to cause the body parser to stop uploading if we cannot connect to clamd... defaults to false

Definition Classes
ClammyParserConfig
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timeoutKey: String

Definition Classes
ConfigKeys
def toString(): String

Definition Classes
AnyRef → Any
def validFilenameRegex: Option[String]

Allows defining a regular expression to validate filenames for illegal characters.
Allows defining a regular expression to validate filenames for illegal characters. A good one could e.g. be: (.[\"\*\\\>\<\?\/\:\|].)|(.[\.]?.[\.]$)|(.*[ ]+$)

Definition Classes
ClammyParserConfig
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( ... )

trait ClammyBodyParsers extends ClammyParserConfig

Type Members

type ClamResponse = Either[ClamError, FileOk]

type ClammyGridFSBody = (Future[(ClammyBodyParsers.this)#ClamResponse], Future[ReadFile[BSONValue]])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def allowDuplicateFiles: Boolean

final def asInstanceOf[T0]: T0

def canRemoveInfectedFiles: Boolean

def canRemoveOnError: Boolean

val cbpLogger: Logger

def clone(): AnyRef

val disabled: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val failOnErrorKey: String

val filenameRegex: String

def finalize(): Unit

def futureGridFSFile(implicit request: Request[MultipartFormData[(ClammyBodyParsers.this)#ClammyGridFSBody]]): Future[ReadFile[BSONValue]]

final def getClass(): Class[_]

val gridfsDuplicateFilesKey: String

def hashCode(): Int

val hostKey: String

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val portKey: String

val removeInfectedKey: String

val removeOnErrorKey: String

def scanAndParseAsTempFile(implicit ec: ExecutionContext): BodyParser[MultipartFormData[(Future[Either[ClamError, FileOk]], TemporaryFile)]]

def scanDisabled: Boolean

def scanOnly(implicit ec: ExecutionContext): BodyParser[MultipartFormData[Future[(ClammyBodyParsers.this)#ClamResponse]]]

def shouldFailOnError: Boolean

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

val timeoutKey: String

def toString(): String

def validFilenameRegex: Option[String]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from ClammyParserConfig

Inherited from ConfigKeys

Inherited from AnyRef

Inherited from Any

Ungrouped