|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jackrabbit.core.state.AbstractPersistenceManager
org.apache.jackrabbit.core.state.obj.ObjectPersistenceManager
ObjectPersistenceManager
is a FileSystem
-based
PersistenceManager
that persists ItemState
and NodeReferences
objects using a simple custom serialization
format.
Constructor Summary | |
ObjectPersistenceManager()
Creates a new ObjectPersistenceManager instance. |
Method Summary | |
void |
close()
Closes the persistence manager. The consistency of the persistent storage is guaranteed and all acquired resources are released. It is an error to invoke any methods on a closed persistence manager, and implementations are free to enforce this constraint by throwing IllegalStateExceptions in such cases. An appropriate exception is thrown if the persistence manager could not be closed properly. In this case the state of the persistence manager is undefined and the instance should be discarded. |
static void |
deserialize(NodeReferences refs,
InputStream stream)
Deserializes a NodeReferences object from the given
stream . |
static void |
deserialize(NodeState state,
InputStream stream)
Deserializes a state object from the given stream . |
static void |
deserialize(PropertyState state,
InputStream stream,
BLOBStore blobStore)
Deserializes a state object from the given stream . |
protected void |
destroy(NodeReferences refs)
Destroy a node references object. Subclass responsibility. |
protected void |
destroy(NodeState state)
Destroy a node state. Subclass responsibility. |
protected void |
destroy(PropertyState state)
Destroy a property state. Subclass responsibility. |
boolean |
exists(NodeId id)
Checks whether the identified node exists. |
boolean |
exists(NodeReferencesId id)
Checks whether references of the identified target node exist. |
boolean |
exists(PropertyId id)
Checks whether the identified property exists. |
FileSystemResource |
get(String blobId)
|
void |
init(PMContext context)
Initializes the persistence manager. The persistence manager is permanently bound to the given context, and any required external resources are acquired. An appropriate exception is thrown if the persistence manager initialization fails for whatever reason. In this case the state of the persistence manager is undefined and the instance should be discarded. |
NodeState |
load(NodeId id)
Load the persistent members of a node state. |
NodeReferences |
load(NodeReferencesId id)
Load the persistent members of a node references object. |
PropertyState |
load(PropertyId id)
Load the persistent members of a property state. |
String |
put(PropertyId id,
int index,
InputStream in,
long size)
|
boolean |
remove(String blobId)
|
static void |
serialize(NodeReferences refs,
OutputStream stream)
Serializes the specified NodeReferences object to the given
stream . |
static void |
serialize(NodeState state,
OutputStream stream)
Serializes the specified state object to the given
stream . |
static void |
serialize(PropertyState state,
OutputStream stream,
BLOBStore blobStore)
Serializes the specified state object to the given
stream . |
protected void |
store(NodeReferences refs)
Store a references object. Subclass responsibility. |
protected void |
store(NodeState state)
Store a node state. Subclass responsibility. |
protected void |
store(PropertyState state)
Store a property state. Subclass responsibility. |
Methods inherited from class org.apache.jackrabbit.core.state.AbstractPersistenceManager |
createNew, createNew, store |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ObjectPersistenceManager()
ObjectPersistenceManager
instance.
Method Detail |
public static void serialize(NodeState state, OutputStream stream) throws Exception
state
object to the given
stream
.
state
- state
to serializestream
- the stream where the state
should be serialized to
Exception
- if an error occurs during the serializationdeserialize(NodeState, InputStream)
public static void deserialize(NodeState state, InputStream stream) throws Exception
state
object from the given stream
.
state
- state
to deserializestream
- the stream where the state
should be deserialized from
Exception
- if an error occurs during the deserializationserialize(NodeState, OutputStream)
public static void serialize(PropertyState state, OutputStream stream, BLOBStore blobStore) throws Exception
state
object to the given
stream
.
state
- state
to serializestream
- the stream where the state
should be serialized toblobStore
- handler for blob data
Exception
- if an error occurs during the serializationdeserialize(PropertyState, InputStream, BLOBStore)
public static void deserialize(PropertyState state, InputStream stream, BLOBStore blobStore) throws Exception
state
object from the given stream
.
state
- state
to deserializestream
- the stream where the state
should be deserialized fromblobStore
- handler for blob data
Exception
- if an error occurs during the deserializationserialize(PropertyState, OutputStream, BLOBStore)
public static void serialize(NodeReferences refs, OutputStream stream) throws IOException
NodeReferences
object to the given
stream
.
refs
- object to serializestream
- the stream where the object should be serialized to
IOException
- if an error occurs during the serializationdeserialize(NodeReferences, InputStream)
public static void deserialize(NodeReferences refs, InputStream stream) throws Exception
NodeReferences
object from the given
stream
.
refs
- object to deserializestream
- the stream where the object should be deserialized from
Exception
- if an error occurs during the deserializationserialize(NodeReferences, OutputStream)
public FileSystemResource get(String blobId) throws Exception
get
in interface BLOBStore
blobId
-
Exception
public String put(PropertyId id, int index, InputStream in, long size) throws Exception
put
in interface BLOBStore
id
- id of the property associated with the blob dataindex
- subscript of the value holding the blob datain
- size
-
Exception
public boolean remove(String blobId) throws Exception
remove
in interface BLOBStore
blobId
-
Exception
public void init(PMContext context) throws Exception
An appropriate exception is thrown if the persistence manager initialization fails for whatever reason. In this case the state of the persistence manager is undefined and the instance should be discarded.
init
in interface PersistenceManager
context
- persistence manager context
Exception
- if the persistence manager intialization failedpublic void close() throws Exception
An appropriate exception is thrown if the persistence manager could not be closed properly. In this case the state of the persistence manager is undefined and the instance should be discarded.
close
in interface PersistenceManager
Exception
- if the persistence manager failed to close properlypublic NodeState load(NodeId id) throws NoSuchItemStateException, ItemStateException
load
in interface PersistenceManager
id
- node id
ItemStateException
- if another error occurs
NoSuchItemStateException
- if the node state does not existpublic PropertyState load(PropertyId id) throws NoSuchItemStateException, ItemStateException
load
in interface PersistenceManager
id
- property id
ItemStateException
- if another error occurs
NoSuchItemStateException
- if the property state does not existpublic NodeReferences load(NodeReferencesId id) throws NoSuchItemStateException, ItemStateException
load
in interface PersistenceManager
id
- reference target node id
NoSuchItemStateException
- if the target node does not exist
ItemStateException
- if another error occursprotected void store(NodeState state) throws ItemStateException
store
in class AbstractPersistenceManager
state
- node state to store
ItemStateException
- if an error occursprotected void store(PropertyState state) throws ItemStateException
store
in class AbstractPersistenceManager
state
- property state to store
ItemStateException
- if an error occursprotected void store(NodeReferences refs) throws ItemStateException
store
in class AbstractPersistenceManager
refs
- references object to store
ItemStateException
- if an error occursprotected void destroy(NodeState state) throws ItemStateException
destroy
in class AbstractPersistenceManager
state
- node state to destroy
ItemStateException
- if an error occursprotected void destroy(PropertyState state) throws ItemStateException
destroy
in class AbstractPersistenceManager
state
- property state to destroy
ItemStateException
- if an error occursprotected void destroy(NodeReferences refs) throws ItemStateException
destroy
in class AbstractPersistenceManager
refs
- node references object to destroy
ItemStateException
- if an error occurspublic boolean exists(PropertyId id) throws ItemStateException
exists
in interface PersistenceManager
id
- property id
true
if the property exists,
false
otherwise
ItemStateException
- on persistence manager errorspublic boolean exists(NodeId id) throws ItemStateException
exists
in interface PersistenceManager
id
- node id
true
if the node exists,
false
otherwise
ItemStateException
- on persistence manager errorspublic boolean exists(NodeReferencesId id) throws ItemStateException
exists
in interface PersistenceManager
id
- target node id
true
if the references exist,
false
otherwise
ItemStateException
- on persistence manager errors
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |