SAP ABAP Class CL_XMS_VIRUS_SCAN (Virus Scanner Integration)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-XI-IS-IEN (Application Component) Integration Engine
     SXMSF (Package) XI: Integration Engine Runtime
Properties
Class CL_XMS_VIRUS_SCAN  
Short Description Virus Scanner Integration    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SXMSF   XI: Integration Engine Runtime 
Created 20110919   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)
2 IF_SRV_CONSTANTS Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
3 IF_XMS_RESOURCE Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Class CL_XMS_VIRUS_SCAN has no interface implemented.
Friends
Class CL_XMS_VIRUS_SCAN has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 AREA Instance attribute Private Type reference (TYPE) SXMSERRAREA XI: System Error Area 20110926
2 CO_VIRUS_SCAN_ACTIVE Constant Public Type reference (TYPE) CHAR1 '1' Single-Character Flag 20110922
3 CO_VIRUS_SCAN_CONFIG_ADAPTER Constant Public Type reference (TYPE) SXMS_SCAN_CONFIG '2' Scan Configuration - Scan by Adapter 20111010
4 CO_VIRUS_SCAN_CONFIG_GLOBAL Constant Public Type reference (TYPE) SXMS_SCAN_CONFIG '0' Scan Configuration - Use Global 20110926
5 CO_VIRUS_SCAN_CONFIG_NONE Constant Public Type reference (TYPE) SXMS_SCAN_CONFIG '1' Scan Configuration - No Scan 20111010
6 CO_VIRUS_SCAN_INACTIVE Constant Public Type reference (TYPE) CHAR1 '0' Single-Character Flag 20111011
7 CO_VIRUS_SCAN_INBOUND Constant Public Type reference (TYPE) SXMSTSNAM 'VIRUS_SCAN_INBOUND' Name of a Time Stamp 20110927
8 CO_VIRUS_SCAN_MODE_ATTACHMENTS Constant Public Type reference (TYPE) SXMS_SCAN_MODE '1' Scan Mode 20110922
9 CO_VIRUS_SCAN_MODE_COMPLETE Constant Public Type reference (TYPE) SXMS_SCAN_MODE '2' Scan Mode 20110922
10 CO_VIRUS_SCAN_TYPE_ALL Constant Public Type reference (TYPE) SXMS_SCAN_TYPE '2' Scan Type 20110922
11 CO_VIRUS_SCAN_TYPE_BINARY Constant Public Type reference (TYPE) SXMS_SCAN_TYPE '1' Scan Type 20110922
12 VIRUS_SCAN_ACTIVE Instance attribute Private Type reference (TYPE) ABAP_BOOL Scan Active 20110922
13 VIRUS_SCAN_MODE Instance attribute Private Type reference (TYPE) SXMS_SCAN_MODE Scan Mode 20110922
14 VIRUS_SCAN_PROFILE Instance attribute Private Type reference (TYPE) VSCAN_PROFILE Scan Profile 20110922
15 VIRUS_SCAN_TYPE Instance attribute Private Type reference (TYPE) SXMS_SCAN_TYPE Scan Type 20110922
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor Constructor 20110922
2 IS_VIRUS_SCAN_ACTIVE Instance method Public Method Scan Active? 20110927
3 IS_VIRUS_SCAN_CONFIGURED Instance method Public Method Scan Configured? 20110926
4 RAISE_EXCEPTION Instance method Private Method Throw Exception 20110927
5 SCAN_ATTACHMENT Instance method Public Method Scan Attachment 20110927
6 SCAN_MESSAGE Instance method Public Method Scan Message 20110922
7 SCAN_PAYLOAD Instance method Public Method Scan Payload 20110927
8 VSI_GET_INSTANCE Instance method Private Method VSI Get Instance 20110926
9 VSI_SCAN_BYTES Instance method Private Method VSI Scan Bytes 20110926
Events
Class CL_XMS_VIRUS_SCAN has no event.
Types
Class CL_XMS_VIRUS_SCAN has no local type.
Method Signatures

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_XMS_VIRUS_SCAN has no parameter.
Method CONSTRUCTOR on class CL_XMS_VIRUS_SCAN has no exception.

Method IS_VIRUS_SCAN_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_VIRUS_SCAN_ACTIVE Value transfer Type reference (TYPE) ABAP_BOOL 20110927
# Exception Resumable Description Created on
1 CX_XMS_SYSERR_VIRUS_SCAN XI: Virus Scan Error 20110927

Method IS_VIRUS_SCAN_CONFIGURED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_BINDING Call by reference Object reference (TYPE REF TO) CL_SRV_BINDING XI Services: In, Out & P2P Binding Runtime 20110926
2 Importing IM_USE_GLOBAL Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20110928
3 Returning RE_VIRUS_SCAN_CONFIGURED Value transfer Type reference (TYPE) ABAP_BOOL 20110926
# Exception Resumable Description Created on
1 CX_XMS_SYSERR_VIRUS_SCAN XI: Virus Scan Error 20110927

Method RAISE_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID Call by reference Type reference (TYPE) SXMSERRID XI: Error ID 20110927
2 Importing INFO Call by reference Type reference (TYPE) CSEQUENCE 20110927
3 Importing P1 Call by reference Type reference (TYPE) STRING 20110927
4 Importing P2 Call by reference Type reference (TYPE) STRING 20110927
5 Importing P3 Call by reference Type reference (TYPE) STRING 20110927
6 Importing P4 Call by reference Type reference (TYPE) STRING 20110927
7 Importing PREVIOUS Call by reference Object reference (TYPE REF TO) CX_ROOT Abstract Superclass for All Global Exceptions 20110927
# Exception Resumable Description Created on
1 CX_XMS_SYSERR_VIRUS_SCAN Virus Scan Error 20110927

Method SCAN_ATTACHMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_DATA Call by reference Type reference (TYPE) XSTRING Attachment Data 20110927
2 Importing IM_TYPE Call by reference Type reference (TYPE) CHAR1 Content Type 20111011
# Exception Resumable Description Created on
1 CX_XMS_SYSERR_VIRUS_SCAN XI: Virus Scan Error 20110927

Method SCAN_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_MESSAGE Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB Higher Level Message Interface 20110922
# Exception Resumable Description Created on
1 CX_XMS_SYSERR_VIRUS_SCAN XI: Virus Scan Error 20110926

Method SCAN_PAYLOAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_PAYLOAD Call by reference Type reference (TYPE) XSTRING Payload Data 20110927
2 Importing IM_TYPE Call by reference Type reference (TYPE) CHAR1 IF_XMS_RESOURCE=>TEXTRESOURCE Content Type 20111011
# Exception Resumable Description Created on
1 CX_XMS_SYSERR_VIRUS_SCAN XI: Virus Scan Error 20110927

Method VSI_GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_VSI Call by reference Object reference (TYPE REF TO) CL_VSI Virus Scan API for Application Developers 20110926
# Exception Resumable Description Created on
1 CX_XMS_SYSERR_VIRUS_SCAN XI: Virus Scan Error 20110926

Method VSI_SCAN_BYTES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_DATA Call by reference Type reference (TYPE) XSTRING 20110926
2 Importing IM_VSI Call by reference Object reference (TYPE REF TO) CL_VSI Virus Scan API for Application Developers 20110926
# Exception Resumable Description Created on
1 CX_XMS_SYSERR_VIRUS_SCAN XI: Virus Scan Error 20110926
History
Last changed by/on SAP  20130531 
SAP Release Created in 732