org.xmlBlaster.util.qos
Class ClientProperty

java.lang.Object
  org.xmlBlaster.util.EncodableData
      org.xmlBlaster.util.qos.ClientProperty

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class ClientProperty
extends EncodableData

This class encapsulates one client property in a QoS.

Examples:

<clientProperty name='transactionId' type='int'>120001</clientProperty>
<clientProperty name='myKey'>Hello World</clientProperty>
<clientProperty name='myBlob' type='byte[]' encoding='base64'>OKFKAL==</clientProperty>
 

If the attribute type is missing we assume a 'String' property

See Also:

The client.qos.clientProperty requirement, ClientPropertyTest, TestClientProperty, Serialized Form

Field Summary

static java.lang.String	ATTRIBUTE_TAG Typically used tag name for plugin attributes
static java.lang.String	CLIENTPROPERTY_TAG Typicall used tag name for subscribeQos and other Qos
private static long	serialVersionUID

Fields inherited from class org.xmlBlaster.util.EncodableData

isChunked, ME, tagName

Constructor Summary

ClientProperty(Global glob, java.lang.String name, java.lang.String type, java.lang.String encoding)
Deprecated. you should use the constructors with no global

ClientProperty(Global glob, java.lang.String name, java.lang.String type, java.lang.String encoding, java.lang.String value)
Deprecated. you should use the alternative with no global.

ClientProperty(java.lang.String name, boolean value)

ClientProperty(java.lang.String name, byte[] value)
Set binary data, will be of type "byte[]" and base64 encoded

ClientProperty(java.lang.String name, java.lang.String type, java.lang.String encoding)

ClientProperty(java.lang.String name, java.lang.String type, java.lang.String encoding, java.lang.String value)

Method Summary

java.lang.String

toString()

Methods inherited from class org.xmlBlaster.util.EncodableData

convertPropertyObject, forceCdata, getBlobValue, getBooleanValue, getByteValue, getCharset, getDoubleValue, getEncoding, getFloatValue, getIntValue, getLongValue, getName, getObjectValue, getPropertyType, getShortValue, getSize, getStringValue, getStringValue, getType, getValueRaw, isBase64, isStringType, main, setCharset, setSize, setValue, setValue, setValue, setValueRaw, toXml, toXml, toXml, toXml, toXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

ATTRIBUTE_TAG

public static final java.lang.String ATTRIBUTE_TAG

Typically used tag name for plugin attributes

See Also:

Constant Field Values

CLIENTPROPERTY_TAG

public static final java.lang.String CLIENTPROPERTY_TAG

Typicall used tag name for subscribeQos and other Qos

See Also:

Constant Field Values

Constructor Detail

ClientProperty

public ClientProperty(Global glob,
                      java.lang.String name,
                      java.lang.String type,
                      java.lang.String encoding)

Deprecated. you should use the constructors with no global

Parameters:

name - The unique property key

type - The data type of the value

encoding - null or Constants.ENCODING_BASE64="base64"

ClientProperty

public ClientProperty(java.lang.String name,
                      java.lang.String type,
                      java.lang.String encoding)

Parameters:

name - The unique property key

type - The data type of the value

encoding - null or Constants.ENCODING_BASE64="base64"

ClientProperty

public ClientProperty(Global glob,
                      java.lang.String name,
                      java.lang.String type,
                      java.lang.String encoding,
                      java.lang.String value)

Deprecated. you should use the alternative with no global.

Parameters:

name - The unique property key

type - The data type of the value

encoding - null or Constants.ENCODING_BASE64="base64"

ClientProperty

public ClientProperty(java.lang.String name,
                      java.lang.String type,
                      java.lang.String encoding,
                      java.lang.String value)

Parameters:

name - The unique property key

type - The data type of the value

encoding - null or Constants.ENCODING_BASE64="base64"

value - The original value (not yet encoded!)

ClientProperty

public ClientProperty(java.lang.String name,
                      byte[] value)

Set binary data, will be of type "byte[]" and base64 encoded

Parameters:

name - The unique property key

value - The binary data

ClientProperty

public ClientProperty(java.lang.String name,
                      boolean value)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object