IcapClient (Waarp All 3.6.2-jre8 API Reference)

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

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class IcapClient
extends Object
implements Closeable
```
The IcapClient allows to do 3 actions:
- connect(): which allows to initialize the connection with the ICAP server
- close(): forces the client to disconnect from the ICAP server
- scanFile(path): send a file for a scan by the ICAP server
This code is inspired from 2 sources:
- https://github.com/Baekalfen/ICAP-avscan
- https://github.com/claudineyns/icap-client
This reflects the RFC 3507 and errata as of 2010/04/17.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_ICAP_PORT` Default ICAP port
`static String`	`EICARTEST`
`static String`	`HTTP_TERMINATOR`
`static String`	`ICAP_TERMINATOR`
`static String`	`TERMINATOR`
`static String`	`VERSION`

Constructor Summary

Constructors
Constructor and Description
`IcapClient(String serverIP, int port, String icapService)` This creates the ICAP client without connecting immediately to the ICAP server.
`IcapClient(String serverIP, int port, String icapService, int previewSize)` This creates the ICAP client without connecting immediately to the ICAP server.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`IcapClient`	`connect()` Try to connect to the server and if the preview size is not specified, it will also resolve the options of the ICAP server.
`Map<String,String>`	`getFinalResult()`
`String`	`getIcapService()`
`String`	`getKeyIcap200()`
`String`	`getKeyIcap204()`
`String`	`getKeyIcapPreview()`
`long`	`getMaxSize()`
`int`	`getPort()`
`int`	`getPreviewSize()`
`int`	`getReceiveLength()`
`int`	`getSendLength()`
`String`	`getServerIP()`
`String`	`getSubStringFromKeyIcap200()`
`String`	`getSubStringFromKeyIcap204()`
`String`	`getSubStringFromKeyIcapPreview()`
`String`	`getSubstringHttpStatus200()`
`long`	`getTimeout()`
`boolean`	`scanFile(String filename)` Given a file path, it will send the file to the server and return true, if the server accepts the file.
`IcapClient`	`setKeyIcap200(String keyIcap200)`
`IcapClient`	`setKeyIcap204(String keyIcap204)`
`IcapClient`	`setKeyIcapPreview(String keyIcapPreview)`
`IcapClient`	`setMaxSize(long maxSize)`
`IcapClient`	`setPreviewSize(int previewSize)`
`IcapClient`	`setReceiveLength(int receiveLength)`
`IcapClient`	`setSendLength(int sendLength)`
`IcapClient`	`setSubStringFromKeyIcap200(String subStringFromKeyIcap200)`
`IcapClient`	`setSubStringFromKeyIcap204(String subStringFromKeyIcap204)`
`IcapClient`	`setSubStringFromKeyIcapPreview(String subStringFromKeyIcapPreview)`
`IcapClient`	`setSubstringHttpStatus200(String substringHttpStatus200)`
`IcapClient`	`setTimeout(int timeout)`

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

- Field Detail
  - DEFAULT_ICAP_PORT
```
public static final int DEFAULT_ICAP_PORT
```
    Default ICAP port
    
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final String VERSION
```
    See Also:
    
    Constant Field Values
  - TERMINATOR
```
public static final String TERMINATOR
```
    See Also:
    
    Constant Field Values
  - ICAP_TERMINATOR
```
public static final String ICAP_TERMINATOR
```
    See Also:
    
    Constant Field Values
  - HTTP_TERMINATOR
```
public static final String HTTP_TERMINATOR
```
    See Also:
    
    Constant Field Values
  - EICARTEST
```
public static final String EICARTEST
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IcapClient
```
public IcapClient(String serverIP,
                  int port,
                  String icapService)
```
    This creates the ICAP client without connecting immediately to the ICAP server. When the ICAP client will connect, it will ask for the preview size to the ICAP Server.
    
    Parameters:
    
    serverIP - The IP address to connect to.
    
    port - The port in the host to use.
    
    icapService - The service to use (fx "avscan").
  - IcapClient
```
public IcapClient(String serverIP,
                  int port,
                  String icapService,
                  int previewSize)
```
    This creates the ICAP client without connecting immediately to the ICAP server. When the ICAP client will connect, it will not ask for the preview size to the ICAP Server but uses the default specified value.
    
    Parameters:
    
    serverIP - The IP address to connect to.
    
    port - The port in the host to use.
    
    icapService - The service to use (fx "avscan").
    
    previewSize - Amount of bytes to send as preview.
- Method Detail
  - connect
```
public final IcapClient connect()
                         throws IcapException
```
    Try to connect to the server and if the preview size is not specified, it will also resolve the options of the ICAP server.
    If the client is still connected, it will first disconnect before reconnecting to the ICAP Server.
    Note that every attempts of connection will retry to issue an OPTIONS request if necessary (if preview size is not set to a fixed value already).
    
    Throws:
    
    IcapException - if an issue occurs during the connection or response (the connection is already closed)
  - close
```
public final void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - scanFile
```
public final boolean scanFile(String filename)
                       throws IcapException
