IcapScanFile (Waarp All 3.6.2-jre8 API Reference)

java.lang.Object
- org.waarp.icap.IcapScanFile

```
public class IcapScanFile
extends Object
```
IcapScanFile command to ask an ICAP server to scan a file through network ICAP protocol.

Options:
-file path_to_file
-to hostname
[-port port, default 1344]
-service name | -model name
[-previewSize size, default none]
[-blockSize size, default 8192]
[-receiveSize size, default 65536]
[-maxSize size, default MAX_INTEGER]
[-timeout in_ms, default equiv to 10 min]
[-errorMove path | -errorDelete | -sendOnError]
[-ignoreNetworkError]
[-ignoreTooBigFileError]
[-keyPreview key -stringPreview string, default none]
[-key204 key -string204 string, default none]
[-key200 key -string200 string, default none]
[-stringHttp string, default none]
[-logger DEBUG|INFO|WARN|ERROR, default none]

Exit with values:
- 0: Scan OK
- 1: Bad arguments
- 2: ICAP protocol error
- 3: Network error
- 4: Scan KO
- 5: Scan KO but post action required in error

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ERROR_SEND_ARG`
`static String`	`FILE_ARG`
`static String`	`MODEL_ARG`
`static String`	`SEPARATOR_SEND`
`static String`	`SERVICE_ARG`
`static int`	`STATUS_BAD_ARGUMENT`
`static int`	`STATUS_ICAP_ISSUE`
`static int`	`STATUS_KO_SCAN`
`static int`	`STATUS_KO_SCAN_POST_ACTION_ERROR`
`static int`	`STATUS_NETWORK_ISSUE`
`static int`	`STATUS_OK`
`static String`	`TO_ARG`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`finalizeOnError(IcapScanFile icapScanFile)` Finalize the current ICAP scan when an error occurs
`String`	`getFilePath()`
`static IcapClient`	`getIcapClient(IcapScanFile icapScanFile)` Create the IcapClient according to IcapScanFile
`IcapModel`	`getIcapModel()`
`static IcapScanFile`	`getIcapScanFileArgs(String[] args)` If file argument are -file EICARTEST, then a EICAR test file will be sent.
`WaarpLogLevel`	`getLogLevel()`
`String`	`getPathMoveError()`
`Map<String,String>`	`getResult()`
`String`	`getServerIP()`
`boolean`	`isDeleteOnError()`
`boolean`	`isIgnoreNetworkError()`
`boolean`	`isIgnoreTooBigFileError()`
`boolean`	`isSendOnError()`
`static void`	`main(String[] args)` If file argument are -file EICARTEST, then a EICAR test file will be sent.
`static void`	`printHelp()` Print to standard output the help of this command
`int`	`scanFile()` Scan a file through ICAP antivirus server from IcapScanFile
`static int`	`scanFile(String[] args)` If file argument are -file EICARTEST, then a EICAR test file will be sent.
`static int`	`scanFile(String[] model, String[] args)` If file argument are -file EICARTEST, then a EICAR test file will be sent.
`IcapScanFile`	`setFilePath(String filePath)`
`IcapScanFile`	`setServerIP(String serverIP)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STATUS_OK
```
public static final int STATUS_OK
```
    See Also:
    
    Constant Field Values
  - STATUS_BAD_ARGUMENT
```
public static final int STATUS_BAD_ARGUMENT
```
    See Also:
    
    Constant Field Values
  - STATUS_ICAP_ISSUE
```
public static final int STATUS_ICAP_ISSUE
```
    See Also:
    
    Constant Field Values
  - STATUS_NETWORK_ISSUE
```
public static final int STATUS_NETWORK_ISSUE
```
    See Also:
    
    Constant Field Values
  - STATUS_KO_SCAN
```
public static final int STATUS_KO_SCAN
```
    See Also:
    
    Constant Field Values
  - STATUS_KO_SCAN_POST_ACTION_ERROR
```
public static final int STATUS_KO_SCAN_POST_ACTION_ERROR
```
    See Also:
    
    Constant Field Values
  - FILE_ARG
```
public static final String FILE_ARG
```
    See Also:
    
    Constant Field Values
  - TO_ARG
