com.pcube.apps.engage.policy
Class ProtocolFamiliesManager

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

All Implemented Interfaces:

Formattable

public class ProtocolFamiliesManager
extends java.lang.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 int	APPSTORES_FAMILYID
static int	IMESSAGE_FAMILYID
static java.lang.String	SAPM_DETECTED_PROTOCOL_FAMILY
static int	VIDEOMONITORING_FAMILYID
static int	WHATSAPP_FAMILYID
static java.lang.String	XML_ATT_NAME
static java.lang.String	XML_TAG_SIGNATURE_SET

Method Summary

static void	addFamilyFilter(Policy policy, java.lang.String familyNames, int id)
void	addProtocolFamilyFilterMapping()
void	addSignatureProtocolMapping()
static boolean	addSignaturesToFamiliesFilter(Policy policy, java.lang.String protocolName, java.lang.String[] signatureNames, int id)
void	addSignatureToFamilies(java.lang.String s, java.util.List families)
void	fromStream(java.io.BufferedReader in, Formatter f) Method fromStream
ProtocolFamilyArray	fromXML(java.io.File in) read protocol family list from XML
ProtocolFamilyArray	fromXML(java.io.InputStream in) read protocol family list from XML
ProtocolFamilyArray	fromXML(java.lang.String xml) read protocol family list from XML
ProtocolFamilyArray	getDefaultEngageSettings() get Engage Default ProtocolFamilies Settings
java.util.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
java.util.Map	getProtocolToFamilyMapping() creates and returns a map of protocol names to ProtocolFamily list.
java.lang.String[]	getServicesNamesByProtocolFamily(java.lang.String familyName) return service names array that associate with input family name
java.util.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(java.io.PrintStream out, Formatter f) Method toStream
java.lang.String	toXML() convert to XML text the current protocol families
java.lang.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 java.lang.String XML_ATT_NAME

See Also:

Constant Field Values

XML_TAG_SIGNATURE_SET

public static final java.lang.String XML_TAG_SIGNATURE_SET

See Also:

Constant Field Values

SAPM_DETECTED_PROTOCOL_FAMILY

public static final java.lang.String SAPM_DETECTED_PROTOCOL_FAMILY

See Also:

Constant Field Values

APPSTORES_FAMILYID

public static final int APPSTORES_FAMILYID

See Also:

Constant Field Values

WHATSAPP_FAMILYID

public static final int WHATSAPP_FAMILYID

See Also:

Constant Field Values

IMESSAGE_FAMILYID

public static final int IMESSAGE_FAMILYID

See Also:

Constant Field Values

VIDEOMONITORING_FAMILYID

public static final int VIDEOMONITORING_FAMILYID

See Also:

Constant Field Values

Method Detail

restoreDefaults

public void restoreDefaults()

getDefaultEngageSettings

public ProtocolFamilyArray getDefaultEngageSettings()

get Engage Default ProtocolFamilies Settings

addSignatureToFamilies

public void addSignatureToFamilies(java.lang.String s,
                                   java.util.List families)

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 java.lang.String toXML()

convert to XML text the current protocol families

Parameters:

doc -

Returns:

toXML

public java.lang.String toXML(ProtocolFamilyArray families)

convert to XML text the specified protocol families

Returns:

fromXML

public ProtocolFamilyArray fromXML(java.lang.String xml)
                            throws ImportExportException

read protocol family list from XML

Parameters:

in -

Throws:

ImportExportException

fromXML

public ProtocolFamilyArray fromXML(java.io.File in)
                            throws ImportExportException,
                                   java.io.IOException

read protocol family list from XML

Parameters:

in -

Throws:

ImportExportException

java.io.IOException

fromXML

public ProtocolFamilyArray fromXML(java.io.InputStream in)
                            throws ImportExportException

read protocol family list from XML

Parameters:

in -

Throws:

ImportExportException

getFamiliesFilters

public java.util.List getFamiliesFilters()

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

getSignatureToFamilyMapping

public java.util.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 java.util.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(java.io.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(java.io.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 java.lang.String[] getServicesNamesByProtocolFamily(java.lang.String familyName)

return service names array that associate with input family name

Parameters:

familyName -

addSignatureProtocolMapping

public void addSignatureProtocolMapping()
                                 throws DuplicateItemException

Throws:

DuplicateItemException

addFamilyFilter

public static void addFamilyFilter(Policy policy,
                                   java.lang.String familyNames,
                                   int id)
                            throws DuplicateItemException

Throws:

DuplicateItemException

addSignaturesToFamiliesFilter

public static boolean addSignaturesToFamiliesFilter(Policy policy,
                                                    java.lang.String protocolName,
                                                    java.lang.String[] signatureNames,
                                                    int id)
                                             throws DuplicateItemException

Throws:

DuplicateItemException

addProtocolFamilyFilterMapping

public void addProtocolFamilyFilterMapping()
                                    throws DuplicateItemException

Throws:

DuplicateItemException