com.sap.security.core.server.vsi.api
Interface Provider

All Known Subinterfaces:

Adapter, Server

public interface Provider

Virus scan provider object. This class represents the scan provider, which can either be a virus scan adapter or a "Virus Scan Server".
The virus scan adapter runs in the same process as the JVM and receives the data from the memory.
The Virus Scan Server is a RFC server program, which receives data to be scanned for infections.

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:

VSIService.getProvider(), Instance

Method Summary

Adapter	getAdapter() Return the adapter object of the current instance.
Driver[]	getDrivers() Get the loaded drivers
Engine	getEngine() Retrieve the engine object from the VSA
java.util.Date	getLastInitTime() Return the Date (time) of the last successful initialisation of the Provider and its scan engine.
java.lang.String	getName() Get the provider Name.
Parameter	getParameter(java.lang.String paramName) Get one parameter.
Parameter[]	getParameters() Get all actual paramters.
Server	getServer() If the instance provider is a Virus Scan Server, this method returns the Server object of the instance.
boolean	isServer() Return boolean for the type of the current scan instance.
boolean	setDefaultConfig() Set or reset the default configuration.
boolean	setParameter(Parameter vsParameter) Set a parameter.

Method Detail

getName

public java.lang.String getName()

Get the provider Name.

This name was defined in the configuration.

Returns:

The defined name of the Instance.

isServer

public boolean isServer()

Return boolean for the type of the current scan instance.

Returns:

TRUE : the instance is from a Virus Scan Server
FALSE: the instance is from a virus Scan Adapter

getAdapter

public Adapter getAdapter()
                   throws VSIServiceException

Return the adapter object of the current instance.

Returns:

Adapter object.

getServer

public Server getServer()
                 throws VSIServiceException

If the instance provider is a Virus Scan Server, this method returns the Server object of the instance. If the provider is an adapter, it returns 'null'. Therefore use the method isServer() to determine whether it is a Virus Scan Server.

Returns:

Server object or 'null'

getEngine

public Engine getEngine()
                 throws VSIServiceException

Retrieve the engine object from the VSA

Returns:

Engine object

getDrivers

public Driver[] getDrivers()
                    throws VSIServiceException

Get the loaded drivers

Returns:

Driver[] object

getParameters

public Parameter[] getParameters()

Get all actual paramters.

Returns:

Parameter[] object.

getParameter

public Parameter getParameter(java.lang.String paramName)
                       throws VSIServiceException

Get one parameter.

Parameters:

paramName - Name of the parameter to be querried.

Returns:

Parameter object.

setParameter

public boolean setParameter(Parameter vsParameter)
                     throws VSIServiceException

Set a parameter.

Parameters:

vsParameter - Scan parameter

Returns:

true (on success)

setDefaultConfig

public boolean setDefaultConfig()
                         throws VSIServiceException

Set or reset the default configuration.

Returns:

true (on success)

getLastInitTime

public java.util.Date getLastInitTime()
                               throws VSIServiceException

Return the Date (time) of the last successful initialisation of the Provider and its scan engine.

Returns:

Date object with last init time

Throws:

VSIServiceException -