|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.alertmgr.TWGPublish
TWGPublish is the base class for all publishing api's. This abstract base class is used as a container for those things that are common to all publish records. The family and qualifier strings are combined to create the event type. Version allows the publish database (in the event server) to be overwritten/updated. Locale pertains to the data being published.
Field Summary | |
---|---|
static int |
VERSION_ONE
|
Constructor Summary | |
---|---|
TWGPublish(IntelByteBuffer buf)
Constructor for interpreting a provided IntelByteBuffer. |
|
TWGPublish(IntelByteBuffer buf,
int off)
Constructor for interpreting a provided IntelByteBuffer at a given offset. |
|
TWGPublish(java.lang.String family,
java.lang.String[] qualifiers,
int version,
java.util.Locale locale)
Constructor. |
|
TWGPublish(java.lang.String family,
java.lang.String[] qualifiers,
java.util.Locale locale)
Constructor with default version. |
|
TWGPublish(TWGPublish pub)
Copy Constructor. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Copy object. |
java.util.Locale |
getLocale()
Get the locale of the data being published. |
int |
getNumTypeQualifiers()
Get the number of qualifiers in the event type (not including family). |
java.lang.String |
getType()
Get the event type to which this publication in defined. |
java.lang.String[] |
getTypeArray()
Get the fully qualified event type (defined publish's scope) as an array. |
java.lang.String |
getTypeFamily()
Get the highest level qualifier of the event type. |
int |
getTypeId()
Get type ID. |
java.lang.String[] |
getTypeQualifiers()
Get the array of event type qualifiers. |
int |
getVersion()
Get the version of the data being published. |
void |
print()
Print the contents of the TWGPublish object. |
int |
readTWGPublish(IntelByteBuffer buf,
int off)
Method for interpreting a provided IntelByteBuffer at a given offset. |
void |
setLocale(java.util.Locale locale)
Set the locale for which this publication in defined. |
void |
setVersion(int version)
Set the version of the data being published. |
int |
sizeOf()
Determine the size of the entire TWGPublish object. |
static int |
sizeOfHdr()
Determine the size of the TWGPublish header. |
int |
sizeOfTWGPublish()
Determine the size of the entire TWGPublish object. |
IntelByteBuffer |
toIntelByteBuffer()
Convert the object into IntelByteBuffer representation. |
int |
writeIntelByteBuffer(IntelByteBuffer buf)
Write contents of this object into an IntelByteBuffer. |
int |
writeIntelByteBuffer(IntelByteBuffer buf,
int off)
Write contents of this object into provided IntelByteBuffer starting at a given offset. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int VERSION_ONE
Constructor Detail |
public TWGPublish(java.lang.String family, java.lang.String[] qualifiers, int version, java.util.Locale locale)
family
- String representing the highest level qualifier of the event typequalifiers
- Array of strings comprising the remainder of the event typeversion
- Version of data being publishedlocale
- Locale of data being publishedpublic TWGPublish(java.lang.String family, java.lang.String[] qualifiers, java.util.Locale locale)
family
- String representing the highest level qualifier of the event typequalifiers
- Array of strings comprising the remainder of the event typelocale
- Locale of data being publishedpublic TWGPublish(TWGPublish pub)
pub
- TWGPublish object to be copiedpublic TWGPublish(IntelByteBuffer buf)
buf
- IntelByteBuffer from which data should be readpublic TWGPublish(IntelByteBuffer buf, int off)
buf
- IntelByteBuffer from which data should be readoff
- offset from the current relative start of the provided IntelByteBufferMethod Detail |
public java.lang.Object clone()
public java.lang.String getType()
public void setLocale(java.util.Locale locale)
locale
- for which publication is definedpublic int getNumTypeQualifiers()
public java.lang.String[] getTypeQualifiers()
public java.lang.String[] getTypeArray()
public void setVersion(int version)
version
- version of data being publishedpublic int getVersion()
public java.util.Locale getLocale()
public java.lang.String getTypeFamily()
public IntelByteBuffer toIntelByteBuffer()
public int writeIntelByteBuffer(IntelByteBuffer buf)
buf
- IntelByteBuffer into which data should be written
public int writeIntelByteBuffer(IntelByteBuffer buf, int off)
buf
- IntelByteBuffer into which data should be writtenoff
- offset from the current relative start of the provided IntelByteBuffer
public int readTWGPublish(IntelByteBuffer buf, int off)
buf
- IntelByteBuffer from which data should be readoff
- offset from the current relative start of the provided IntelByteBuffer
public static int sizeOfHdr()
public int sizeOfTWGPublish()
public int sizeOf()
public void print()
public int getTypeId()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |