com.pcube.apps.engage.common
Class ImportExportUtils

java.lang.Object
  com.pcube.apps.engage.common.ImportExportUtils

public class ImportExportUtils
extends java.lang.Object

A manager for import/export actions. Import/Export can be to a CSV format, tab delimiter format or an XML format. Each function recieves the formatter which can one of the ImportExportFactory static members - #CSV_FORMATTER, #TAB_DELIMITED_FORMATTER or #XML_FORMATTER.

Author:

Field Summary

static Formatter

XML_FORMATTER Deprecated. not thread safe, use new XMLFormatter() isntead.

Method Summary

static void	exportPolicy(Policy policy, java.io.File f) exports the specified policy to the specified file.
static void	exportPolicy(Policy policy, Formatter formatter, java.io.PrintStream out) Exports the Policy.
static Formatter	getXmlFormatterInstance()
static Policy	importPolicy(java.io.File f) Imports a policy from the specified file.
static Policy	importPolicy(Formatter formatter, java.io.InputStream in) Imports a Policy.
static Policy	importPolicy(Formatter formatter, java.io.InputStream in, boolean importDefaultDss) Imports a Policy.
static void	loadFlavors(Policy policy, FlavorType flavorType, java.io.File file)
static void	loadFlavors(Policy policy, FlavorType flavorType, java.io.InputStream inStream)
static void	loadHttpRefererFlavorsFromEasyFormat(Policy policy, java.io.File file)
static void	loadHttpUrlFlavorsFromEasyFormat(Policy policy, java.io.File file)
static void	loadListArray(Policy policy, java.io.InputStream inStream) Deprecated. This function is deprecated - only used for 2.57 host list and ip list It converts the 2.57 csv file of lists into 3.0 HTTP URL flavor for the 2.57 host lists and zone list for the 2.57 ip lists. For loading 3.0 csv files please use the functions #loadFlavors and #loadZones
static void	loadProtocols(Policy policy, java.io.File file)
static void	loadProtocols(Policy policy, java.io.InputStream inStream)
static void	loadServices(Policy policy, java.io.File file)
static void	loadServices(Policy policy, java.io.InputStream inStream)
static void	loadZones(Policy policy, java.io.File file)
static void	loadZones(Policy policy, java.io.InputStream inStream)
static void	loadZonesFromEasyFormat(Policy policy, java.io.File file)
static void	saveFlavors(java.util.List flavors, FlavorType flavorType, java.io.File file)
static void	saveFlavors(java.util.List flavors, FlavorType flavorType, java.io.OutputStream outStream)
static void	saveFlavorsToEasyFormat(java.util.List flavors, java.io.File file)
static void	saveProtocols(java.util.List protocols, java.io.File file)
static void	saveProtocols(java.util.List protocols, java.io.OutputStream outStream)
static void	saveServices(java.io.File file, Policy policy)
static void	saveServices(Policy policy, java.io.OutputStream outStream)
static void	saveZones(java.util.List zones, java.io.File file)
static void	saveZones(java.util.List zones, java.io.OutputStream outStream)
static void	saveZonesToEasyFormat(java.util.List zones, java.io.File file)
static int	validateZoneSize(Policy policy)

Methods inherited from class java.lang.Object

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

Field Detail

XML_FORMATTER

public static final Formatter XML_FORMATTER

Deprecated. not thread safe, use new XMLFormatter() isntead.

A formatter used to import/export an XML format.

Method Detail

exportPolicy

public static void exportPolicy(Policy policy,
                                java.io.File f)
                         throws java.io.FileNotFoundException,
                                ImportExportException

exports the specified policy to the specified file.

Parameters:

policy -

f -

Throws:

java.io.FileNotFoundException

ImportExportException

exportPolicy

public static void exportPolicy(Policy policy,
                                Formatter formatter,
                                java.io.PrintStream out)
                         throws ImportExportException

Exports the Policy.

Parameters:

policy - the Policy to export

formatter - the exported format

out - the PrintStream to export to

Throws:

ImportExportException - if an error occurs during export

getXmlFormatterInstance

public static Formatter getXmlFormatterInstance()

Returns:

importPolicy

public static Policy importPolicy(java.io.File f)
                           throws ImportExportException,
                                  java.io.IOException

Imports a policy from the specified file.

Parameters:

f -

Returns:

the imported policy

Throws:

ImportExportException

java.io.IOException

importPolicy

public static Policy importPolicy(Formatter formatter,
                                  java.io.InputStream in)
                           throws ImportExportException

Imports a Policy.

Parameters:

formatter - the import format

in - the BufferedReader to import from

Returns:

the imported Policy

Throws:

ImportExportException - the importExportExceptions wraps the exceptions which are thrown along the import process

importPolicy

public static Policy importPolicy(Formatter formatter,
                                  java.io.InputStream in,
                                  boolean importDefaultDss)
                           throws ImportExportException

Imports a Policy.

Parameters:

formatter - the import format

in - the BufferedReader to import from

Returns:

the imported Policy

Throws:

ImportExportException - the importExportExceptions wraps the exceptions which are thrown along the import process

loadFlavors

public static void loadFlavors(Policy policy,
                               FlavorType flavorType,
                               java.io.File file)
                        throws ImportExportException

Parameters:

policy -

flavorType -

file -

Throws:

ImportExportException

loadFlavors

public static void loadFlavors(Policy policy,
                               FlavorType flavorType,
                               java.io.InputStream inStream)
                        throws ImportExportException

Parameters:

policy -

flavorType -

inStream -

Throws:

ImportExportException

loadHttpUrlFlavorsFromEasyFormat

public static void loadHttpUrlFlavorsFromEasyFormat(Policy policy,
                                                    java.io.File file)
                                             throws ImportExportException

Parameters:

policy -

file -

Throws:

ImportExportException

loadHttpRefererFlavorsFromEasyFormat

public static void loadHttpRefererFlavorsFromEasyFormat(Policy policy,
                                                        java.io.File file)
                                                 throws ImportExportException

Parameters:

policy -

file -

Throws:

ImportExportException

loadZones

public static void loadZones(Policy policy,
                             java.io.File file)
                      throws ImportExportException

Parameters:

policy -

file -

Throws:

ImportExportException

loadZones

public static void loadZones(Policy policy,
                             java.io.InputStream inStream)
                      throws ImportExportException

Parameters:

policy -

inStream -

Throws:

ImportExportException

loadZonesFromEasyFormat

public static void loadZonesFromEasyFormat(Policy policy,
                                           java.io.File file)
                                    throws ImportExportException

Parameters:

policy -

file -

Throws:

ImportExportException

validateZoneSize

public static int validateZoneSize(Policy policy)

loadProtocols

public static void loadProtocols(Policy policy,
                                 java.io.File file)
                          throws ImportExportException

Parameters:

policy -

file -

Throws:

ImportExportException

loadProtocols

public static void loadProtocols(Policy policy,
                                 java.io.InputStream inStream)
                          throws ImportExportException

Parameters:

policy -

inStream -

Throws:

ImportExportException

loadServices

public static void loadServices(Policy policy,
                                java.io.File file)
                         throws ImportExportException

Parameters:

policy -

file -

Throws:

ImportExportException

loadServices

public static void loadServices(Policy policy,
                                java.io.InputStream inStream)
                         throws ImportExportException

Parameters:

policy -

inStream -

Throws:

ImportExportException

saveProtocols

public static void saveProtocols(java.util.List protocols,
                                 java.io.File file)
                          throws ImportExportException

Parameters:

protocols -

file -

Throws:

ImportExportException

saveProtocols

public static void saveProtocols(java.util.List protocols,
                                 java.io.OutputStream outStream)
                          throws ImportExportException

Parameters:

protocols -

outStream -

Throws:

ImportExportException

saveZones

public static void saveZones(java.util.List zones,
                             java.io.File file)
                      throws ImportExportException

Parameters:

zones -

file -

Throws:

ImportExportException

saveZones

public static void saveZones(java.util.List zones,
                             java.io.OutputStream outStream)
                      throws ImportExportException

Parameters:

zones -

outStream -

Throws:

ImportExportException

saveZonesToEasyFormat

public static void saveZonesToEasyFormat(java.util.List zones,
                                         java.io.File file)
                                  throws ImportExportException

Parameters:

zones -

file -

Throws:

ImportExportException

saveFlavors

public static void saveFlavors(java.util.List flavors,
                               FlavorType flavorType,
                               java.io.File file)
                        throws ImportExportException

Parameters:

flavors -

flavorType -

file -

Throws:

ImportExportException

saveFlavors

public static void saveFlavors(java.util.List flavors,
                               FlavorType flavorType,
                               java.io.OutputStream outStream)
                        throws ImportExportException

Parameters:

flavors -

flavorType -

outStream -

Throws:

ImportExportException

saveFlavorsToEasyFormat

public static void saveFlavorsToEasyFormat(java.util.List flavors,
                                           java.io.File file)
                                    throws ImportExportException

Parameters:

flavors -

file -

Throws:

ImportExportException

saveServices

public static void saveServices(java.io.File file,
                                Policy policy)
                         throws ImportExportException

Parameters:

file -

policy -

Throws:

ImportExportException

saveServices

public static void saveServices(Policy policy,
                                java.io.OutputStream outStream)
                         throws ImportExportException

Parameters:

policy -

outStream -

Throws:

ImportExportException

loadListArray

public static void loadListArray(Policy policy,
                                 java.io.InputStream inStream)
                          throws ImportExportException

Deprecated. This function is deprecated - only used for 2.57 host list and ip list It converts the 2.57 csv file of lists into 3.0 HTTP URL flavor for the 2.57 host lists and zone list for the 2.57 ip lists. For loading 3.0 csv files please use the functions #loadFlavors and #loadZones

Throws:

ImportExportException