org.xmlBlaster.client.key
Class PublishKey

java.lang.Object
  org.xmlBlaster.client.key.PublishKey

public class PublishKey
extends java.lang.Object

Wrap the XML key data for publish() invocations.

See MsgKeySaxFactory for a syntax description of the allowed xml structure

See Also:

MsgKeySaxFactory, the interface.publish requirement

Constructor Summary

PublishKey(Global glob)
Create a key data holder, the message oid is randomly generated.

PublishKey(Global glob, MsgKeyData msgKeyData)
Pass a pre filled data object.

PublishKey(Global glob, java.lang.String oid)
Create a key data holder with the given message oid.

PublishKey(Global glob, java.lang.String oid, java.lang.String contentMime)
Create a key data holder with the given message oid and its mime type.

PublishKey(Global glob, java.lang.String oid, java.lang.String contentMime, java.lang.String contentMimeExtended)
Create a key data holder with the given message oid and its mime types.

PublishKey(Global glob, java.lang.String oid, java.lang.String contentMime, java.lang.String contentMimeExtended, java.lang.String domain)
Create a key data holder with the given message oid and its mime types.

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
Global	getGlobal()
java.lang.String	getOid() Access the <key oid="...">.
void	setClientTags(java.lang.String clientTags) May be used to integrate your application tags.
void	setContentMime(java.lang.String contentMime) A MIME type like "image/gif"
void	setContentMimeExtended(java.lang.String contentMimeExtended) For example a version number of the mime type
void	setDomain(java.lang.String domain) Allows to give cluster a hint about who is the master or can be used for your own purposes
void	setOid(java.lang.String oid) Set the <key oid="...">.
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

Constructor Detail

PublishKey

public PublishKey(Global glob)

Create a key data holder, the message oid is randomly generated.

PublishKey

public PublishKey(Global glob,
                  java.lang.String oid)

Create a key data holder with the given message oid.

PublishKey

public PublishKey(Global glob,
                  java.lang.String oid,
                  java.lang.String contentMime)

Create a key data holder with the given message oid and its mime type.

PublishKey

public PublishKey(Global glob,
                  java.lang.String oid,
                  java.lang.String contentMime,
                  java.lang.String contentMimeExtended)

Create a key data holder with the given message oid and its mime types.

PublishKey

public PublishKey(Global glob,
                  java.lang.String oid,
                  java.lang.String contentMime,
                  java.lang.String contentMimeExtended,
                  java.lang.String domain)

Create a key data holder with the given message oid and its mime types.

Parameters:

domain - The cluster domain

PublishKey

public PublishKey(Global glob,
                  MsgKeyData msgKeyData)

Pass a pre filled data object.

Method Detail

getData

public MsgKeyData getData()

setOid

public void setOid(java.lang.String oid)

Set the <key oid="...">.

Parameters:

The - unique key oid

getOid

public java.lang.String getOid()

Access the <key oid="...">.

Returns:

The unique key oid

setContentMime

public void setContentMime(java.lang.String contentMime)

A MIME type like "image/gif"

getContentMime

public java.lang.String getContentMime()

A MIME type like "image/gif"

setContentMimeExtended

public void setContentMimeExtended(java.lang.String contentMimeExtended)

For example a version number of the mime type

getContentMimeExtended

public java.lang.String getContentMimeExtended()

For example a version number of the mime type

setDomain

public void setDomain(java.lang.String domain)

Allows to give cluster a hint about who is the master or can be used for your own purposes

getDomain

public java.lang.String getDomain()

Access the domain setting

Returns:

A domain string or null

setClientTags

public void setClientTags(java.lang.String clientTags)

May be used to integrate your application tags.

Parameters:

str - The ASCII XML key containing your tags

getClientTags

public java.lang.String getClientTags()

Your specific application tags.

getGlobal

public Global getGlobal()

toXml

public java.lang.String toXml()

Converts the data in XML ASCII string.

Returns:

An XML ASCII string