|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xmlBlaster.engine.queuemsg.SubscribeEntry
public class SubscribeEntry
SubscribeEntry
Field Summary | |
---|---|
private java.lang.String |
key
|
private java.lang.String |
qos
|
private static long |
serialVersionUID
|
private java.lang.String |
sessionName
|
private long |
size
|
private Timestamp |
sortTimestamp
|
private StorageId |
storageId
|
private boolean |
stored
|
private boolean |
swapped
|
private long |
uniqueId
|
private java.lang.String |
uniqueIdStr
|
Constructor Summary | |
---|---|
SubscribeEntry(java.lang.String key,
java.lang.String qos,
java.lang.String sessionName,
long uniqueId,
long size,
StorageId storageId)
this constructor should be used by factories |
Method Summary | |
---|---|
void |
added(StorageId storageId)
Notification if this entry is added to storage. |
void |
embeddedObjectToXml(java.io.OutputStream out,
java.util.Properties props)
Dump content to xml representation |
java.lang.Object |
getEmbeddedObject()
gets the content of this queue entry (the embedded object). |
java.lang.String |
getEmbeddedType()
Gets the type of the object embedded in this entry, how the object is serialized. |
java.lang.String |
getKey()
|
java.lang.String |
getLogId()
Return a human readable identifier for logging output. |
XBMeat |
getMeat()
For the new queues |
int |
getPriority()
Allows to query the priority of this entry. |
java.lang.String |
getQos()
|
XBRef |
getRef()
For the new queues |
java.lang.String |
getSessionName()
|
long |
getSizeInBytes()
returns the size in bytes of this entry. |
Timestamp |
getSortTimestamp()
Can be used by cache implementation to implement LRU |
StorageId |
getStorageId()
Must be filled if retrieved from database. |
long |
getUniqueId()
This is the second order criteria in the queue |
java.lang.String |
getUniqueIdStr()
|
boolean |
isPersistent()
Returns true if the entry is persistent (persistent on HD), false otherwise. |
boolean |
isStored()
|
boolean |
isSwapped()
Enforced by I_Map |
void |
isSwapped(boolean swapped)
Enforced by I_Map |
void |
removed(StorageId storageId)
Notification if this entry is removed from storage |
void |
setSortTimestamp(Timestamp timestamp)
Can be used by cache implementation to implement LRU |
void |
setStored(boolean stored)
Is invoked by the storage implementation with 'true' when the entry is put in a storage and with 'false' when the entry is removed from the storage. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final long serialVersionUID
private final java.lang.String key
private final java.lang.String qos
private final java.lang.String sessionName
private boolean stored
private final long uniqueId
private final java.lang.String uniqueIdStr
private final long size
private transient boolean swapped
private transient Timestamp sortTimestamp
private transient StorageId storageId
Constructor Detail |
---|
public SubscribeEntry(java.lang.String key, java.lang.String qos, java.lang.String sessionName, long uniqueId, long size, StorageId storageId)
qos
- uniqueId
- size
- storageId
- TODOMethod Detail |
---|
public java.lang.String getUniqueIdStr()
getUniqueIdStr
in interface I_MapEntry
I_MapEntry.getUniqueIdStr()
public int getPriority()
I_Entry
getPriority
in interface I_Entry
I_Entry.getPriority()
public boolean isPersistent()
I_Entry
isPersistent
in interface I_Entry
I_Entry.isPersistent()
public long getUniqueId()
I_Entry
getUniqueId
in interface I_Entry
I_Entry.getUniqueId()
public java.lang.Object getEmbeddedObject()
I_Entry
getEmbeddedObject
in interface I_Entry
I_Entry.getEmbeddedObject()
public java.lang.String getQos()
public java.lang.String getKey()
public java.lang.String getSessionName()
public java.lang.String getEmbeddedType()
I_Entry
getEmbeddedType
in interface I_Entry
I_Entry.getEmbeddedType()
public java.lang.String getLogId()
I_Entry
See the derived class for a syntax description.
getLogId
in interface I_Entry
I_Entry.getLogId()
public long getSizeInBytes()
I_Entry
getSizeInBytes
in interface I_Entry
I_Entry.getSizeInBytes()
public void added(StorageId storageId)
I_Entry
NOTE: This event is NOT triggered on startup if entries come from harddisk from the last run. It is NOT triggered during swapping.
This callback may or may not be called from within the queue specific synchronized block
NOTE: This callback is currently only implemented for I_Queue, but not for I_Map!
added
in interface I_Entry
I_Entry.added(org.xmlBlaster.util.queue.StorageId)
public void removed(StorageId storageId)
I_Entry
NOTE: This event is NOT triggered during swapping.
The callback is guaranteed to be NEVER called from inside a queue specific synchronized block.
NOTE: This callback is currently only implemented for I_Queue, but not for I_Map!
removed
in interface I_Entry
storageId
- The storage idI_Entry.removed(org.xmlBlaster.util.queue.StorageId)
public void setStored(boolean stored)
I_Entry
Note that this callback is guaranteed to be called from within the queue specific synchronized block
Todo: Remove this in favour of added()/removed() (isStored() is currently only used by CacheQueueInterceptorPlugin.java) I'm not sure if this usage relies on being inside syncThis method may never throw any exception
setStored
in interface I_Entry
stored
- 'true' if the entry will be put into the storage, 'false' if it is removed.I_Entry.setStored(boolean)
public boolean isStored()
isStored
in interface I_Entry
I_Entry.isStored()
public boolean isSwapped()
isSwapped
in interface I_MapEntry
I_Map#isSwapped()
public void isSwapped(boolean swapped)
isSwapped
in interface I_MapEntry
I_Map#isSwapped(boolean)
public final Timestamp getSortTimestamp()
getSortTimestamp
in interface I_MapEntry
public final void setSortTimestamp(Timestamp timestamp)
setSortTimestamp
in interface I_MapEntry
public final void embeddedObjectToXml(java.io.OutputStream out, java.util.Properties props) throws java.io.IOException
I_Entry
embeddedObjectToXml
in interface I_Entry
out
- The stream to dump toprops
- Control porperties
java.io.IOException
public XBMeat getMeat()
getMeat
in interface I_Entry
public XBRef getRef()
getRef
in interface I_Entry
public StorageId getStorageId()
I_MapEntry
getStorageId
in interface I_MapEntry
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |