|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IBufferStore
This interface defines the way a storage based IBuffer
holder behaves in order to provide permanent storage
to a set of incoming locators. Based on the order specified using the IBufferStore.MultiplexType
, the data of the incoming
IBuffer
s are persisted using the technology chosen by the interface implementations. The data persisted through
this procedure are accessible to recreate a new IBuffer
using the BufferStoreReader
Nested Class Summary | |
---|---|
static class |
IBufferStore.MultiplexType
Indicates the way that the incoming locators are read and their data persisted in the underlying storage device |
Method Summary | |
---|---|
void |
associateStoreReader(BufferStoreReader reader)
Associates a BufferStoreReader with the IBufferStore that is has been initialized to access. |
void |
dispose()
Disposes all the resources that are internally managed by the IBufferStore |
java.util.ArrayList<BufferStoreEntry> |
getEntries()
Retrieves the BufferStoreEntry s that represent the status for all incoming locators and their respective
readers and status as well as their persistency location and IRecordStore s |
long |
getInactivityTimeout()
The timeout of the inactivity period after which the IBufferStore is eligible for disposal. |
java.util.concurrent.TimeUnit |
getInactivityTimeUnit()
The time unit used to define the timeout of the inactivity period after which the IBufferStore is
eligible for disposal. |
java.lang.String |
getKey()
Retrieves the key by which this IBufferStore is registered and referenced through a GRSRegistry |
long |
getLastActivityTime()
Retrieves the last activity time over this IBufferStore |
java.net.URI[] |
getLocators()
Retrieves the locators over which the IBufferStore operates |
java.lang.Object |
getModificationObject()
Retrieves a synchronization object that can be used in a standard wait / notify block to notify requesters of when an additional object has been made available in the underlying storage from the input readers |
IBufferStore.MultiplexType |
getMultiplexType()
Retrieves the IBufferStore.MultiplexType indicating the way the input locators are used and in which order their data is received |
long |
getReaderTimeout()
Retrieves the timeout that should be used by the readers utilized to access the input locators. |
java.util.concurrent.TimeUnit |
getReaderTimeoutTimeUnit()
Retrieves the timeout unit that should be used by the readers utilized to access the input locators. |
void |
initialize()
Make any needed initialization before the store() is called to start the storing procedure |
void |
markActivity()
Update the last activity time to the current time |
void |
setKey(java.lang.String key)
Sets the key by which this IBufferStore is registered and referenced through a GRSRegistry |
void |
setLocators(java.net.URI[] locators)
Sets the incoming locators that should be stored |
void |
setMultiplexType(IBufferStore.MultiplexType multiplex)
Sets the IBufferStore.MultiplexType indicating the way the input locators are used and in which order their data is received |
void |
setReaderTimeout(long timeout)
Sets the timeout that should be used by the readers utilized to access the input locators. |
void |
setReaderTimeoutTimeUnit(java.util.concurrent.TimeUnit unit)
Sets the timeout unit that should be used by the readers utilized to access the input locators. |
void |
store()
Start retrieving data from the input locators and storing them according to the specific IBufferStore implementation |
Method Detail |
---|
void associateStoreReader(BufferStoreReader reader)
BufferStoreReader
with the IBufferStore
that is has been initialized to access. On
disposal of the IBufferStore
, the associated BufferStoreReader
s are also disposed
reader
- the reader to associatevoid setKey(java.lang.String key)
IBufferStore
is registered and referenced through a GRSRegistry
key
- the keyjava.lang.String getKey()
IBufferStore
is registered and referenced through a GRSRegistry
java.lang.Object getModificationObject()
IBufferStore.MultiplexType getMultiplexType()
IBufferStore.MultiplexType
indicating the way the input locators are used and in which order their data is received
void setMultiplexType(IBufferStore.MultiplexType multiplex) throws GRS2BufferStoreException
IBufferStore.MultiplexType
indicating the way the input locators are used and in which order their data is received
multiplex
- the type of multiplex
GRS2BufferStoreException
- The status of the IBufferStore
does not allow this operation to be completedjava.net.URI[] getLocators()
IBufferStore
operates
void setLocators(java.net.URI[] locators) throws GRS2BufferStoreException
locators
- the locators which data should be stored
GRS2BufferStoreException
- The status of the IBufferStore
does not allow this operation to be completedjava.util.ArrayList<BufferStoreEntry> getEntries()
BufferStoreEntry
s that represent the status for all incoming locators and their respective
readers and status as well as their persistency location and IRecordStore
s
long getReaderTimeout()
getReaderTimeoutTimeUnit()
void setReaderTimeout(long timeout)
setReaderTimeoutTimeUnit(TimeUnit)
timeout
- the timeoutjava.util.concurrent.TimeUnit getReaderTimeoutTimeUnit()
getReaderTimeout()
void setReaderTimeoutTimeUnit(java.util.concurrent.TimeUnit unit)
setReaderTimeout(long)
unit
- the timeout time unitlong getInactivityTimeout()
IBufferStore
is eligible for disposal. This
value is to be interpreted in conjunction with the value of getInactivityTimeUnit()
java.util.concurrent.TimeUnit getInactivityTimeUnit()
IBufferStore
is
eligible for disposal. This value is to be interpreted in conjunction with the value of
getInactivityTimeout()
long getLastActivityTime()
IBufferStore
void markActivity()
void initialize() throws GRS2BufferStoreException
store()
is called to start the storing procedure
GRS2BufferStoreException
- The initialization could not be performedvoid store()
IBufferStore
implementation
void dispose()
IBufferStore
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |