public interface Instance extends VSIConstants
The scan instance is the main interface for an external user of this API. The service "Virus Scan Provider" returns an instance of either:
The layers of this framework are:
--------- 1 | Profile |--| --------- | | | n ------- 1 1 --------- | |--<| Group |-| |--| Server | |--------| ------- | | --------- n | n ---------- 1 | | --<| Provider |-|-+ | ---------- | | | ----+---- |--| Adapter | 1 ----+---- | | ------------+----------------- | S A P NW-VSI compatible VSA | | | | Virus Scan Adapter (VSA) | | External Threat Protection | | from SAP NW-VSI partners | -----------------------------
Remark:
The architecture of the Provider covers either an Adapter or a Server (Virus
Scan Server):
Each running thread must use its own scan instance. The reason for this is the described framework using external (native) shared libraries. There are caching mechanisms in the layer of the Provider, so the time latency of requesting an Instance is very small.
Note:
Please see the example usage of an "Instance" in the JavaDOC of VSIService. A
requested instance must be released with releaseInstance
.
History:
1.0 Initial Version for SAP NetWeaver 1.1 Added a pattern for clean test. 1.5 Enhancements in the native VSI layer 1.6 Dual runtime support (JAVA stand-alone and J2EE) 1.7 Added scanStream methods and support ActiveContent scan 1.8 Added getContentInfo and support for Content filtering 1.9 Minor bug fixes and new vendor parameters
Profile
,
Group
,
Provider
,
VSIService
,
VSIService.getInstance()
TRACE_ERROR, TRACE_INFO, TRACE_JNI, TRACE_MEM_TRACE, TRACE_MEMORY, TRACE_PARAMETERS, TRACE_RFC, TRACE_RFC_TABEL, TRACE_THREAD, TRACE_VIRUS, TRACE_VSA, TRACE_VSA_EVENTS, TRACE_VSI, TRACE_WARNING, VSA_E_ACTIVECONTENT_FOUND, VSI_BLOCK_PARAM_NAMES, VSI_CLEAN_PARAM_NAMES, VSI_CUST_PARAM_NAMES, VSI_E_BAD_EXPRESSION, VSI_E_BLOCKED_BY_POLICY, VSI_E_BUFFER_TOO_SHORT, VSI_E_CBC_TERMINATED, VSI_E_CIO_FAILED, VSI_E_CLEAN_FAILED, VSI_E_CLEAN_OK, VSI_E_CONVERSION_FAILED, VSI_E_DRIVER_FAILED, VSI_E_END_FAILED, VSI_E_EXPIRED, VSI_E_IN_PROGRESS, VSI_E_INVALID_ENUM_INDEX, VSI_E_INVALID_HANDLE, VSI_E_INVALID_PARAM, VSI_E_INVALID_PARAM_TYPE, VSI_E_INVALID_SCANOBJECT, VSI_E_LOAD_FAILED, VSI_E_MACRO_FOUND, VSI_E_NO_SCANINFO, VSI_E_NO_SPACE, VSI_E_NOT_INITIALISED, VSI_E_NOT_SCANNED, VSI_E_NOT_SUPPORTED, VSI_E_NULL_PARAM, VSI_E_OBJPAR_UNSUPPORTED, VSI_E_PARAM_UNSUPPORTED, VSI_E_PATTERN_FOUND, VSI_E_SCAN_FAILED, VSI_E_SCANPAR_UNSUPPORTED, VSI_E_UNKNOWN_ERROR, VSI_E_VIRUS_FOUND, VSI_E_VSA_LOAD_FAILED, VSI_E_XML_CONFIG_FAILED, VSI_INIT_PARAM_NAMES, VSI_OK, VSI_PARAM_TYPES, VSI_SCAN_PARAM_NAMES
Modifier and Type | Method and Description |
---|---|
boolean |
cleanBytes(byte[] byteArray)
Scan and clean an array of bytes.
|
boolean |
cleanBytes(byte[] byteArray,
long len)
Scan and clean the length of an array of bytes.
|
boolean |
cleanBytes(String objectName,
byte[] byteArray,
long len)
Scan and clean the length of an array of bytes.
|
boolean |
cleanBytes(String objectName,
byte[] byteArray,
long len,
long jobID)
Scan and "tries to" clean the infected byte array.
|
boolean |
cleanFile(String fileName)
Scans and "tries to" clean infected files.
|
boolean |
cleanFile(String fileName,
long jobID)
Scans and "tries to" clean infected files.
|
boolean |
cleanStream(String objectName,
VSIFilterInputStream iStream,
long len)
Scan and "tries to" clean the infected input stream.
|
boolean |
cleanStream(String objectName,
VSIFilterInputStream iStream,
long len,
long jobID)
Scan and "tries to" clean the infected input stream.
|
boolean |
cleanStream(VSIFilterInputStream iStream)
Scan and "tries to" clean the infected input stream.
|
boolean |
cleanStream(VSIFilterInputStream iStream,
long len)
Scan and "tries to" clean the infected input stream.
|
long |
getCleanedLength() |
ContentInfo[] |
getContentInfo()
Get the content info list from VSA after a scan
|
Infection[] |
getInfections()
Deprecated.
Do not use
|
long |
getJobID() |
int |
getLastErrorRC()
Return the last occurred error code.
|
Parameter |
getParameter(String paramName)
Get parameter from VSA
|
Parameter[] |
getParameters()
Get all VSA parameters
|
ScanError[] |
getScanErrors()
Deprecated.
Do not use
|
boolean |
scanBytes(byte[] byteArray)
Scan an array of bytes.
|
boolean |
scanBytes(byte[] byteArray,
long len)
Scan the length of an array of bytes.
|
boolean |
scanBytes(String objectName,
byte[] byteArray,
long len)
Scan the length of an array of bytes.
|
boolean |
scanBytes(String objectName,
byte[] byteArray,
long len,
long jobID)
"Scan only" for viruses within a passed byte array.
|
boolean |
scanBytesEx(boolean doClean,
byte[] byteArray)
Extended Version of scanBytes.
|
boolean |
scanBytesEx(boolean doClean,
byte[] byteArray,
long len)
Extended Version of scanBytes.
|
boolean |
scanBytesEx(boolean doClean,
String objectName,
byte[] byteArray,
long len)
Extended Version of scanBytes.
|
boolean |
scanBytesEx(boolean doClean,
String objectName,
byte[] byteArray,
long len,
long jobID)
Extended Version of scanBytes.
|
boolean |
scanFile(String fileName)
"Scans only" for viruses.
|
boolean |
scanFile(String fileName,
long jobID)
"Scans only" for viruses.
|
boolean |
scanFileEx(boolean doClean,
String fileName)
Extended Version of scanFile.
|
boolean |
scanFileEx(boolean doClean,
String fileName,
long jobID)
Extended Version of scanFile.
|
boolean |
scanStream(String objectName,
VSIFilterInputStream istream,
long len)
"Scan only" for viruses within a passed input stream.
|
boolean |
scanStream(String objectName,
VSIFilterInputStream istream,
long len,
long jobID)
"Scan only" for viruses within a passed input stream.
|
boolean |
scanStream(VSIFilterInputStream istream)
"Scan only" for viruses within a passed input stream.
|
boolean |
scanStream(VSIFilterInputStream istream,
long len)
"Scan only" for viruses within a passed input stream.
|
boolean |
scanStreamEx(boolean doClean,
String objectName,
VSIFilterInputStream istream,
long len)
Extended Version of scanStream.
|
boolean |
scanStreamEx(boolean doClean,
String objectName,
VSIFilterInputStream istream,
long len,
long jobID)
Extended Version of scanStream.
|
boolean |
scanStreamEx(boolean doClean,
VSIFilterInputStream istream)
Extended Version of scanStream.
|
boolean |
scanStreamEx(boolean doClean,
VSIFilterInputStream istream,
long len)
Extended Version of scanStream.
|
void |
setActiveContent(boolean bActiveContent)
Deprecated.
this method has no effect
|
boolean |
setDefaultConfig()
Set or reset the default configuration of a VSA.
|
void |
setJobID(long jobID)
Set the JOB identifier.
|
boolean |
setParameter(Parameter vsParameter)
Set a parameter
|
boolean |
setParameters(Parameter[] vsParameters)
Set a parameter
|
void |
setScanInfo(boolean bScanInfo)
Deprecated.
this method has no effect
|
boolean scanFile(String fileName, long jobID) throws VSIServiceException, VirusScanException, VirusInfectionException
fileName
- The name of the file to be scanned.jobID
- A freely select-able job identifier.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanFile(String fileName) throws VSIServiceException, VirusScanException, VirusInfectionException
fileName
- The name of the file to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanBytes(String objectName, byte[] byteArray, long len, long jobID) throws VSIServiceException, VirusScanException, VirusInfectionException
objectName
- Printable name of the object to be scanned.byteArray
- A byte array to be scanned.len
- The maximum length of the array to be scanned.jobID
- A free select-able job identifier.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanBytes(String objectName, byte[] byteArray, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
objectName
- Printable name of the object to be scanned.byteArray
- Byte array.len
- Length of array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanBytes(byte[] byteArray, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
byteArray
- Byte array.len
- Length of array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanBytes(byte[] byteArray) throws VSIServiceException, VirusScanException, VirusInfectionException
byteArray
- Byte array.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanFileEx(boolean doClean, String fileName, long jobID) throws VSIServiceException, VirusScanException, VirusInfectionException
doClean
- True means with clean action, false is equal to scan only.fileName
- The name of the file to be scanned.jobID
- A free select-able job identifier.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanFileEx(boolean doClean, String fileName) throws VSIServiceException, VirusScanException, VirusInfectionException
doClean
- True means with clean action, false is equal to scan only.fileName
- The name of the file to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanBytesEx(boolean doClean, String objectName, byte[] byteArray, long len, long jobID) throws VSIServiceException, VirusScanException, VirusInfectionException
doClean
- True means with clean action, false is equal to scan only.objectName
- Printable name of the object to be scanned.byteArray
- A byte array to be scanned.len
- The maximum length of the array to be scanned.jobID
- A free select-able job identifier.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanBytesEx(boolean doClean, String objectName, byte[] byteArray, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
doClean
- True means with clean action, false is equal to scan only.objectName
- Printable name of the object to be scanned.byteArray
- A byte array to be scanned.len
- The maximum length of the array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occur during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occur during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanBytesEx(boolean doClean, byte[] byteArray, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
doClean
- True means with clean action, false is equal to scan only.byteArray
- A byte array to be scanned.len
- The maximum length of the array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occur during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occur during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanBytesEx(boolean doClean, byte[] byteArray) throws VSIServiceException, VirusScanException, VirusInfectionException
doClean
- True means with clean action, false is equal to scan only.byteArray
- A byte array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean scanStream(String objectName, VSIFilterInputStream istream, long len, long jobID) throws VSIServiceException, VirusScanException, VirusInfectionException
objectName
- Printable name of the stream to be scanned.istream
- Reference to VSIFilterInputStream object which should be
scanned.len
- The maximum length of the array to be scanned.jobID
- A free select-able job identifier.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occur during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occur during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.VSIService.createVSIStream(InputStream)
boolean scanStream(String objectName, VSIFilterInputStream istream, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
objectName
- Printable name of the stream to be scanned.istream
- Reference to VSIFilterInputStream object which should be
scanned.len
- The maximum length of the array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occur during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occur during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.VSIService.createVSIStream(InputStream)
boolean scanStream(VSIFilterInputStream istream, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
istream
- Reference to VSIFilterInputStream object which should be
scanned.len
- The maximum length of the array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occur during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occur during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.VSIService.createVSIStream(InputStream)
boolean scanStream(VSIFilterInputStream istream) throws VSIServiceException, VirusScanException, VirusInfectionException
istream
- Reference to VSIFilterInputStream object which should be
scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occur during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occur during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.VSIService.createVSIStream(InputStream)
boolean scanStreamEx(boolean doClean, VSIFilterInputStream istream) throws VSIServiceException, VirusScanException, VirusInfectionException
The scan takes place in the memory, if the internal buffer is large enough, otherwise an internal temporary file is created. See
If the stream was "infected and repaired", the output stream is then
smaller than before. If you want know the new length, call
getCleanedLength()
doClean
- True means with clean action, false is equal to scan only.istream
- Reference to VSIFilterInputStream object which should be
scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occur during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occur during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.
,
VSIService.createVSIStream(InputStream)
boolean scanStreamEx(boolean doClean, VSIFilterInputStream istream, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
The scan takes place in the memory, if the internal buffer is large enough, otherwise an internal temporary file is created. See
If the stream was "infected and repaired", the output stream is then
smaller than before. If you want know the new length, call
getCleanedLength()
doClean
- True means with clean action, false is equal to scan only.istream
- Reference to VSIFilterInputStream object which should be
scanned.len
- The maximum length of the array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occur during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occur during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.
,
VSIService.createVSIStream(InputStream)
boolean scanStreamEx(boolean doClean, String objectName, VSIFilterInputStream istream, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
The scan takes place in the memory, if the internal buffer is large enough, otherwise an internal temp file is created. See
If the stream was "infected and repaired", the output stream is then
smaller than before. If you want know the new length, call
getCleanedLength()
doClean
- True means with clean action, false is equal to scan only.objectName
- Printable name of the stream to be scanned.istream
- Reference to VSIFilterInputStream object which should be
scanned.len
- The maximum length of the array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occur during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occur during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.
,
VSIService.createVSIStream(InputStream)
boolean scanStreamEx(boolean doClean, String objectName, VSIFilterInputStream istream, long len, long jobID) throws VSIServiceException, VirusScanException, VirusInfectionException
The scan takes place in the memory, if the internal buffer is large enough, otherwise an internal temp file is created. See
If the stream was "infected and repaired", the output stream is then
smaller than before. If you want know the new length, call
getCleanedLength()
doClean
- True means with clean action, false is equal to scan only.objectName
- Printable name of the stream to be scanned.istream
- Reference to VSIFilterInputStream object which should be
scanned.len
- The maximum length of the array to be scanned.jobID
- A free select-able job identifier.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occur during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occur during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.
,
VSIService.createVSIStream(InputStream)
boolean cleanFile(String fileName, long jobID) throws VSIServiceException, VirusScanException, VirusInfectionException
fileName
- The name of the file to be scanned.jobID
- A freely select-able job identifier.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean cleanFile(String fileName) throws VSIServiceException, VirusScanException, VirusInfectionException
fileName
- The name of the file to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean cleanBytes(String objectName, byte[] byteArray, long len, long jobID) throws VSIServiceException, VirusScanException, VirusInfectionException
Note:
If the byte array was "infection and repaired", the array is then smaller
than before. If you want know the new length, call
getCleanedLength()
objectName
- The name of the scan object.byteArray
- A byte array to be scanned.len
- The maximum length of the array to be scanned.jobID
- A freely select-able job identifier.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.getCleanedLength()
boolean cleanBytes(String objectName, byte[] byteArray, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
objectName
- Printable name of the object to be scanned.byteArray
- Byte array.len
- Length of array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean cleanBytes(byte[] byteArray, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
byteArray
- Byte array.len
- Length of array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean cleanBytes(byte[] byteArray) throws VSIServiceException, VirusScanException, VirusInfectionException
byteArray
- Byte array.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.boolean cleanStream(String objectName, VSIFilterInputStream iStream, long len, long jobID) throws VSIServiceException, VirusScanException, VirusInfectionException
Note:
If the stream was "infected and repaired", the output stream is then
smaller than before. If you want know the new length, call
getCleanedLength()
objectName
- The name of the stream (for internal purpose) to be scanned.iStream
- Reference to VSIFilterInputStream object which should be
scanned.len
- The maximum length of the array to be scanned.jobID
- A free select-able job identifier.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.getCleanedLength()
,
VSIService.createVSIStream(InputStream)
boolean cleanStream(String objectName, VSIFilterInputStream iStream, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
Note:
If the stream was "infected and repaired", the output stream is then
smaller than before. If you want know the new length, call
getCleanedLength()
objectName
- The name of the stream (for internal purpose) to be scanned.iStream
- Reference to VSIFilterInputStream object which should be
scanned.len
- The maximum length of the array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.getCleanedLength()
,
VSIService.createVSIStream(InputStream)
boolean cleanStream(VSIFilterInputStream iStream, long len) throws VSIServiceException, VirusScanException, VirusInfectionException
Note:
If the stream was "infected and repaired", the output stream is then
smaller than before. If you want know the new length, call
getCleanedLength()
iStream
- Reference to VSIFilterInputStream object which should be
scanned.len
- The maximum length of the array to be scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.getCleanedLength()
,
VSIService.createVSIStream(InputStream)
boolean cleanStream(VSIFilterInputStream iStream) throws VSIServiceException, VirusScanException, VirusInfectionException
Note:
If the stream was "infected and repaired", the output stream is then
smaller than before. If you want know the new length, call
getCleanedLength()
iStream
- Reference to VSIFilterInputStream object which should be
scanned.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.VirusInfectionException
- Problems reported with this exception occurs during a virus
scan (or clean) action on a found infection. More detailed
information can be retrieved by getInfections
.getCleanedLength()
,
VSIService.createVSIStream(InputStream)
long getCleanedLength() throws VSIServiceException, VirusScanException
VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.long getJobID() throws VSIServiceException
VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.void setJobID(long jobID)
jobID
- the JOB identifierInfection[] getInfections() throws VSIServiceException, VirusScanException
VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.ScanError[] getScanErrors() throws VSIServiceException, VirusScanException
VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.VirusScanException
- Problems reported with this exception occurs during a virus
scan (or clean) action. More detailed information can be
retrieved by getScanErrors
.int getLastErrorRC()
VSIConstans
VSIConstants
void setScanInfo(boolean bScanInfo)
bScanInfo
- Boolean flag to determine whether this detailed information
should be returned. default is truevoid setActiveContent(boolean bActiveContent)
bActiveContent
- Boolean flag for notificationboolean setParameters(Parameter[] vsParameters) throws VSIServiceException
vsParameters
- VSA parameter array, Parameter[] objectVSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.boolean setParameter(Parameter vsParameter) throws VSIServiceException
vsParameter
- VSA parameterVSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.Parameter[] getParameters() throws VSIServiceException
VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.Parameter getParameter(String paramName) throws VSIServiceException
paramName
- Name of the parameter.VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.boolean setDefaultConfig() throws VSIServiceException
VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.ContentInfo[] getContentInfo() throws VSIServiceException
VSIServiceException
- Problems reported with this exception can be communicated to
external systems because they reflect error in the data sent
by the caller.Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] ENGFACADE
|
[sap.com] tc/bl/vsi/api
|
api
|
BC-JAS-SEC
|
[sap.com] J2EE-APPS
|
[sap.com]
|
-
|
BC-SEC-VIR
|
[sap.com] J2EE-APPS
|
[sap.com]
|
default
|
BC-SEC-VIR
|
Copyright 2018 SAP AG Complete Copyright Notice