com.pcube.apps.engage.policy
Class ProtocolFamiliesManager

java.lang.Object
  com.pcube.apps.engage.policy.ProtocolFamiliesManager

All Implemented Interfaces:

Formattable

public class ProtocolFamiliesManager
extends Object
implements Formattable

This class manages ProtocolFamilies settings for a policy. The services this class provides are: 1. read/write ProtocolFamilyArray to/from XML. 2. replace the protcol family settings with new ones. 3. update protocol filter rules. 4. restore ProtocolFamilies settings to Engage default. 5. updates the families with protocols imported from DSS Note: if the ProtocolFamilies settings are the default settings (see the default settings xml file) then the collection of families in the policy is null

Author:

rafis

Field Summary

static String	SAPM_DETECTED_PROTOCOL_FAMILY
static String	XML_ATT_NAME
static String	XML_TAG_SIGNATURE_SET

Method Summary

void	fromStream(BufferedReader in, Formatter f) Method fromStream
ProtocolFamilyArray	fromXML(File in) read protocol family list from XML
ProtocolFamilyArray	fromXML(InputStream in) read protocol family list from XML
ProtocolFamilyArray	fromXML(String xml) read protocol family list from XML
ProtocolFamilyArray	getDefaultEngageSettings() get Engage Default ProtocolFamilies Settings
List	getFamiliesFilters() get a list of protocol filters corresponding to the protocol families settings
ProtocolFamilyArray	getNonHiddenProtocolFamilies()
ProtocolFamilyArray	getProtocolFamilies() get the policy's Protocol Family list
Map	getProtocolToFamilyMapping() creates and returns a map of protocol names to ProtocolFamily list.
String[]	getServicesNamesByProtocolFamily(String familyName) return service names array that associate with input family name
Map	getSignatureToFamilyMapping(ProtocolFamilyArray families) creates and returns a map of signature names to ProtocolFamily list.
boolean	isDefaults() is protocol families settings are the system defaults
void	restoreDefaults()
void	setProtocolFamilies(ProtocolFamilyArray families) update the policy's Protocol Family list
void	toStream(PrintStream out, Formatter f) Method toStream
String	toXML() convert to XML text the current protocol families
String	toXML(ProtocolFamilyArray families) convert to XML text the specified protocol families

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XML_ATT_NAME

public static final String XML_ATT_NAME

See Also:

Constant Field Values

XML_TAG_SIGNATURE_SET

public static final String XML_TAG_SIGNATURE_SET

See Also:

Constant Field Values

SAPM_DETECTED_PROTOCOL_FAMILY

public static final String SAPM_DETECTED_PROTOCOL_FAMILY

See Also:

Constant Field Values

Method Detail

restoreDefaults

public void restoreDefaults()

getDefaultEngageSettings

public ProtocolFamilyArray getDefaultEngageSettings()

get Engage Default ProtocolFamilies Settings

getProtocolFamilies

public ProtocolFamilyArray getProtocolFamilies()

get the policy's Protocol Family list

getNonHiddenProtocolFamilies

public ProtocolFamilyArray getNonHiddenProtocolFamilies()

setProtocolFamilies

public void setProtocolFamilies(ProtocolFamilyArray families)

update the policy's Protocol Family list

toXML

public String toXML()

convert to XML text the current protocol families

Parameters:

doc -

Returns:

toXML

public String toXML(ProtocolFamilyArray families)

convert to XML text the specified protocol families

Returns:

fromXML

public ProtocolFamilyArray fromXML(String xml)
                            throws ImportExportException

read protocol family list from XML

Parameters:

in -

Throws:

ImportExportException

fromXML

public ProtocolFamilyArray fromXML(File in)
                            throws ImportExportException,
                                   IOException

read protocol family list from XML

Parameters:

in -

Throws:

ImportExportException

IOException

fromXML

public ProtocolFamilyArray fromXML(InputStream in)
                            throws ImportExportException

read protocol family list from XML

Parameters:

in -

Throws:

ImportExportException

getFamiliesFilters

public List getFamiliesFilters()

get a list of protocol filters corresponding to the protocol families settings

getSignatureToFamilyMapping

public Map getSignatureToFamilyMapping(ProtocolFamilyArray families)

creates and returns a map of signature names to ProtocolFamily list. A key is a signature name the associated value is a list of families the signature is associated with.

getProtocolToFamilyMapping

public Map getProtocolToFamilyMapping()

creates and returns a map of protocol names to ProtocolFamily list. A key is a protocol name the associated value is a list of families the protocol is associated with.

fromStream

public void fromStream(BufferedReader in,
                       Formatter f)
                throws ImportExportException

Description copied from interface: Formattable

Method fromStream

Specified by:

fromStream in interface Formattable

Throws:

ImportExportException

toStream

public void toStream(PrintStream out,
                     Formatter f)

Description copied from interface: Formattable

Method toStream

Specified by:

toStream in interface Formattable

isDefaults

public boolean isDefaults()

is protocol families settings are the system defaults

Returns:

getServicesNamesByProtocolFamily

public String[] getServicesNamesByProtocolFamily(String familyName)

return service names array that associate with input family name

Parameters:

familyName -