com.sap.security.core.server.vsi.api.exception
Class VSIServiceMessage

com.sap.security.core.server.vsi.api.exception.VSIServiceMessage

public class VSIServiceMessage

Textpool for the VSI service messages.

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/06/27 12:14:12 $

Inner Class Summary

static class	VSIServiceMessage.BaseMsg
static class	VSIServiceMessage.Msg0
static class	VSIServiceMessage.Msg1
static class	VSIServiceMessage.Msg2
static class	VSIServiceMessage.Msg3
static class	VSIServiceMessage.Msg4

Field Summary

static java.lang.String	BUNDLE
static VSIServiceMessage.Msg1	ID0001_GENERIC_EXCEPTION Gerneric Exception:
static VSIServiceMessage.Msg0	ID0100_NO_INSTANCE_AVAILABLE No instance available
static VSIServiceMessage.Msg4	ID0101_CONFIG_REFLECTION_ERROR Reflection error during access to field {1} in class {0} with methods {2} and {3}.
static VSIServiceMessage.Msg3	ID0102_CONFIG_CLASS_INSTANTIATION Exception when creating an instance of class {0} (field {1} in class {2}).
static VSIServiceMessage.Msg2	ID0103_CONFIG_FILE_ERROR During processing of field {0} in class {1} (byte array) a stream exception has occurred.
static VSIServiceMessage.Msg2	ID0104_CONFIG_ACCESS_ERROR Error during access to configuration manager in class {0} in method {1} .
static VSIServiceMessage.Msg2	ID0105_CONFIG_OBJECT_ERROR Object {0} is not allowed to be passed for method {1}.
static VSIServiceMessage.Msg2	ID0106_CONFIG_OBJECT_NULL The object {0} is new and must first be created.
static VSIServiceMessage.Msg2	ID0113_BAD_METHOD_INPUT The provided input {0} for method {1} is not correct.
static VSIServiceMessage.Msg0	ID0114_WRONG_INSTANCE_PASSED Wrong instance object passed.
static VSIServiceMessage.Msg4	ID0115_WRONG_FIELD_TYPE Configuration entry {0} in node {1} has field type {2}, but expected is {3}.
static VSIServiceMessage.Msg1	ID0116_CONFIG_HANDLER_EXC The configuration handler for path {0} has thrown an exception.
static VSIServiceMessage.Msg3	ID0117_CONFIG_UNSUPPORTED_TYPE Configuration class {0} has field {1} with type {2} which is not supported.
static VSIServiceMessage.Msg2	ID0118_CONFIG_PARAM_EMPTY Configuration parameter {0} must have a value (path: {1}).
static VSIServiceMessage.Msg3	ID0119_CONFIG_PARAM_NEGATIVE Configuration parameter {0} must have a non-negative value.
static VSIServiceMessage.Msg4	ID0120_CONFIG_VSA_NAME Configuration parameter {0} has value "{1}" which is no valid valid adapter name: {2} (path: {3}).
static VSIServiceMessage.Msg4	ID0121_CONFIG_VSCAN_NAME Configuration parameter {0} has value "{1}" which is no valid Virus Scan Server name: {2} (path: {3}).
static VSIServiceMessage.Msg2	ID0122_CONFIG_VSCAN_LOCALE Configuration parameter {0} is no valid locale: (path: {1}).
static VSIServiceMessage.Msg0	ID0200_SERVICE_STARTING \"Virus Scan Provider\" service starting.
static VSIServiceMessage.Msg0	ID0201_SERVICE_STARTED \"Virus Scan Provider\" service started.
static VSIServiceMessage.Msg0	ID0202_SERVICE_STOPPING \"Virus Scan Provider\" service stopping.
static VSIServiceMessage.Msg0	ID0203_SERVICE_STOPPED \"Virus Scan Provider\" service stopped.
static VSIServiceMessage.Msg0	ID0204_START_EXCEPTION The \"Virus Scan Provider\" service could not be started because an exception occurred.
static VSIServiceMessage.Msg0	ID0205_STOP_EXCEPTION When stopping the VSI Service an exception occurred.
static VSIServiceMessage.Msg1	ID0206_CONFIG_ERROR The VSI configuration has errors.
static VSIServiceMessage.Msg0	ID0207_SERVICE_NOT_STARTED The VSI service is not started.
static VSIServiceMessage.Msg1	ID0300_VSI_SERVER_CONNECT The server {0} could not be reached.
static VSIServiceMessage.Msg2	ID0305_VSI_JRFC_ERROR Received RFC error key {0} with msg:\n {1} .
static VSIServiceMessage.Msg1	ID0306_PROVIDER_NOT_AVAILABLE Virus scan provider {0} does not exist.
static VSIServiceMessage.Msg1	ID0307_PROFILE_NOT_AVAILABLE_1 No group or profile available for profile {0}.
static VSIServiceMessage.Msg2	ID0308_JRFC_CONVERSION_ERROR RFC conversion error key {0} with msg {1}.
static VSIServiceMessage.Msg2	ID0309_INDEX_OUT_OF_RANGE The passed index {0} is in not suitable for 0-{1}.
static VSIServiceMessage.Msg1	ID0311_PROFILE_NOT_ACTIVE Virus scan profile {0} is not active.
static VSIServiceMessage.Msg1	ID0312_PROFILE_NOT_AVAILABLE Virus scan profile {0} does not exist.
static VSIServiceMessage.Msg1	ID0313_GROUP_NOT_AVAILABLE Virus scan group {0} does not exist.
static VSIServiceMessage.Msg0	ID0314_DEFAULTPROVIDER_NOT_AVAILABLE No default virus scan provider available.
static VSIServiceMessage.Msg0	ID0315_DEFAULTGROUP_NOT_AVAILABLE No default virus scan group available.
static VSIServiceMessage.Msg0	ID0316_DEFAULTPROFILE_NOT_AVAILABLE No default virus scan profile available.
static VSIServiceMessage.Msg0	ID0317_PROFILE_RECURSION The recursive usage of a scan profile is not allowed.
static VSIServiceMessage.Msg1	ID0318_NO_PROVIDER_IN_GROUP No virus scan provider available for scanner group {0}
static VSIServiceMessage.Msg1	ID0319_NO_PROFILE_STEPS Virus scan profile {0} does not contain any steps.
static VSIServiceMessage.Msg0	ID0320_PROFILE_NOT_AVAILABLE_2 Not all steps of the virus scan profile (AND linkage) are available.
static VSIServiceMessage.Msg1	ID0321_PROFILE_NOT_AVAILABLE_3 The virus scan profile {0} is not available.
static VSIServiceMessage.Msg1	ID0322_VSI_SERVER_HOST_DIFFERENT The virus scan server {0} is not running on localhost!
static VSIServiceMessage.Msg1	ID0400_VSI_VIRUS_FOUND The virus scan provider {0} found a virus infection!
static VSIServiceMessage.Msg2	ID0401_VSI_VIRUS_FOUND_0 The virus scan provider {0} found {1} infections!
static VSIServiceMessage.Msg2	ID0402_VSI_VIRUS_FOUND_2 The virus \"{0}\" was found in {1}!
static VSIServiceMessage.Msg1	ID0410_VSI_SCAN_ERROR The virus scan provider {0} failed during the scan!!!
static VSIServiceMessage.Msg2	ID0411_VSI_SCAN_ERROR_0 The virus scan for {0} failed with error \"{1}\".
static VSIServiceMessage.Msg2	ID0412_VSI_SCAN_ERROR_1 The virus scan for {0} failed with {1} error(s).
static VSIServiceMessage.Msg0	ID0451_VSI_NOT_SCAN The passed object was not scanned.
static VSIServiceMessage.Msg1	ID0452_VSI_NOT_SCAN The passed object was not scanned.
static VSIServiceMessage.Msg1	ID0453_VSI_NULL_PARAM The used adapter (VSA) returned a null parameter for {0}.
static VSIServiceMessage.Msg2	ID0454_VSI_PARAMETERTYPE_UNKNOWN The parameter type {0} for {1} is not supported!
static VSIServiceMessage.Msg2	ID0455_VSI_PARAMETER_UNKNOWN The parameter {0} for {1} is not supported!
static VSIServiceMessage.Msg3	ID0456_VSI_INVALID_PARAMETER_VALUE The parameter {0} with value {1} is not type of {2}.
static VSIServiceMessage.Msg0	ID0500_VSI_OK No error, no virus.
static VSIServiceMessage.Msg0	ID0501_VSI_E_NO_SPACE Resource problem: no memory,disk space,handle,etc.
static VSIServiceMessage.Msg0	ID0502_VSI_E_NULL_PARAM NULL parameter was supplied to function, where not allowed.
static VSIServiceMessage.Msg0	ID0503_VSI_E_INVALID_PARAM At least one parameter is invalid.
static VSIServiceMessage.Msg0	ID0504_VSI_E_INVALID_HANDLE Handle to adapter invalid.
static VSIServiceMessage.Msg0	ID0505_VSI_E_NOT_INITIALISED The adapter (VSA) startup routine failed.
static VSIServiceMessage.Msg0	ID0506_VSI_E_EXPIRED Engine or driver(s) out of date - need update.
static VSIServiceMessage.Msg0	ID0507_VSI_E_LOAD_FAILED Loading engine or another library failed.
static VSIServiceMessage.Msg0	ID0508_VSI_E_BAD_EXPRESSION The passed regular expression contains a bad expression.
static VSIServiceMessage.Msg0	ID0509_VSI_E_DRIVER_FAILED Loading the driver(s) failed or invalid driver.
static VSIServiceMessage.Msg0	ID0510_VSI_E_NOT_SUPPORTED Action call or parameter is not supported on this VSA.
static VSIServiceMessage.Msg0	ID0511_VSI_E_INVALID_SCANOBJECT Not correct object, such as \"c:\" for scanFile.
static VSIServiceMessage.Msg0	ID0512_VSI_E_CIO_FAILED Client I/O callback failed.
static VSIServiceMessage.Msg0	ID0513_VSI_E_SCAN_FAILED See ScanError, any scan problem during action occurred.
static VSIServiceMessage.Msg0	ID0514_VSI_E_NOT_SCANNED Not an error, but a warning for the caller.
static VSIServiceMessage.Msg0	ID0515_VSI_E_END_FAILED Termination/unload of VSA (engine) failed.
static VSIServiceMessage.Msg0	ID0516_VSI_E_N_PROGRESS VsaCleanup was not possible, a thread is still running.
static VSIServiceMessage.Msg0	ID0517_VSI_E_CBC_TERMINATED Callback action was terminated by user.
static VSIServiceMessage.Msg0	ID0518_VSI_E_VSA_LOAD_FAILED Load of the VSA failed, might not correct version.
static VSIServiceMessage.Msg0	ID0519_VSI_E_INVALID_PARAM_TYPE This parameters has another type a requested.
static VSIServiceMessage.Msg0	ID0520_VSI_E_PARAM_UNSUPPORTED At least one parameter is not supported or unknown.
static VSIServiceMessage.Msg0	ID0521_VSI_E_SCANPAR_UNSUPPORTED The scan action is not supported by VSA, e.g.
static VSIServiceMessage.Msg0	ID0522_VSI_E_OBJPAR_UNSUPPORTED At least one object type is not supported by VSA, e.g.
static VSIServiceMessage.Msg0	ID0523_VSI_E_CONVERSION_FAILED The internal character conversion failed.
static VSIServiceMessage.Msg0	ID0524_VSI_E_XML_CONFIG_FAILED At least one XML based configuration action failed.
static VSIServiceMessage.Msg0	ID0525_VSI_E_INVALID_ENUM_INDEX At least one "enum" function was called with an invalid index.
static VSIServiceMessage.Msg0	ID0526_VSI_E_BUFFER_TOO_SHORT The provided buffer to the function was too short.
static VSIServiceMessage.Msg0	ID0527_VSI_E_NO_SCANINFO There is no extra VSI_SCANINFO available.
static VSIServiceMessage.Msg0	ID0601_VSI_E_CLEAN_OK Repair/clean of object was OK, Virus/Macros cleaned.
static VSIServiceMessage.Msg0	ID0602_VSI_E_VIRUS_FOUND Found virus during scan.
static VSIServiceMessage.Msg0	ID0603_VSI_E_MACRO_FOUND Found marco virus during scan.
static VSIServiceMessage.Msg0	ID0604_VSI_E_PATTERN_FOUND Found pattern match during content scan.
static VSIServiceMessage.Msg0	ID0605_VSI_E_CLEAN_FAILEDD Repair/clean of object failed.
static java.lang.String	PREFIX_IN_BUNDLE
static java.lang.String	PREFIX_IN_OUTPUT

