|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISerializationManager2
Manager interface for portal objects serialization and deserialization
Field Summary | |
---|---|
static String |
ATTRIBUTE_DESERIALIZING
Attribute set in the transaction indicating that deserialization is in execution. |
static String |
ATTRIBUTE_SERIALIZING
Attribute set in the transaction indicating that serialization is in execution. |
Method Summary | ||
---|---|---|
void |
beginDeserializeChannel(DeserializationContext deserializationContext)
Deserialize a channel from a xml file asynchronously. |
|
void |
beginSerializeChannel(SerializationContext serializationContext)
Serialize a channel to a xml file asynchronously. |
|
String |
deserializeChannel(DeserializationContext deserializationContext)
Deserialize a channel from a xml file. |
|
|
deserializeObject(Class<T> objectClass,
IDirectory directory,
String filePath,
String alias,
boolean fileIsOptional)
|
|
|
deserializeObject(Class<T> objectClass,
IDirectory directory,
String filePath,
String alias,
ISerializer serializer,
boolean fileIsOptional)
Deserializes an object from a file in a directory. |
|
|
deserializeObject(Class<T> objectClass,
IDirectory directory,
String filePath,
String alias,
SerializationSettings serializationSettings,
boolean fileIsOptional)
|
|
void |
deserializePage(DeserializationContext deserializationContext,
String pageId,
boolean setupSerializationContext,
boolean checkUnresolvedDependencies)
Deserialize a page from a xml file. |
|
SerializationSettings |
getExternalDependenciesSerializationSettings()
Deprecated. |
|
void |
serializeChannel(SerializationContext serializationContext)
Serialize a channel to a xml file. |
|
void |
serializeMap(Map<String,String> map,
IDirectory directory,
String filePath,
String alias)
Serializes a Map object where the name and value are of type String. |
|
void |
serializeObject(Object o,
IDirectory directory,
String filePath,
String alias)
|
|
void |
serializeObject(Object object,
IDirectory directory,
String filePath,
String alias,
ISerializer serializer)
Serializes an object to a file in a directory. |
|
void |
serializeObject(Object o,
IDirectory directory,
String filePath,
String alias,
SerializationSettings serializationSettings)
|
|
String |
serializeObjectToString(Object o,
String alias)
Serialize an object to a xml String. |
|
String |
serializeObjectToString(Object o,
String alias,
ISerializer serializer)
Serialize an object to a xml String, using a given XStream object |
|
String |
serializeObjectToString(Object o,
String alias,
SerializationSettings serializationSettings)
Serialize an object to a xml String, using custom serialization settings |
|
void |
serializePage(SerializationContext serializationContext,
String pageId,
boolean setupSerializationContext)
Serialize a page to a xml file. |
Field Detail |
---|
static final String ATTRIBUTE_SERIALIZING
static final String ATTRIBUTE_DESERIALIZING
Method Detail |
---|
void serializeChannel(SerializationContext serializationContext) throws ManagerException, PortalException
serializationContext
- context object that contains all operation settings
ManagerException
PortalException
void beginSerializeChannel(SerializationContext serializationContext) throws ManagerException, PortalException
serializationContext
- context object that contains all operation settings
ManagerException
PortalException
String deserializeChannel(DeserializationContext deserializationContext) throws ManagerException, PortalException
deserializationContext
- context object that contains all operation settings
ManagerException
PortalException
void beginDeserializeChannel(DeserializationContext deserializationContext) throws ManagerException, PortalException
deserializationContext
- context object that contains all operation settings
ManagerException
PortalException
void serializePage(SerializationContext serializationContext, String pageId, boolean setupSerializationContext) throws ManagerException, PortalException
serializationContext
- context object that contains all operation settingspageId
- page to be serializedsetupSerializationContext
- indicates if the serialization settings must be set before the operation
ManagerException
PortalException
void deserializePage(DeserializationContext deserializationContext, String pageId, boolean setupSerializationContext, boolean checkUnresolvedDependencies) throws ManagerException, PortalException
deserializationContext
- context object that contains all operation settingspageId
- page to be deserializedsetupSerializationContext
- indicates if the serialization settings must be set before the operationcheckUnresolvedDependencies
- indicates when the existence of unresolved dependencies must raise a SerializationException
ManagerException
PortalException
String serializeObjectToString(Object o, String alias) throws SerializationException
o
- object to be serializedalias
- alias (tag name) for the object
SerializationException
String serializeObjectToString(Object o, String alias, SerializationSettings serializationSettings) throws SerializationException
o
- object to be serializedalias
- alias (tag name) for the objectserializationSettings
- serialization settings for the operation
SerializationException
String serializeObjectToString(Object o, String alias, ISerializer serializer) throws SerializationException
o
- object to be serializedalias
- alias (tag name) for the object.serializer
- the object serializer instance.
SerializationException
void serializeObject(Object o, IDirectory directory, String filePath, String alias) throws SerializationException
SerializationException
void serializeObject(Object o, IDirectory directory, String filePath, String alias, SerializationSettings serializationSettings) throws SerializationException
SerializationException
void serializeObject(Object object, IDirectory directory, String filePath, String alias, ISerializer serializer) throws SerializationException
object
- the object.directory
- the directory.filePath
- the file path in the directory.alias
- the alias for the object.serializer
- the object serializer instance.
SerializationException
void serializeMap(Map<String,String> map, IDirectory directory, String filePath, String alias) throws SerializationException
map
- the map object to be serialized.directory
- the directory objecto to be serialized to.filePath
- the file path within the directory.alias
- alias to use for the Map object.
SerializationException
<T> T deserializeObject(Class<T> objectClass, IDirectory directory, String filePath, String alias, SerializationSettings serializationSettings, boolean fileIsOptional) throws SerializationException
SerializationException
<T> T deserializeObject(Class<T> objectClass, IDirectory directory, String filePath, String alias, boolean fileIsOptional) throws SerializationException
SerializationException
<T> T deserializeObject(Class<T> objectClass, IDirectory directory, String filePath, String alias, ISerializer serializer, boolean fileIsOptional) throws SerializationException
T
- the object type.objectClass
- the object class type.directory
- the directory.filePath
- the file path in the directory.alias
- the alias for the object.serializer
- the object serializer instance.fileIsOptional
- if true
, the file may not exist,
which causes the return to be null
.
null
if
fileIsOptional
is true and the file is not found.
SerializationException
@Deprecated SerializationSettings getExternalDependenciesSerializationSettings()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |