org.apache.jetspeed.serializer
Interface JetspeedSerializer

public interface JetspeedSerializer

Jetspeed Serializer

The Serializer is capable of reading and writing the current content of the Jetspeed environment to and from XML files. The component can be used from a standalone java application for seeding a new database or from a running portal as an administrative backup/restore function.

The XML file needs to indicate whether passwords used in credentials are plain text or whether they are encoded. The import algoritm can determine - prior to reading users - which encode/decode scheme was used and if or then we store plain passwords (Note that that alone requires the resulting XML to be encoded!!!!!)

Version:

$Id: JetspeedSerializer.java 0 2006-10-31 22:51:28Z hjb $

Author:

Hajo Birthelmer

Field Summary

static short	DECODING_SUPPORTED the passwords are encoded and the provider is the same as the data source and we have a 2-way algorithm
static short	ERROR_DECODING Error in determening correct password handling
static short	INVALID_PASSWORDS the passwords are encoded and the current provider is DIFFERENT....
static String	KEY_BACKUP_BEFORE_PROCESS
static String	KEY_OVERWRITE_EXISTING
static String	KEY_PROCESS_CAPABILITIES
static String	KEY_PROCESS_ENTITIES export/import instructions secondary
static String	KEY_PROCESS_PERMISSIONS
static String	KEY_PROCESS_PORTAL_PREFERENCES
static String	KEY_PROCESS_PREFERENCES
static String	KEY_PROCESS_PROFILER
static String	KEY_PROCESS_USER_PREFERENCES
static String	KEY_PROCESS_USERS export/import instructions
static short	NO_DECODING the passwords are in clear text
static short	PASSTHRU_REQUIRED the passwords are encoded and the provider is the same as the data source, but is a 1-way algorithm
static String	TAG_SECONDARYSNAPSHOT
static String	TAG_SNAPSHOT the main tag in the XML file

Method Summary

void	closeUp() release the resources etc.
void	exportData(String name, String exportFileName, Map settings) Main routine to export the set of data elements and write them to the named XML file.
String	getDefaultIndent() Get the current indent setting for XML files
void	importData(String importFileName, Map settings) Main routine to import the set of data elements and write them to the current environment.
void	initializeComponentManager(String appRoot, String[] bootConfig, String[] appConfig) Create a component manager with the list of primary components (boot), the application components and the root path of the application
void	setComponentManager(ComponentManager cm) hand the serializer an existing component manager to access the environment
void	setDefaultIndent(String indent) Set the default indent for the XML output

Field Detail

ERROR_DECODING

static final short ERROR_DECODING

Error in determening correct password handling

See Also:

Constant Field Values

NO_DECODING

static final short NO_DECODING

the passwords are in clear text

See Also:

Constant Field Values

PASSTHRU_REQUIRED

static final short PASSTHRU_REQUIRED

the passwords are encoded and the provider is the same as the data source, but is a 1-way algorithm

See Also:

Constant Field Values

DECODING_SUPPORTED

static final short DECODING_SUPPORTED

the passwords are encoded and the provider is the same as the data source and we have a 2-way algorithm

See Also:

Constant Field Values

INVALID_PASSWORDS

static final short INVALID_PASSWORDS

the passwords are encoded and the current provider is DIFFERENT....

See Also:

Constant Field Values

KEY_PROCESS_USERS

static final String KEY_PROCESS_USERS

export/import instructions

KEY_PROCESS_CAPABILITIES

static final String KEY_PROCESS_CAPABILITIES

KEY_PROCESS_PROFILER

static final String KEY_PROCESS_PROFILER

KEY_PROCESS_PERMISSIONS

static final String KEY_PROCESS_PERMISSIONS

KEY_PROCESS_USER_PREFERENCES

static final String KEY_PROCESS_USER_PREFERENCES

KEY_PROCESS_PORTAL_PREFERENCES

static final String KEY_PROCESS_PORTAL_PREFERENCES

KEY_OVERWRITE_EXISTING

static final String KEY_OVERWRITE_EXISTING

KEY_BACKUP_BEFORE_PROCESS

static final String KEY_BACKUP_BEFORE_PROCESS

KEY_PROCESS_ENTITIES

static final String KEY_PROCESS_ENTITIES

export/import instructions secondary

KEY_PROCESS_PREFERENCES

static final String KEY_PROCESS_PREFERENCES

TAG_SNAPSHOT

static final String TAG_SNAPSHOT

the main tag in the XML file

See Also:

Constant Field Values

TAG_SECONDARYSNAPSHOT

static final String TAG_SECONDARYSNAPSHOT

See Also:

Constant Field Values

Method Detail

setComponentManager

void setComponentManager(ComponentManager cm)
                         throws SerializerException

hand the serializer an existing component manager to access the environment

Parameters:

cm -

Throws:

SerializerException

initializeComponentManager

void initializeComponentManager(String appRoot,
                                String[] bootConfig,
                                String[] appConfig)
                                throws SerializerException

Create a component manager with the list of primary components (boot), the application components and the root path of the application

Parameters:

appRoot - working directory

bootConfig - boot (primary) file or files (wildcards are allowed)

appConfig - application (secondary) file or files (wildcards are allowed)

Throws:

SerializerException

exportData

void exportData(String name,
                String exportFileName,
                Map settings)
                throws SerializerException

Main routine to export the set of data elements and write them to the named XML file. The default behavior of the serializer is that all available data is extracted and the target file gets created or overwritten

The caller can adjust the default behavior by passign in a map of flags. Each map entry is keyed by a key Constant and the associated Boolean value, for exammple KEY_PROCESS_USER_PREFERENCES, Boolean.FALSE would cause the serializer to skip user preferences.

Note that ProfilingRules require the users . Hence turning off User collection will automatically turn off the Profiling rules

Parameters:

name - of the snapshot

exportFileName -

settings - optional Map overwriting default export behavior

Throws:

SerializerException

importData

void importData(String importFileName,
                Map settings)
                throws SerializerException

Main routine to import the set of data elements and write them to the current environment. The default behavior of the serializer is that all available data is read and written to the current environment.

Existing entries (like users) etc. will be overwritten with the provided data.

The caller can adjust the default behavior by passign in a map of flags. Each map entry is keyed by a key Constant and the associated Boolean value, for exammple KEY_PROCESS_USER_PREFERENCES, Boolean.FALSE would cause the serializer to skip user preferences.

Note that settings are valid throughout each invocation. Therefore if a caller wants to preserve current users and only add new entries while at the same time overwrite all profiling rules, exportData has to be invoked twice - once to process only the users with the no-overwrite option and once to process the profiling rules

Parameters:

importFileName -

settings - optional Map overwriting default import behavior

Throws:

SerializerException

setDefaultIndent

void setDefaultIndent(String indent)

Set the default indent for the XML output

Parameters:

indent -

getDefaultIndent

String getDefaultIndent()

Get the current indent setting for XML files

Returns:

the current indent setting

closeUp

void closeUp()

release the resources etc.