```
    Given a file path, it will send the file to the server and return true, if the server accepts the file. Visa-versa, false if the server rejects it.
    Note that if the client is not connected, it will first call connect().
    
    Parameters:
    
    filename - Relative or absolute file path to a file. If filename is EICARTEST, then a build on the fly EICAR test file is sent.
    
    Returns:
    
    Returns true when no infection is found.
    
    Throws:
    
    IcapException - if an error occurs (network, file reading, bad headers)
  - getServerIP
```
public final String getServerIP()
```
    Returns:
    
    the Server IP
  - getPort
```
public final int getPort()
```
    Returns:
    
    the port
  - getIcapService
```
public final String getIcapService()
```
    Returns:
    
    the ICAP service
  - getPreviewSize
```
public final int getPreviewSize()
```
    Returns:
    
    the current Preview size
  - setPreviewSize
```
public final IcapClient setPreviewSize(int previewSize)
```
    Parameters:
    
    previewSize - the receive length to set
    
    Returns:
    
    This
  - getReceiveLength
```
public final int getReceiveLength()
```
    Returns:
    
    the current Receive length
  - setReceiveLength
```
public final IcapClient setReceiveLength(int receiveLength)
```
    Parameters:
    
    receiveLength - the receive length to set
    
    Returns:
    
    This
  - getSendLength
```
public final int getSendLength()
```
    Returns:
    
    the current Send length
  - setSendLength
```
public final IcapClient setSendLength(int sendLength)
```
    Parameters:
    
    sendLength - the send length to set
    
    Returns:
    
    This
  - getMaxSize
```
public final long getMaxSize()
```
    Returns:
    
    the current max file size (default being Integer.MAX_VALUE)
  - setMaxSize
```
public final IcapClient setMaxSize(long maxSize)
```
    Parameters:
    
    maxSize - the maximum file size to set
    
    Returns:
    
    This
  - getTimeout
```
public final long getTimeout()
```
    Returns:
    
    the current time out for connection
  - setTimeout
```
public final IcapClient setTimeout(int timeout)
```
    Parameters:
    
    timeout - the timeout to use on connection
    
    Returns:
    
    This
  - getKeyIcapPreview
```
public final String getKeyIcapPreview()
```
    Returns:
    
    the current key in ICAP headers to find with 200 status in PREVIEW (or null if none)
  - setKeyIcapPreview
```
public final IcapClient setKeyIcapPreview(String keyIcapPreview)
```
    Parameters:
    
    keyIcapPreview - the key in ICAP headers to find with 200 status in PREVIEW (or null if none)
    
    Returns:
    
    This
  - getSubStringFromKeyIcapPreview
```
public final String getSubStringFromKeyIcapPreview()
```
    Returns:
    
    the current subString to find in key ICAP header with 200 status in PREVIEW (or null if none)
  - setSubStringFromKeyIcapPreview
```
public final IcapClient setSubStringFromKeyIcapPreview(String subStringFromKeyIcapPreview)
```
    Parameters:
    
    subStringFromKeyIcapPreview - the subString to find in key ICAP header with 200 status in PREVIEW (or null if none)
    
    Returns:
    
    This
  - getSubstringHttpStatus200
```
public final String getSubstringHttpStatus200()
```
    Returns:
    
    the current subString to find in Http with 200 status (or null if none)
  - setSubstringHttpStatus200
```
public final IcapClient setSubstringHttpStatus200(String substringHttpStatus200)
```
    Parameters:
    
    substringHttpStatus200 - the subString to find in Http with 200 status (or null if none)
    
    Returns:
    
    This
  - getKeyIcap200
```
public final String getKeyIcap200()
```
    Returns:
    
    the current key in ICAP headers to find with 200 status (or null if none)
  - setKeyIcap200
```
public final IcapClient setKeyIcap200(String keyIcap200)
```
    Parameters:
    
    keyIcap200 - the key in ICAP headers to find with 200 status (or null if none)
    
    Returns:
    
    This
  - getSubStringFromKeyIcap200
```
public final String getSubStringFromKeyIcap200()
```
    Returns:
    
    the current subString to find in key ICAP header with 200 status (or null if none)
  - setSubStringFromKeyIcap200
```
public final IcapClient setSubStringFromKeyIcap200(String subStringFromKeyIcap200)
```
    Parameters:
    
    subStringFromKeyIcap200 - the subString to find in key ICAP header with 200 status (or null if none)
    
    Returns:
    
    This
  - getKeyIcap204
```
public final String getKeyIcap204()
```
    Returns:
    
    the current key in ICAP headers to find with 204 status (or null if none)
  - setKeyIcap204
```
public final IcapClient setKeyIcap204(String keyIcap204)
```
    Parameters:
    
    keyIcap204 - the key in ICAP headers to find with 204 status (or null if none)
    
    Returns:
    
    This
  - getSubStringFromKeyIcap204
```
public final String getSubStringFromKeyIcap204()
```
    Returns:
    
    the current subString to find in key ICAP header with 204 status (or null if none)
  - setSubStringFromKeyIcap204
```
public final IcapClient setSubStringFromKeyIcap204(String subStringFromKeyIcap204)
```
    Parameters:
    
    subStringFromKeyIcap204 - the subString to find in key ICAP header with 204 status (or null if none)
    
    Returns:
    
    This
  - getFinalResult
```
public final Map<String,String> getFinalResult()
```
    Returns:
    
    the current map of result (null if none)

Class IcapClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ICAP_PORT

VERSION

TERMINATOR

ICAP_TERMINATOR

HTTP_TERMINATOR

EICARTEST

Constructor Detail

IcapClient

IcapClient

Method Detail

connect

close

scanFile

getServerIP

getPort

getIcapService

getPreviewSize

setPreviewSize

getReceiveLength

setReceiveLength

getSendLength

setSendLength

getMaxSize

setMaxSize

getTimeout

setTimeout

getKeyIcapPreview

setKeyIcapPreview

getSubStringFromKeyIcapPreview

setSubStringFromKeyIcapPreview

getSubstringHttpStatus200

setSubstringHttpStatus200

getKeyIcap200

setKeyIcap200

getSubStringFromKeyIcap200

setSubStringFromKeyIcap200

getKeyIcap204

setKeyIcap204

getSubStringFromKeyIcap204

setSubStringFromKeyIcap204

getFinalResult