com.sap.security.core.server.vsi.api
Class ScanError

java.lang.Object
  |
  +--com.sap.security.core.server.vsi.api.ScanError

public class ScanError

extends java.lang.Object

Virus scan error object. The ScanError object contains the characteristics about an occured error during a virus scan.

This information is returned by the used virus scan engine (VSA) and depends therefore on the vendor.

History:

     1.0      Initial Version for SAP NetWeaver 04
     1.1      Added a pattern for clean test.
     1.5      Enhancements in the native VSI layer
     1.6      Dual runtime support (JAVA standalone and J2EE)
	

Since:

1.0

Version:

1.6, $DateTime: 2007/03/27 12:26:05 $

See Also:

VirusScanException

Constructor Summary

ScanError(long jobID, long errorRC, java.lang.String errorText, java.lang.String objectName, long objectSize)
Constructor of the class ScanError

Method Summary

long	getErrorRC() Returns the vendor internal (dependend) error code of the occured scan error.
java.lang.String	getErrorText() Returns additional error text to the occured scan error.
java.lang.String	getObjectName() Returns the name of the error object.
long	getObjectSize() Returns the size of the error object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScanError

public ScanError(long jobID,
                 long errorRC,
                 java.lang.String errorText,
                 java.lang.String objectName,
                 long objectSize)

Constructor of the class ScanError

Parameters:

jobID - The pre-defined job identifier.

errorRC - The vendor dependent error code.

errorText - The vendor dependent error text.

objectName - Name of the error object.

objectSize - Size of the error object.

Method Detail

getErrorRC

public long getErrorRC()
                throws VSIServiceException

Returns the vendor internal (dependend) error code of the occured scan error.

Returns:

The vendor dependent error code

Throws:

VSIServiceException - Problems reported with this exception can be communicated to external systems because they reflect error in the data sent by the caller.

getErrorText

public java.lang.String getErrorText()
                              throws VSIServiceException

Returns additional error text to the occured scan error.

Returns:

The vendor dependent error text.

Throws:

VSIServiceException - Problems reported with this exception can be communicated to external systems because they reflect error in the data sent by the caller.

getObjectName

public java.lang.String getObjectName()
                               throws VSIServiceException

Returns the name of the error object.

Returns:

Object name.

Throws:

VSIServiceException - Problems reported with this exception can be communicated to external systems because they reflect error in the data sent by the caller.

getObjectSize

public long getObjectSize()
                   throws VSIServiceException

Returns the size of the error object.

Returns:

Size of the object.

Throws:

VSIServiceException - Problems reported with this exception can be communicated to external systems because they reflect error in the data sent by the caller.