| org.apache.jetspeed.serializer.JetspeedSerializer
All known Subclasses: org.apache.jetspeed.serializer.JetspeedSerializerImpl, org.apache.jetspeed.serializer.JetspeedSerializerSecondaryImpl,
| JetspeedSerializer | | public interface JetspeedSerializer (Code) | | 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!!!!!)
author:
Hajo Birthelmer
version:
$Id: JetspeedSerializer.java 0 2006-10-31 22:51:28Z hjb $ |
| DECODING_SUPPORTED | | final public static short DECODING_SUPPORTED(Code) | | the passwords are encoded and the provider is the same as the data source
and we have a 2-way algorithm
|
| ERROR_DECODING | | final public static short ERROR_DECODING(Code) | | Error in determening correct password handling
|
| INVALID_PASSWORDS | | final public static short INVALID_PASSWORDS(Code) | | the passwords are encoded and the current provider is DIFFERENT....
|
| KEY_BACKUP_BEFORE_PROCESS | | final public static String KEY_BACKUP_BEFORE_PROCESS(Code) | | |
| KEY_OVERWRITE_EXISTING | | final public static String KEY_OVERWRITE_EXISTING(Code) | | |
| KEY_PROCESS_CAPABILITIES | | final public static String KEY_PROCESS_CAPABILITIES(Code) | | |
| KEY_PROCESS_ENTITIES | | final public static String KEY_PROCESS_ENTITIES(Code) | | export/import instructions secondary
|
| KEY_PROCESS_PERMISSIONS | | final public static String KEY_PROCESS_PERMISSIONS(Code) | | |
| KEY_PROCESS_PORTAL_PREFERENCES | | final public static String KEY_PROCESS_PORTAL_PREFERENCES(Code) | | |
| KEY_PROCESS_PREFERENCES | | final public static String KEY_PROCESS_PREFERENCES(Code) | | |
| KEY_PROCESS_PROFILER | | final public static String KEY_PROCESS_PROFILER(Code) | | |
| KEY_PROCESS_USERS | | final public static String KEY_PROCESS_USERS(Code) | | export/import instructions
|
| KEY_PROCESS_USER_PREFERENCES | | final public static String KEY_PROCESS_USER_PREFERENCES(Code) | | |
| NO_DECODING | | final public static short NO_DECODING(Code) | | the passwords are in clear text
|
| PASSTHRU_REQUIRED | | final public static short PASSTHRU_REQUIRED(Code) | | the passwords are encoded and the provider is the same as the data
source, but is a 1-way algorithm
|
| TAG_SECONDARYSNAPSHOT | | final public static String TAG_SECONDARYSNAPSHOT(Code) | | |
| TAG_SNAPSHOT | | final public static String TAG_SNAPSHOT(Code) | | the main tag in the XML file
|
| closeUp | | public void closeUp()(Code) | | release the resources etc.
|
| exportData | | public void exportData(String name, String exportFileName, Map settings) throws SerializerException(Code) | | 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
Parameters:
exportFileName -
Parameters:
settings - optional Map overwriting default export behavior |
| getDefaultIndent | | public String getDefaultIndent()(Code) | | Get the current indent setting for XML files
the current indent setting |
| importData | | public void importData(String importFileName, Map settings) throws SerializerException(Code) | | 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 -
Parameters:
settings - optional Map overwriting default import behavior |
| initializeComponentManager | | public void initializeComponentManager(String appRoot, String[] bootConfig, String[] appConfig) throws SerializerException(Code) | | 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
Parameters:
bootConfig - boot (primary) file or files (wildcards are allowed)
Parameters:
appConfig - application (secondary) file or files (wildcards are allowed) a newly initiated component manager
throws:
SerializerException - |
| setDefaultIndent | | public void setDefaultIndent(String indent)(Code) | | Set the default indent for the XML output
Parameters:
indent - |
|
|