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

public interface Group

Virus scan group object. This class represents the scan groups, which contains one or more virus scan providers.
The group is used for load balancing reasons.

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.getGroup(), Instance

Method Summary

java.lang.String	getName() Get the group name.
Parameter	getParameter(java.lang.String paramName) Get one parameter.
Parameter[]	getParameters() Get all actual defined paramters.
Provider	getProvider(int vsIndex) Get a specific provider object from the group.
Provider	getProvider(java.lang.String vsProviderName) Get a specific provider object from the group.
java.lang.String[]	getProviders() Get the list of provider names which assigned to this Group.

Method Detail

getName

public java.lang.String getName()

Get the group name.

This name was defined in the configuration.

Returns:

The defined name of the Instance.

getParameters

public Parameter[] getParameters()

Get all actual defined paramters.

Note: In the Group you can not check weather a Parameter is valid or not for a Provider.

Returns:

Parameter[] object.

getParameter

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

Get one parameter.

This method returns one Parameter defined for the Group or NULL, if this Parameter is unknown.

Parameters:

paramName - Name of the parameter to be querried.

Returns:

Parameter object.

getProviders

public java.lang.String[] getProviders()

Get the list of provider names which assigned to this Group.

This array contains all provider names, the activated and the not activated providers. If you want only activated providers, then use the getProviders method from VSIService.

Returns:

Provider names.

See Also:

VSIService.getProviders()

getProvider

public Provider getProvider(java.lang.String vsProviderName)
                     throws VSIServiceException

Get a specific provider object from the group.

Note: This will only work , if the Provider is activated and available within the VSI framework. Otherwise you will receive here an Exeception.

Parameters:

vsProviderName - Name of the provider to be returned.

Returns:

Provider object.

Throws:

VSIServiceException -

See Also:

Provider

getProvider

public Provider getProvider(int vsIndex)
                     throws VSIServiceException

Get a specific provider object from the group.

Parameters:

vsIndex - Index of the provider to be returned.

Returns:

Provider object.

See Also:

Provider