SAP ABAP Class CL_VSI_KERNEL (Virus Scan API suitable for kernel usage)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC-VIR (Application Component) Anti-Virus Protection
     ⤷ SVSCAN (Package) Virus Scan of SAP Objects

Properties

Class	CL_VSI_KERNEL
Short Description	Virus Scan API suitable for kernel usage
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SVSCAN	Virus Scan of SAP Objects
Created	20110715	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_VSI_KERNEL has no interface implemented.

Friends

Class CL_VSI_KERNEL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_TAG_JOB_ID	Constant	Private	☐	Type reference (TYPE)	VSCAN_JOB_ID	'TAG_JOB_ID'	Job ID for a Scan Run	20110715
2	PF_PROFILE	Instance attribute	Private	☐	Type reference (TYPE)	VSCAN_PROFILE		Virus Scan Profile	20110715
3	PO_SCAN_INSTANCE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_VSI		Virus Scan API for Application Developers	20110715

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Private	Constructor	CONSTRUCTOR	20110715
2	GET_INSTANCE	Static method	Public	Method	Create instance	20110715
3	GET_SCAN_INSTANCE	Instance method	Private	Method	Acquire scanner instance	20110715
4	SCAN_XSTRING	Instance method	Public	Method	Scan byte sequence	20110715
5	STRIP_DEFAULT_JOB_ID	Static method	Private	Method	Remove default job ID from object name	20110715

Events

Class CL_VSI_KERNEL has no event.

Types

Class CL_VSI_KERNEL has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_PROFILE	Call by reference	☐	Type reference (TYPE)	VSCAN_PROFILE		Virus Scan Profile	20110715

Method CONSTRUCTOR on class CL_VSI_KERNEL has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_VSI_KERNEL		Virus Scan API suitable for kernel usage	20110715
2	Importing	IF_LAZY_INITIALIZATION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Initialization at first scan access	20110715
3	Importing	IF_PROFILE	Call by reference	☐	Type reference (TYPE)	VSCAN_PROFILE		Virus Scan Profile	20110715

#	Exception	Resumable	Description	Created on
1	CX_VSI_PROFILE_NOT_ACTIVE	☐	Virus Scan Exception: Profile is not active	20110715
2	CX_VSI_ROOT	☐	Virus Scan Exception: Base Class	20110715

Method GET_SCAN_INSTANCE Signature

Method GET_SCAN_INSTANCE on class CL_VSI_KERNEL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_VSI_PROFILE_NOT_ACTIVE	☐	Virus Scan Exception: Profile is not active	20110715
2	CX_VSI_ROOT	☐	Virus Scan Exception: Base Class	20110715

Method SCAN_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING		Data to be scanned	20110715

#	Exception	Resumable	Description	Created on
1	CX_VSI_ROOT	☐	Virus Scan Exception: Base Class	20110715
2	CX_VSI_SCAN_ISSUE	☐	Virus Scan Exception: Base class for issues during scan	20110715

Method STRIP_DEFAULT_JOB_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EF_OUT	Value transfer	☐	Type reference (TYPE)	VSCAN_OBJECT_NAME		Name of a Processed Object	20110715
2	Importing	IF_IN	Call by reference	☐	Type reference (TYPE)	VSCAN_OBJECT_NAME		Name of a Processed Object	20110715

Method STRIP_DEFAULT_JOB_ID on class CL_VSI_KERNEL has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	732