xmlBlaster 2.1.0 API

org.xmlBlaster.client.key
Class GetReturnKey

java.lang.Object
  extended by org.xmlBlaster.client.key.GetReturnKey

public class GetReturnKey
extends java.lang.Object

Parses the key of returned MsgUnit of get() invocations

See MsgKeySaxFactory for a syntax description of the xml structure

See Also:
MsgKeySaxFactory, the interface.get requirement

Field Summary
private static java.lang.String ME
           
private  MsgKeyData msgKeyData
           
 
Constructor Summary
GetReturnKey(Global glob, java.lang.String xmlKey)
          Parse the given xml data.
 
Method Summary
 java.lang.String getClientTags()
          Your specific application tags.
 java.lang.String getContentMime()
          A MIME type like "image/gif"
 java.lang.String getContentMimeExtended()
          For example a version number of the mime type
 MsgKeyData getData()
           
 java.lang.String getDomain()
          Access the domain setting
 java.lang.String getOid()
          Access the <key oid="...">.
 boolean isDeadMessage()
          Dead letters are unrecoverable lost messages, usually an administrator should subscribe to those messages.
 boolean isInternal()
          Messages starting with "__" are reserved for internal usage
 boolean isPluginInternal()
          Messages starting with "_" are reserved for usage in plugins
 java.lang.String toXml()
          Converts the data in XML ASCII string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ME

private static final java.lang.String ME
See Also:
Constant Field Values

msgKeyData

private final MsgKeyData msgKeyData
Constructor Detail

GetReturnKey

public GetReturnKey(Global glob,
                    java.lang.String xmlKey)
             throws XmlBlasterException
Parse the given xml data.

Throws:
XmlBlasterException
Method Detail

getData

public MsgKeyData getData()

getOid

public java.lang.String getOid()
Access the <key oid="...">.

Returns:
The unique key oid

isDeadMessage

public boolean isDeadMessage()
Dead letters are unrecoverable lost messages, usually an administrator should subscribe to those messages.


isPluginInternal

public final boolean isPluginInternal()
Messages starting with "_" are reserved for usage in plugins


isInternal

public final boolean isInternal()
Messages starting with "__" are reserved for internal usage


getContentMime

public java.lang.String getContentMime()
A MIME type like "image/gif"


getContentMimeExtended

public java.lang.String getContentMimeExtended()
For example a version number of the mime type


getDomain

public java.lang.String getDomain()
Access the domain setting

Returns:
A domain string or null

getClientTags

public java.lang.String getClientTags()
Your specific application tags.


toXml

public java.lang.String toXml()
Converts the data in XML ASCII string.

Returns:
An XML ASCII string

xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.