Constructor Summary

	VSIServiceMessage(VSIServiceMessage.BaseMsg baseMsg, java.lang.Object[] args) Constructor for VSIServiceMessage.
protected	VSIServiceMessage(VSIServiceMessage.BaseMsg baseMsg, java.lang.Object[] args, java.lang.String bundleName, java.lang.String prefixInBundle, java.lang.String prefixInOutput) Constructor for object.

Method Summary

java.lang.String	formatNonLocalized() Format the message using the default text.
VSIServiceMessage.BaseMsg	getBaseMsg() Returns the base message object of this message.
static VSIServiceMessage	getMessage(java.util.Collection info, int vsRC) Create a VSIServiceMessage from a passed VSI_RC.
static VSIServiceMessage	getMessage(int vsRC) Create a VSIServiceMessage from a passed VSI_RC.
java.lang.String	getPrefixInBundle() Returns the prefix to be used in the resource bundle.
java.lang.String	getPrefixInOutput() Returns the prefix to be used in printed output.
java.lang.String	log(int severity, com.sap.tc.logging.Category category, com.sap.tc.logging.Location location, java.lang.String sublocation) Write the message into a log using the SAP Logging API.

Field Detail

BUNDLE

public static final java.lang.String BUNDLE

PREFIX_IN_BUNDLE

public static final java.lang.String PREFIX_IN_BUNDLE

PREFIX_IN_OUTPUT

public static final java.lang.String PREFIX_IN_OUTPUT

ID0001_GENERIC_EXCEPTION

public static final VSIServiceMessage.Msg1 ID0001_GENERIC_EXCEPTION

Gerneric Exception:

ID0100_NO_INSTANCE_AVAILABLE

public static final VSIServiceMessage.Msg0 ID0100_NO_INSTANCE_AVAILABLE

No instance available

ID0101_CONFIG_REFLECTION_ERROR

public static final VSIServiceMessage.Msg4 ID0101_CONFIG_REFLECTION_ERROR

Reflection error during access to field {1} in class {0} with methods {2} and {3}.

ID0102_CONFIG_CLASS_INSTANTIATION

public static final VSIServiceMessage.Msg3 ID0102_CONFIG_CLASS_INSTANTIATION

Exception when creating an instance of class {0} (field {1} in class {2}).

ID0103_CONFIG_FILE_ERROR

public static final VSIServiceMessage.Msg2 ID0103_CONFIG_FILE_ERROR

During processing of field {0} in class {1} (byte array) a stream exception has occurred.

ID0104_CONFIG_ACCESS_ERROR

public static final VSIServiceMessage.Msg2 ID0104_CONFIG_ACCESS_ERROR

Error during access to configuration manager in class {0} in method {1} .

ID0105_CONFIG_OBJECT_ERROR

public static final VSIServiceMessage.Msg2 ID0105_CONFIG_OBJECT_ERROR

Object {0} is not allowed to be passed for method {1}.

ID0106_CONFIG_OBJECT_NULL

public static final VSIServiceMessage.Msg2 ID0106_CONFIG_OBJECT_NULL

The object {0} is new and must first be created. Invalid object passed to method {1}.

ID0113_BAD_METHOD_INPUT

public static final VSIServiceMessage.Msg2 ID0113_BAD_METHOD_INPUT

The provided input {0} for method {1} is not correct.

ID0114_WRONG_INSTANCE_PASSED

public static final VSIServiceMessage.Msg0 ID0114_WRONG_INSTANCE_PASSED

Wrong instance object passed.

ID0115_WRONG_FIELD_TYPE

public static final VSIServiceMessage.Msg4 ID0115_WRONG_FIELD_TYPE

Configuration entry {0} in node {1} has field type {2}, but expected is {3}. The database entry will be deleted.

ID0116_CONFIG_HANDLER_EXC

public static final VSIServiceMessage.Msg1 ID0116_CONFIG_HANDLER_EXC

The configuration handler for path {0} has thrown an exception.

ID0117_CONFIG_UNSUPPORTED_TYPE

public static final VSIServiceMessage.Msg3 ID0117_CONFIG_UNSUPPORTED_TYPE

Configuration class {0} has field {1} with type {2} which is not supported.

ID0118_CONFIG_PARAM_EMPTY

public static final VSIServiceMessage.Msg2 ID0118_CONFIG_PARAM_EMPTY

Configuration parameter {0} must have a value (path: {1}).

ID0119_CONFIG_PARAM_NEGATIVE

public static final VSIServiceMessage.Msg3 ID0119_CONFIG_PARAM_NEGATIVE

Configuration parameter {0} must have a non-negative value. Current value is {1} (path: {2}).

ID0120_CONFIG_VSA_NAME

public static final VSIServiceMessage.Msg4 ID0120_CONFIG_VSA_NAME

Configuration parameter {0} has value "{1}" which is no valid valid adapter name: {2} (path: {3}).

ID0121_CONFIG_VSCAN_NAME

public static final VSIServiceMessage.Msg4 ID0121_CONFIG_VSCAN_NAME

Configuration parameter {0} has value "{1}" which is no valid Virus Scan Server name: {2} (path: {3}).

ID0122_CONFIG_VSCAN_LOCALE

public static final VSIServiceMessage.Msg2 ID0122_CONFIG_VSCAN_LOCALE

Configuration parameter {0} is no valid locale: (path: {1}).

ID0200_SERVICE_STARTING

public static final VSIServiceMessage.Msg0 ID0200_SERVICE_STARTING

\"Virus Scan Provider\" service starting.

ID0201_SERVICE_STARTED

public static final VSIServiceMessage.Msg0 ID0201_SERVICE_STARTED

\"Virus Scan Provider\" service started.

ID0202_SERVICE_STOPPING

public static final VSIServiceMessage.Msg0 ID0202_SERVICE_STOPPING

\"Virus Scan Provider\" service stopping.

ID0203_SERVICE_STOPPED

public static final VSIServiceMessage.Msg0 ID0203_SERVICE_STOPPED

\"Virus Scan Provider\" service stopped.

ID0204_START_EXCEPTION

public static final VSIServiceMessage.Msg0 ID0204_START_EXCEPTION

The \"Virus Scan Provider\" service could not be started because an exception occurred.

ID0205_STOP_EXCEPTION

public static final VSIServiceMessage.Msg0 ID0205_STOP_EXCEPTION

When stopping the VSI Service an exception occurred.

ID0206_CONFIG_ERROR

public static final VSIServiceMessage.Msg1 ID0206_CONFIG_ERROR

The VSI configuration has errors. Detailed messages were written to logging category {0}.

ID0207_SERVICE_NOT_STARTED

public static final VSIServiceMessage.Msg0 ID0207_SERVICE_NOT_STARTED

The VSI service is not started.

ID0300_VSI_SERVER_CONNECT

public static final VSIServiceMessage.Msg1 ID0300_VSI_SERVER_CONNECT

The server {0} could not be reached.

ID0305_VSI_JRFC_ERROR

public static final VSIServiceMessage.Msg2 ID0305_VSI_JRFC_ERROR

Received RFC error key {0} with msg:\n {1} .

ID0306_PROVIDER_NOT_AVAILABLE

public static final VSIServiceMessage.Msg1 ID0306_PROVIDER_NOT_AVAILABLE

Virus scan provider {0} does not exist.

ID0307_PROFILE_NOT_AVAILABLE_1

public static final VSIServiceMessage.Msg1 ID0307_PROFILE_NOT_AVAILABLE_1

No group or profile available for profile {0}.

ID0308_JRFC_CONVERSION_ERROR

public static final VSIServiceMessage.Msg2 ID0308_JRFC_CONVERSION_ERROR

RFC conversion error key {0} with msg {1}.

ID0309_INDEX_OUT_OF_RANGE

public static final VSIServiceMessage.Msg2 ID0309_INDEX_OUT_OF_RANGE

The passed index {0} is in not suitable for 0-{1}.

ID0311_PROFILE_NOT_ACTIVE

public static final VSIServiceMessage.Msg1 ID0311_PROFILE_NOT_ACTIVE

Virus scan profile {0} is not active.

ID0312_PROFILE_NOT_AVAILABLE

public static final VSIServiceMessage.Msg1 ID0312_PROFILE_NOT_AVAILABLE

Virus scan profile {0} does not exist.

ID0313_GROUP_NOT_AVAILABLE

public static final VSIServiceMessage.Msg1 ID0313_GROUP_NOT_AVAILABLE

Virus scan group {0} does not exist.

ID0314_DEFAULTPROVIDER_NOT_AVAILABLE

public static final VSIServiceMessage.Msg0 ID0314_DEFAULTPROVIDER_NOT_AVAILABLE

No default virus scan provider available.

ID0315_DEFAULTGROUP_NOT_AVAILABLE

public static final VSIServiceMessage.Msg0 ID0315_DEFAULTGROUP_NOT_AVAILABLE

No default virus scan group available.

ID0316_DEFAULTPROFILE_NOT_AVAILABLE

public static final VSIServiceMessage.Msg0 ID0316_DEFAULTPROFILE_NOT_AVAILABLE

No default virus scan profile available.

ID0317_PROFILE_RECURSION

public static final VSIServiceMessage.Msg0 ID0317_PROFILE_RECURSION

The recursive usage of a scan profile is not allowed.

ID0318_NO_PROVIDER_IN_GROUP

public static final VSIServiceMessage.Msg1 ID0318_NO_PROVIDER_IN_GROUP

No virus scan provider available for scanner group {0}

ID0319_NO_PROFILE_STEPS

public static final VSIServiceMessage.Msg1 ID0319_NO_PROFILE_STEPS

Virus scan profile {0} does not contain any steps.

ID0320_PROFILE_NOT_AVAILABLE_2

public static final VSIServiceMessage.Msg0 ID0320_PROFILE_NOT_AVAILABLE_2

Not all steps of the virus scan profile (AND linkage) are available.

ID0321_PROFILE_NOT_AVAILABLE_3

public static final VSIServiceMessage.Msg1 ID0321_PROFILE_NOT_AVAILABLE_3

The virus scan profile {0} is not available.

ID0322_VSI_SERVER_HOST_DIFFERENT

public static final VSIServiceMessage.Msg1 ID0322_VSI_SERVER_HOST_DIFFERENT

The virus scan server {0} is not running on localhost!

ID0400_VSI_VIRUS_FOUND

public static final VSIServiceMessage.Msg1 ID0400_VSI_VIRUS_FOUND

The virus scan provider {0} found a virus infection!

ID0401_VSI_VIRUS_FOUND_0

public static final VSIServiceMessage.Msg2 ID0401_VSI_VIRUS_FOUND_0

The virus scan provider {0} found {1} infections!

ID0402_VSI_VIRUS_FOUND_2

public static final VSIServiceMessage.Msg2 ID0402_VSI_VIRUS_FOUND_2

The virus \"{0}\" was found in {1}!

ID0410_VSI_SCAN_ERROR

public static final VSIServiceMessage.Msg1 ID0410_VSI_SCAN_ERROR

The virus scan provider {0} failed during the scan!!!

ID0411_VSI_SCAN_ERROR_0

public static final VSIServiceMessage.Msg2 ID0411_VSI_SCAN_ERROR_0

The virus scan for {0} failed with error \"{1}\".

ID0412_VSI_SCAN_ERROR_1

public static final VSIServiceMessage.Msg2 ID0412_VSI_SCAN_ERROR_1

The virus scan for {0} failed with {1} error(s).

ID0451_VSI_NOT_SCAN

public static final VSIServiceMessage.Msg0 ID0451_VSI_NOT_SCAN

The passed object was not scanned.

ID0452_VSI_NOT_SCAN

public static final VSIServiceMessage.Msg1 ID0452_VSI_NOT_SCAN

The passed object was not scanned. Message from the scan engine: \"{0}\"

ID0453_VSI_NULL_PARAM

public static final VSIServiceMessage.Msg1 ID0453_VSI_NULL_PARAM

The used adapter (VSA) returned a null parameter for {0}.

ID0454_VSI_PARAMETERTYPE_UNKNOWN

public static final VSIServiceMessage.Msg2 ID0454_VSI_PARAMETERTYPE_UNKNOWN

The parameter type {0} for {1} is not supported!

ID0455_VSI_PARAMETER_UNKNOWN

public static final VSIServiceMessage.Msg2 ID0455_VSI_PARAMETER_UNKNOWN

The parameter {0} for {1} is not supported!

ID0456_VSI_INVALID_PARAMETER_VALUE

public static final VSIServiceMessage.Msg3 ID0456_VSI_INVALID_PARAMETER_VALUE

The parameter {0} with value {1} is not type of {2}.

ID0500_VSI_OK

public static final VSIServiceMessage.Msg0 ID0500_VSI_OK

No error, no virus.

ID0501_VSI_E_NO_SPACE

public static final VSIServiceMessage.Msg0 ID0501_VSI_E_NO_SPACE

Resource problem: no memory,disk space,handle,etc. avail.

ID0502_VSI_E_NULL_PARAM

public static final VSIServiceMessage.Msg0 ID0502_VSI_E_NULL_PARAM

NULL parameter was supplied to function, where not allowed.

ID0503_VSI_E_INVALID_PARAM

public static final VSIServiceMessage.Msg0 ID0503_VSI_E_INVALID_PARAM

At least one parameter is invalid.

ID0504_VSI_E_INVALID_HANDLE

public static final VSIServiceMessage.Msg0 ID0504_VSI_E_INVALID_HANDLE

Handle to adapter invalid.

ID0505_VSI_E_NOT_INITIALISED

public static final VSIServiceMessage.Msg0 ID0505_VSI_E_NOT_INITIALISED

The adapter (VSA) startup routine failed. Initialisation failed!

ID0506_VSI_E_EXPIRED

public static final VSIServiceMessage.Msg0 ID0506_VSI_E_EXPIRED

Engine or driver(s) out of date - need update.

ID0507_VSI_E_LOAD_FAILED

public static final VSIServiceMessage.Msg0 ID0507_VSI_E_LOAD_FAILED

Loading engine or another library failed.

ID0508_VSI_E_BAD_EXPRESSION

public static final VSIServiceMessage.Msg0 ID0508_VSI_E_BAD_EXPRESSION

The passed regular expression contains a bad expression.

ID0509_VSI_E_DRIVER_FAILED

public static final VSIServiceMessage.Msg0 ID0509_VSI_E_DRIVER_FAILED

Loading the driver(s) failed or invalid driver.

ID0510_VSI_E_NOT_SUPPORTED

public static final VSIServiceMessage.Msg0 ID0510_VSI_E_NOT_SUPPORTED

Action call or parameter is not supported on this VSA.

ID0511_VSI_E_INVALID_SCANOBJECT

public static final VSIServiceMessage.Msg0 ID0511_VSI_E_INVALID_SCANOBJECT

Not correct object, such as \"c:\" for scanFile.

ID0512_VSI_E_CIO_FAILED

public static final VSIServiceMessage.Msg0 ID0512_VSI_E_CIO_FAILED

Client I/O callback failed. Scan could not be performed.

ID0513_VSI_E_SCAN_FAILED

public static final VSIServiceMessage.Msg0 ID0513_VSI_E_SCAN_FAILED

See ScanError, any scan problem during action occurred.

ID0514_VSI_E_NOT_SCANNED

public static final VSIServiceMessage.Msg0 ID0514_VSI_E_NOT_SCANNED

Not an error, but a warning for the caller.

ID0515_VSI_E_END_FAILED

public static final VSIServiceMessage.Msg0 ID0515_VSI_E_END_FAILED

Termination/unload of VSA (engine) failed.

ID0516_VSI_E_N_PROGRESS

public static final VSIServiceMessage.Msg0 ID0516_VSI_E_N_PROGRESS

VsaCleanup was not possible, a thread is still running.

ID0517_VSI_E_CBC_TERMINATED

public static final VSIServiceMessage.Msg0 ID0517_VSI_E_CBC_TERMINATED

Callback action was terminated by user.

ID0518_VSI_E_VSA_LOAD_FAILED

public static final VSIServiceMessage.Msg0 ID0518_VSI_E_VSA_LOAD_FAILED

Load of the VSA failed, might not correct version.

ID0519_VSI_E_INVALID_PARAM_TYPE

public static final VSIServiceMessage.Msg0 ID0519_VSI_E_INVALID_PARAM_TYPE

This parameters has another type a requested.

ID0520_VSI_E_PARAM_UNSUPPORTED

public static final VSIServiceMessage.Msg0 ID0520_VSI_E_PARAM_UNSUPPORTED

At least one parameter is not supported or unknown.

ID0521_VSI_E_SCANPAR_UNSUPPORTED

public static final VSIServiceMessage.Msg0 ID0521_VSI_E_SCANPAR_UNSUPPORTED

The scan action is not supported by VSA, e.g. VsiClean.

ID0522_VSI_E_OBJPAR_UNSUPPORTED

public static final VSIServiceMessage.Msg0 ID0522_VSI_E_OBJPAR_UNSUPPORTED

At least one object type is not supported by VSA, e.g. scanBytes.

ID0523_VSI_E_CONVERSION_FAILED

public static final VSIServiceMessage.Msg0 ID0523_VSI_E_CONVERSION_FAILED

The internal character conversion failed.

ID0524_VSI_E_XML_CONFIG_FAILED

public static final VSIServiceMessage.Msg0 ID0524_VSI_E_XML_CONFIG_FAILED

At least one XML based configuration action failed.

ID0525_VSI_E_INVALID_ENUM_INDEX

public static final VSIServiceMessage.Msg0 ID0525_VSI_E_INVALID_ENUM_INDEX

At least one "enum" function was called with an invalid index.

ID0526_VSI_E_BUFFER_TOO_SHORT

public static final VSIServiceMessage.Msg0 ID0526_VSI_E_BUFFER_TOO_SHORT

The provided buffer to the function was too short.

ID0527_VSI_E_NO_SCANINFO

public static final VSIServiceMessage.Msg0 ID0527_VSI_E_NO_SCANINFO

There is no extra VSI_SCANINFO available.

ID0601_VSI_E_CLEAN_OK

public static final VSIServiceMessage.Msg0 ID0601_VSI_E_CLEAN_OK

Repair/clean of object was OK, Virus/Macros cleaned.

ID0602_VSI_E_VIRUS_FOUND

public static final VSIServiceMessage.Msg0 ID0602_VSI_E_VIRUS_FOUND

Found virus during scan.

ID0603_VSI_E_MACRO_FOUND

public static final VSIServiceMessage.Msg0 ID0603_VSI_E_MACRO_FOUND

Found marco virus during scan.

ID0604_VSI_E_PATTERN_FOUND

public static final VSIServiceMessage.Msg0 ID0604_VSI_E_PATTERN_FOUND

Found pattern match during content scan.

ID0605_VSI_E_CLEAN_FAILEDD

public static final VSIServiceMessage.Msg0 ID0605_VSI_E_CLEAN_FAILEDD

Repair/clean of object failed.

Constructor Detail

VSIServiceMessage

public VSIServiceMessage(VSIServiceMessage.BaseMsg baseMsg,
                         java.lang.Object[] args)

Constructor for VSIServiceMessage.

Parameters:

baseMsg - Basis message class.

args - User arguments.

VSIServiceMessage

protected VSIServiceMessage(VSIServiceMessage.BaseMsg baseMsg,
                            java.lang.Object[] args,
                            java.lang.String bundleName,
                            java.lang.String prefixInBundle,
                            java.lang.String prefixInOutput)

Constructor for object.

The implementing subclass calls it, passing in the parameters from the static create() method, enriched by its own data.

Parameters:

baseMsg - The base message object that has created the message.

args - The arguments for the message instance.

bundleName - The resource bundle name where the message can be found.

prefixInBundle - The prefix which is to be added to the message key before it can be looked up in the bundle.

prefixInOutput - If the message is output within an exception, this prefix is prepended to the message key to give a short message ID suitable for looking up in a note tracking system.

Method Detail

getMessage

public static VSIServiceMessage getMessage(int vsRC)

Create a VSIServiceMessage from a passed VSI_RC.

This help method should return a SAP BaseMsg fro a virus scan return code. These messages are stored in property files and could also be translated into other languages.

The returned VSIServiceMessage object can be passed directly to create a VSIServiceException which is thrown during these API functions.

Parameters:

vsRC - The numerical VSI_RC from the native layer

Returns:

VSIServiceMessage

getMessage

public static VSIServiceMessage getMessage(java.util.Collection info,
                                           int vsRC)

Create a VSIServiceMessage from a passed VSI_RC.

This help method should return a SAP BaseMsg fro a virus scan return code. These messages are stored in property files and could also be translated into other languages.

The returned VSIServiceMessage object can be passed directly to create a VSIServiceException which is thrown during these API functions.

Parameters:

info - Collection of Infection or ScanError

vsRC - The numerical VSI_RC from the native layer

Returns:

VSIServiceMessage

formatNonLocalized

public java.lang.String formatNonLocalized()

Format the message using the default text. If formatiing fails, a fallback with the technical data is returned.

getPrefixInOutput

public java.lang.String getPrefixInOutput()

Returns the prefix to be used in printed output.

Returns:

The output prefix.

getPrefixInBundle

public java.lang.String getPrefixInBundle()

Returns the prefix to be used in the resource bundle.

Returns:

The bundle prefix.

getBaseMsg

public VSIServiceMessage.BaseMsg getBaseMsg()

Returns the base message object of this message.

Returns:

The base message object.

log

public java.lang.String log(int severity,
                            com.sap.tc.logging.Category category,
                            com.sap.tc.logging.Location location,
                            java.lang.String sublocation)

Write the message into a log using the SAP Logging API.

Parameters:

severity - A constant from class Severity. Note that for logs only the severities INFO, WARNING, ERROR and FATAL are foreseen.

category - The Category the writes the log.

location - The Location for the log.

sublocation - The sublocation (method name) for the log.

Returns:

The ID of the created log, or an explanation if the log could not be created.