oracle.portal.provider.v2.transport
Class PrefStoreTransporter

java.lang.Object
  oracle.portal.provider.v2.transport.PrefStoreTransporter

public class PrefStoreTransporter
extends java.lang.Object

A PrefStoreTransporter is capable of exporting/importing data from/to a target PreferenceStore. The format of the data handled by a PrefStoreTransporter is versioned to facilitate backwards compatibility if new data formats are introduced.

Constructor Summary

PrefStoreTransporter(PreferenceStore prefStore)
Constructs a PrefStoreTransporter instance which will operate on the supplied PreferenceStore

Method Summary

byte[]	exportData(java.lang.String contextPath, java.util.List preferenceTypes, PreferenceFilter filter, TransportLogger logger) Exports the data set stored under the supplied context path in the preference store.
void	importData(java.lang.String contextPath, byte[] data, TransportLogger logger) Imports the supplied data set into the PreferenceStore under the supplied context path.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrefStoreTransporter

public PrefStoreTransporter(PreferenceStore prefStore)

Constructs a PrefStoreTransporter instance which will operate on the supplied PreferenceStore

Parameters:

prefStore - the target PreferenceStore.

Method Detail

exportData

public byte[] exportData(java.lang.String contextPath,
                         java.util.List preferenceTypes,
                         PreferenceFilter filter,
                         TransportLogger logger)
                  throws PreferenceStoreException,
                         java.io.IOException

Exports the data set stored under the supplied context path in the preference store. The supplied PreferenceFilter will be employed to select a subset of data stored under the context path.

Parameters:

contextPath - the context path under which the target data is stored in the preference store.

filter - a PreferenceFilter which will be used to query the preference store. If null all data for stored under the supplied context path will be exported.

logger - the appropriate TransportLogger to use for communicating messages back to the export initiator.

Returns:

a byte[] containing the exported data set.

Throws:

PreferenceStoreException

java.io.IOException

importData

public void importData(java.lang.String contextPath,
                       byte[] data,
                       TransportLogger logger)
                throws PreferenceStoreException,
                       java.io.IOException

Imports the supplied data set into the PreferenceStore under the supplied context path. Existing data will not be overwritten for that context if overwrite is false.

Parameters:

contextPath - the context under which data will be imported into the PreferenceStore.

data - the data set to import.

logger - the appropriate TransportLogger to use for communicating messages back to the import initiator.

Throws:

PreferenceStoreException

java.io.IOException