```
public static final String TO_ARG
```
    See Also:
    
    Constant Field Values
  - SERVICE_ARG
```
public static final String SERVICE_ARG
```
    See Also:
    
    Constant Field Values
  - MODEL_ARG
```
public static final String MODEL_ARG
```
    See Also:
    
    Constant Field Values
  - ERROR_SEND_ARG
```
public static final String ERROR_SEND_ARG
```
    See Also:
    
    Constant Field Values
  - SEPARATOR_SEND
```
public static final String SEPARATOR_SEND
```
    See Also:
    
    Constant Field Values
- Method Detail
  - printHelp
```
public static void printHelp()
```
    Print to standard output the help of this command
  - getIcapScanFileArgs
```
public static IcapScanFile getIcapScanFileArgs(String[] args)
                                        throws IcapException
```
    If file argument are -file EICARTEST, then a EICAR test file will be sent.
    
    "-file path_to_file
    -to hostname
    [-port port, default 1344]
    -service name | -model name
    [-previewSize size, default none]
    [-blockSize size, default 8192]
    [-receiveSize size, default 65536]
    [-maxSize size, default MAX_INTEGER]
    [-timeout in_ms, default equiv to 10 min]
    [-errorMove path | -errorDelete | -sendOnError]
    [-ignoreNetworkError]
    [-ignoreTooBigFileError]
    [-keyPreview key -stringPreview string, default none]
    [-key204 key -string204 string, default none]
    [-key200 key -string200 string, default none]
    [-stringHttp string, default none]
    [-logger DEBUG|INFO|WARN|ERROR, default none]"
    
    Parameters:
    
    args - must be already replaced values (getReplacedValue)
    
    Returns:
    
    the IcapScanFile
    
    Throws:
    
    IcapException - if an error occurs during argument parsing
  - getIcapClient
```
public static IcapClient getIcapClient(IcapScanFile icapScanFile)
```
    Create the IcapClient according to IcapScanFile
    
    Parameters:
    
    icapScanFile - used to setup IcapClient
    
    Returns:
    
    the IcapClient
  - finalizeOnError
```
public static void finalizeOnError(IcapScanFile icapScanFile)
                            throws IOException
```
    Finalize the current ICAP scan when an error occurs
    
    Parameters:
    
    icapScanFile - used to get options for Error tasks
    
    Throws:
    
    IOException - if an error occurs during post error tasks
  - getFilePath
```
public final String getFilePath()
```
    Returns:
    
    the file path
  - setFilePath
```
public final IcapScanFile setFilePath(String filePath)
```
    Parameters:
    
    filePath - the file path to use
    
    Returns:
    
    This
  - getServerIP
```
public final String getServerIP()
```
    Returns:
    
    the server IP
  - setServerIP
```
public final IcapScanFile setServerIP(String serverIP)
```
    Parameters:
    
    serverIP - the server IP to use
    
    Returns:
    
    This
  - getIcapModel
```
public final IcapModel getIcapModel()
```
    Returns:
    
    the Icap Model if any (null if none)
  - getPathMoveError
```
public final String getPathMoveError()
```
    Returns:
    
    the path to move in error or null
  - isDeleteOnError
```
public final boolean isDeleteOnError()
```
    Returns:
    
    True if the file will be deleted in error
  - isSendOnError
```
public final boolean isSendOnError()
```
    Returns:
    
    True if the send on error option is set
  - isIgnoreNetworkError
```
public final boolean isIgnoreNetworkError()
```
    Returns:
    
    True if a network error option is set to ignore such
  - isIgnoreTooBigFileError
```
public final boolean isIgnoreTooBigFileError()
```
    Returns:
    
    True if a too big file error option is set to ignore such
  - getLogLevel
```
public final WaarpLogLevel getLogLevel()
```
    Returns:
    
    the Logger Level desired during ICAP operation or null if none
  - getResult
```
public final Map<String,String> getResult()
```
    Returns:
    
    the Map of key from ICAP if any (null if none)
  - main
