BaseScanParser

Instance Constructors

new BaseScanParser(sys: ActorSystem, mat: Materializer, config: Configuration)

Abstract Value Members

abstract def scan[A](save: ToSaveSink[A], remove: (A) ⇒ Unit)(implicit ec: ExecutionContext): ClamParser[A]

Scans a file for virus and persists it with the save function.
Scans a file for virus and persists it with the save function. By default, any infected files will be immediately removed using the remove function.

Definition Classes
ClammyScan
abstract def scanOnly(implicit ec: ExecutionContext): ClamParser[Unit]

Scans the file for virus without persisting.
Scans the file for virus without persisting.

Definition Classes
ClammyScan
abstract def scanWithTmpFile(implicit e: ExecutionContext): ClamParser[TemporaryFile]

Scans file for virus and writes to a temporary file.
Scans file for virus and writes to a temporary file.

Definition Classes
ClammyScan

Concrete 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def broadcastGraph[A](c: ClamSink, s: SaveSink[A])(implicit e: ExecutionContext): Sink[ByteString, Future[ScannedBody[A]]]

Graph that broadcasts each chunk from the incoming stream to both sinks, before materializing the result from both into a ScannedBody.
Graph that broadcasts each chunk from the incoming stream to both sinks, before materializing the result from both into a ScannedBody.

Attributes
protected
val cbpLogger: Logger

Attributes
protected
Definition Classes
ClammyScan
val clamConfig: ClamConfig

Definition Classes
BaseScanParser → ClammyScan
def clammySink(filename: String)(implicit ec: ExecutionContext): ClamSink

Specifically sets up a ClamSink that is ready to receive the incoming stream.
Specifically sets up a ClamSink that is ready to receive the incoming stream. Or one that is cancelled with success status.
Controlled by the config property clammyscan.scanDisabled.

Attributes
protected
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def fileNameValid(filename: String): Boolean

Will validate the filename based on the configured regular expression defined in application.conf.
Will validate the filename based on the configured regular expression defined in application.conf.

Attributes
protected
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def handleError[A](fud: MultipartFormData[ScannedBody[A]], err: ClamError)(remove: ⇒ Unit)(implicit ec: ExecutionContext): Future[Either[Result, ClamMultipart[A]]]

Function specifically for handling the ClamError cases in the validation step.
Function specifically for handling the ClamError cases in the validation step. The logic here is highly dependent on how the parser is configured.

Attributes
protected
def hashCode(): Int

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

Definition Classes
Any
implicit val materializer: Materializer

Definition Classes
BaseScanParser → ClammyScan
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def sinks[A](filename: String, contentType: Option[String])(save: ToSaveSink[A])(implicit ec: ExecutionContext): (ClamSink, SaveSink[A])

Determines the two sinks that are to be used for processing the stream.
Determines the two sinks that are to be used for processing the stream. The function will try to validate the filename against the clammyscan.validFilenameRegex property if configured. In the case of an invalid filename, two cancelled sinks are returned.

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

Definition Classes
AnyRef
implicit val system: ActorSystem

Definition Classes
BaseScanParser → ClammyScan
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( ... )

Related Doc: package clammyscan

abstract class BaseScanParser extends ClammyScan

Instance Constructors

new BaseScanParser(sys: ActorSystem, mat: Materializer, config: Configuration)

Abstract Value Members

abstract def scan[A](save: ToSaveSink[A], remove: (A) ⇒ Unit)(implicit ec: ExecutionContext): ClamParser[A]

abstract def scanOnly(implicit ec: ExecutionContext): ClamParser[Unit]

abstract def scanWithTmpFile(implicit e: ExecutionContext): ClamParser[TemporaryFile]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def broadcastGraph[A](c: ClamSink, s: SaveSink[A])(implicit e: ExecutionContext): Sink[ByteString, Future[ScannedBody[A]]]

val cbpLogger: Logger

val clamConfig: ClamConfig

def clammySink(filename: String)(implicit ec: ExecutionContext): ClamSink

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def fileNameValid(filename: String): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def handleError[A](fud: MultipartFormData[ScannedBody[A]], err: ClamError)(remove: ⇒ Unit)(implicit ec: ExecutionContext): Future[Either[Result, ClamMultipart[A]]]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

implicit val materializer: Materializer

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def sinks[A](filename: String, contentType: Option[String])(save: ToSaveSink[A])(implicit ec: ExecutionContext): (ClamSink, SaveSink[A])

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

implicit val system: ActorSystem

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from ClammyScan

Inherited from AnyRef

Inherited from Any

Ungrouped