```
public static void main(String[] args)
```
    If file argument are -file EICARTEST, then a EICAR test file will be sent.
    
    "-file path_to_file
    -to hostname
    [-port port, default 1344]
    -service name | -model name
    [-previewSize size, default none]
    [-blockSize size, default 8192]
    [-receiveSize size, default 65536]
    [-maxSize size, default MAX_INTEGER]
    [-timeout in_ms, default equiv to 10 min]
    [-errorMove path | -errorDelete | -sendOnError]
    [-ignoreNetworkError]
    [-ignoreTooBigFileError]
    [-keyPreview key -stringPreview string, default none]
    [-key204 key -string204 string, default none]
    [-key200 key -string200 string, default none]
    [-stringHttp string, default none]
    [-logger DEBUG|INFO|WARN|ERROR, default none]"
    
    Exit with values:
    - 0: Scan OK
    - 1: Bad arguments
    - 2: ICAP protocol error
    - 3: Network error
    - 4: Scan KO
    - 5: Scan KO but post action required in error
    Parameters:
    
    args - to get parameters from
  - scanFile
```
public static int scanFile(String[] model,
                           String[] args)
```
    If file argument are -file EICARTEST, then a EICAR test file will be sent.
    
    "-file path_to_file
    -to hostname
    [-port port, default 1344]
    Not -service name | -model name (should be set through Model)
    [-previewSize size, default none]
    [-blockSize size, default 8192]
    [-receiveSize size, default 65536]
    [-maxSize size, default MAX_INTEGER]
    [-timeout in_ms, default equiv to 10 min]
    [-errorMove path | -errorDelete | -sendOnError]
    [-ignoreNetworkError]
    [-ignoreTooBigFileError]
    [-keyPreview key -stringPreview string, default none]
    [-key204 key -string204 string, default none]
    [-key200 key -string200 string, default none]
    [-stringHttp string, default none]
    [-logger DEBUG|INFO|WARN|ERROR, default none]"
    
    Parameters:
    
    model - default model to apply in addition to parameters
    
    args - to get parameters from
    
    Returns:
    
    0 if OK, 1 if arguments are incorrect, 2 if an issue occurs during ICAP protool, 3 if a nework error occurs, 4 if scan KO, 5 if the post actions are in error while scan is KO
  - scanFile
```
public static int scanFile(String[] args)
```
    If file argument are -file EICARTEST, then a EICAR test file will be sent.
    
    "-file path_to_file
    -to hostname
    [-port port, default 1344]
    -service name | -model name [-previewSize size, default none]
    [-blockSize size, default 8192]
    [-receiveSize size, default 65536]
    [-maxSize size, default MAX_INTEGER]
    [-timeout in_ms, default equiv to 10 min]
    [-errorMove path | -errorDelete | -sendOnError]
    [-ignoreNetworkError]
    [-ignoreTooBigFileError]
    [-keyPreview key -stringPreview string, default none]
    [-key204 key -string204 string, default none]
    [-key200 key -string200 string, default none]
    [-stringHttp string, default none]
    [-logger DEBUG|INFO|WARN|ERROR, default none]"
    
    Parameters:
    
    args - to get parameters from
    
    Returns:
    
    0 if OK, 1 if arguments are incorrect, 2 if an issue occurs during ICAP protool, 3 if a nework error occurs, 4 if scan KO, 5 if the post actions are in error while scan is KO
  - scanFile
```
public final int scanFile()
                   throws IcapException,
                          IOException
```
    Scan a file through ICAP antivirus server from IcapScanFile
    
    Returns:
    
    0 if scan is OK, 1 if the file is infected
    
    Throws:
    
    IcapException - if an error occurs during connection or ICAP protocol
    
    IOException - if the file is infected and a post error action is in error

Class IcapScanFile

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_OK

STATUS_BAD_ARGUMENT

STATUS_ICAP_ISSUE

STATUS_NETWORK_ISSUE

STATUS_KO_SCAN

STATUS_KO_SCAN_POST_ACTION_ERROR

FILE_ARG

TO_ARG

SERVICE_ARG

MODEL_ARG

ERROR_SEND_ARG

SEPARATOR_SEND

Method Detail

printHelp

getIcapScanFileArgs

getIcapClient

finalizeOnError

getFilePath

setFilePath

getServerIP

setServerIP

getIcapModel

getPathMoveError

isDeleteOnError

isSendOnError

isIgnoreNetworkError

isIgnoreTooBigFileError

getLogLevel

getResult

main

scanFile

scanFile

scanFile