public class BrokerEvent
extends java.lang.Object
implements java.io.Serializable
All event_type_name parameters take fully qualified event type names, such as "MyScope::MyEvent".
Modifier and Type | Field and Description |
---|---|
protected boolean |
ack_status |
static int |
AUTO_SIZE |
protected java.lang.String |
broker_host |
protected java.lang.String |
broker_name |
protected int |
broker_port |
protected boolean |
client_validation |
static int |
DEFAULT_PRIORITY |
protected boolean |
dirty |
static int |
ENTIRE_SEQUENCE |
static int |
ENVELOPE_FLAGS_INSERTED_EVENT |
static int |
ENVELOPE_FLAGS_LOGGED_EVENT |
static int |
ENVELOPE_FLAGS_NO_VALIDATION |
static int |
ENVELOPE_FLAGS_OPEN_VALIDATION |
protected long |
event_id |
protected java.lang.String |
event_type_name |
protected COM.activesw.api.client.BrokerEventFieldTypeMapper |
fieldTypeMapper |
static int |
HIGH_PRIORITY |
static int |
LOW_PRIORITY |
protected COM.activesw.api.client.NativeEvent |
native_event |
protected long |
pub_seqn |
protected long |
recv_seqn |
protected int |
redelivery_count |
protected int |
session_id |
protected int[] |
sub_ids |
protected BrokerClient |
the_client |
protected BrokerTypeDef |
type_def |
protected byte[] |
wire_event |
Constructor and Description |
---|
BrokerEvent(BrokerClient client,
java.lang.String event_type_name)
Create an event of the appropriate type with an associated client.
|
BrokerEvent(BrokerClient client,
java.lang.String event_type_name,
java.lang.Class storage_class)
Deprecated.
As of Java API v6.5.
|
BrokerEvent(BrokerClient client,
java.lang.String event_type_name,
java.lang.Object storage_object)
Deprecated.
As of Java API v6.5.
|
BrokerEvent(BrokerEvent event)
Copy constructor.
|
BrokerEvent(java.lang.String event_type_name,
BrokerClusterPublisher bcp)
Create an event of the appropriate type with an associated client from the BrokerClusterPublisher's cluster pool.
|
BrokerEvent(java.lang.String event_type_name,
BrokerClusterPublisher bcp,
java.lang.Class storage_class)
Deprecated.
As of Java API v6.5.
|
BrokerEvent(java.lang.String event_type_name,
BrokerClusterPublisher bcp,
java.lang.Object storage_object)
Deprecated.
As of Java API v6.5.
|
Modifier and Type | Method and Description |
---|---|
protected static void |
checkSetEnvField(java.lang.String field_name,
java.lang.String full_field_name) |
void |
clear()
Clears all fields of the event so it can be re-used.
|
void |
clearField(java.lang.String field_name)
Clear (un-set) a field in the event.
|
void |
clearField(java.lang.String field_name,
boolean ignoreEx)
Clear (un-set) a field in the event.
|
void |
clearFieldInternal(java.lang.String field_name,
boolean ignoreEx) |
void |
clearModificationFlag()
Clear the modification flag.
|
static BrokerEvent |
fromBinData(BrokerClient client,
byte[] data) |
static BrokerEvent |
fromBinData(BrokerClient client,
byte[] data,
java.lang.String event_type_name)
Create an event using a byte array given out by toBinData().
|
void |
fromObject(java.lang.Object obj)
Deprecated.
As of Java API v6.5.
|
void |
fromObject(java.lang.Object obj,
boolean readOnly)
Deprecated.
As of Java API v6.5.
|
java.lang.String |
getBaseTypeName()
Get the type name without the scope qualification.
|
protected COM.activesw.api.client.NativeStruct |
getBody() |
protected COM.activesw.api.client.NativeFieldIterator |
getBodyIterator() |
boolean |
getBooleanField(java.lang.String field_name)
Get the value of a boolean field.
|
boolean |
getBooleanProperty(java.lang.String property_name) |
boolean[] |
getBooleanSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a boolean sequence field.
|
byte |
getByteField(java.lang.String field_name)
Get the value of a byte field.
|
byte |
getByteProperty(java.lang.String property_name) |
byte[] |
getByteSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a byte sequence field.
|
char |
getCharField(java.lang.String field_name)
Get the value of a char field.
|
char[] |
getCharSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a char sequence field.
|
BrokerClient |
getClient()
Get the event's client.
|
boolean |
getClientValidation() |
BrokerDate |
getDateField(java.lang.String field_name)
Get the value of a date field.
|
BrokerDate[] |
getDateSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a date sequence field.
|
double |
getDoubleField(java.lang.String field_name)
Get the value of a double field.
|
double |
getDoubleProperty(java.lang.String property_name) |
double[] |
getDoubleSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a double sequence field.
|
protected COM.activesw.api.client.NativeStruct |
getEnvelope() |
protected COM.activesw.api.client.NativeFieldIterator |
getEnvelopeIterator() |
BrokerEvent |
getEventField(java.lang.String field_name)
Get the value of an event field.
|
long |
getEventId()
Get the event ID (as set by the broker) for this event.
|
BrokerEvent[] |
getEventSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of an event sequence field.
|
BrokerField |
getField(java.lang.String field_name)
Get the value of field.
|
java.lang.String[] |
getFieldNames(java.lang.String field_name)
Get the list of field names in an event.
|
short |
getFieldType(java.lang.String field_name)
Gets the type for the specified field.
|
float |
getFloatField(java.lang.String field_name)
Get the value of a float field.
|
float |
getFloatProperty(java.lang.String property_name) |
float[] |
getFloatSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a float sequence field.
|
int |
getIntegerField(java.lang.String field_name)
Get the value of an integer field.
|
int[] |
getIntegerSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of an integer sequence field.
|
int |
getIntProperty(java.lang.String property_name) |
long |
getLongField(java.lang.String field_name)
Get the value of a long field.
|
long |
getLongProperty(java.lang.String property_name) |
long[] |
getLongSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a long sequence field.
|
protected COM.activesw.api.client.NativeEvent |
getNativeEvent() |
int |
getPriority()
Gets the priority of the event.
|
java.lang.Object |
getProperty(java.lang.String property_name) |
java.lang.String[] |
getPropertyNames(java.lang.String field_name)
Get the list of property names in an event.
|
long |
getPublishSequenceNumber()
Get the publishing sequence number for this event.
|
long |
getReceiptSequenceNumber()
Get the receipt sequence number (as set by the broker) for this event.
|
int |
getRedeliveryCount()
Get the redelivery count (as set by the broker) for this event.
|
int |
getRetrievedSessionId()
Get the session id on which this event was retrieved.
|
boolean |
getRetrievedStatus()
Get the acknowledgement status of the event.
|
java.lang.String |
getScopeTypeName()
Get the scope of the event type name.
|
BrokerField |
getSequenceField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a sequence field.
|
int |
getSequenceFieldSize(java.lang.String field_name)
Get the size of a sequence field.
|
short |
getShortField(java.lang.String field_name)
Get the value of a short field.
|
short |
getShortProperty(java.lang.String property_name) |
short[] |
getShortSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a short sequence field.
|
short[] |
getShortSeqFieldInternal(java.lang.String field_name,
int offset,
int max_n) |
java.lang.Object |
getStorageObject()
Deprecated.
As of Java API v6.5.
|
java.lang.String |
getStringField(java.lang.String field_name)
Get the value of a string field.
|
java.lang.String |
getStringProperty(java.lang.String property_name) |
java.lang.String[] |
getStringSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a string sequence field.
|
BrokerEvent |
getStructFieldAsEvent(java.lang.String field_name)
Get the value of a structure field.
|
BrokerEvent[] |
getStructSeqFieldAsEvents(java.lang.String field_name,
int offset,
int max_n)
Get the value of a structure sequence field.
|
int[] |
getSubscriptionIds()
Get the subscription IDs for an event.
|
int |
getTag()
Get the event's 'tag' envelope field.
|
BrokerTypeDef |
getTypeDef()
Get the event's type definition.
|
java.lang.String |
getTypeName()
Get the fully qualified type name.
|
char |
getUCCharField(java.lang.String field_name)
Get the value of a unicode char field.
|
char[] |
getUCCharSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a unicode char sequence field.
|
java.lang.String |
getUCStringField(java.lang.String field_name)
Get the value of a unicode string field.
|
java.lang.String[] |
getUCStringSeqField(java.lang.String field_name,
int offset,
int max_n)
Get the value of a unicode string sequence field.
|
protected byte[] |
getWireEvent() |
boolean |
hasBeenModified()
Check if event has been modified since last time the modification flag was cleared.
|
boolean |
isAckReply()
Determine if the given event is an acknowledgement reply.
|
boolean |
isErrorReply()
Determine if the given event is an error reply.
|
boolean |
isFieldSet(java.lang.String field_name)
Determine if the specified field is set in the event.
|
boolean |
isFieldSetInternal(java.lang.String field_name) |
boolean |
isLastReply()
Determines if the given event is the last event in a reply sequence.
|
boolean |
isNullReply()
Determine if the given event is a 'null' event.
|
void |
setBooleanField(java.lang.String field_name,
boolean value)
Sets the value of a boolean field.
|
void |
setBooleanProperty(java.lang.String property_name,
boolean value) |
void |
setBooleanSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
boolean[] value)
Sets the value of a subrange of a boolean sequence field.
|
void |
setByteField(java.lang.String field_name,
byte value)
Sets the value of a byte field.
|
void |
setByteProperty(java.lang.String property_name,
byte value) |
void |
setByteSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
byte[] value)
Sets the value of a subrange of a byte sequence field.
|
void |
setCharField(java.lang.String field_name,
char value)
Sets the value of a char field.
|
void |
setCharSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
char[] value)
Sets the value of a subrange of a char sequence field.
|
void |
setClientValidation(boolean client_validation)
This method will enable/disable client side validation.
|
void |
setDateField(java.lang.String field_name,
BrokerDate value)
Sets the value of a date field.
|
void |
setDateSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
BrokerDate[] value)
Sets the value of a subrange of a date sequence field.
|
void |
setDoubleField(java.lang.String field_name,
double value)
Sets the value of a double field.
|
void |
setDoubleProperty(java.lang.String property_name,
double value) |
void |
setDoubleSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
double[] value)
Sets the value of a subrange of a double sequence field.
|
void |
setEventField(java.lang.String field_name,
BrokerEvent value)
Sets the value of an event field.
|
void |
setEventSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
BrokerEvent[] value)
Set the value of an event sequence field.
|
void |
setField(java.lang.String field_name,
BrokerField field)
Sets the value of a field.
|
void |
setField(java.lang.String field_name,
short field_type,
java.lang.Object value)
Sets the value of a field.
|
void |
setFloatField(java.lang.String field_name,
float value)
Sets the value of a float field.
|
void |
setFloatProperty(java.lang.String property_name,
float value) |
void |
setFloatSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
float[] value)
Sets the value of a subrange of a float sequence field.
|
void |
setIntegerField(java.lang.String field_name,
int value)
Sets the value of an integer field.
|
void |
setIntegerSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
int[] value)
Sets the value of a subrange of an integer sequence field.
|
void |
setIntProperty(java.lang.String property_name,
int value) |
void |
setLongField(java.lang.String field_name,
long value)
Sets the value of a long field.
|
void |
setLongProperty(java.lang.String property_name,
long value) |
void |
setLongSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
long[] value)
Sets the value of a subrange of a long sequence field.
|
void |
setModificationFlag()
Set the modification flag.
|
void |
setNullProperty(java.lang.String property_name,
java.lang.String value) |
void |
setPriority(int priority)
Sets the priority of the event.
|
void |
setPublishSequenceNumber(long seqn)
Set the publishing sequence number for this event.
|
void |
setSequenceField(java.lang.String field_name,
short field_type,
int src_offset,
int dest_offset,
int n,
java.lang.Object value)
Sets the value of a subrange of a sequence field.
|
void |
setSequenceFieldSize(java.lang.String field_name,
int size)
Set the size of a sequence field.
|
void |
setShortField(java.lang.String field_name,
short value)
Sets the value of a short field.
|
void |
setShortProperty(java.lang.String property_name,
short value) |
void |
setShortSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
short[] value)
Sets the value of a subrange of a short sequence field.
|
void |
setStringField(java.lang.String field_name,
java.lang.String value)
Sets the value of a string field.
|
void |
setStringFieldToSubstring(java.lang.String field_name,
int offset,
int nc,
java.lang.String value)
Sets the value of a string field to a substring of another string.
|
void |
setStringProperty(java.lang.String property_name,
java.lang.String value) |
void |
setStringSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
java.lang.String[] value)
Sets the value of a subrange of a string sequence field.
|
void |
setStructFieldFromEvent(java.lang.String field_name,
BrokerEvent value)
Sets the value of a structure field.
|
void |
setStructSeqFieldFromEvents(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
BrokerEvent[] value)
Sets the value of a structure sequence field.
|
void |
setTag(int tag)
Set the event's 'tag' envelope field.
|
void |
setTypeName(java.lang.String event_type_name) |
void |
setUCCharField(java.lang.String field_name,
char value)
Sets the value of a unicode char field.
|
void |
setUCCharSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
char[] value)
Sets the value of a subrange of a unicode char sequence field.
|
void |
setUCStringField(java.lang.String field_name,
java.lang.String value)
Sets the value of a unicode string field.
|
void |
setUCStringFieldToSubstring(java.lang.String field_name,
int offset,
int nc,
java.lang.String value)
Sets the value of a unicode string field to a substring of another string.
|
void |
setUCStringSeqField(java.lang.String field_name,
int src_offset,
int dest_offset,
int n,
java.lang.String[] value)
Sets the value of a subrange of a unicode string sequence field.
|
void |
setWireEvent(byte[] w_event) |
static java.lang.String |
stringFromANSI(java.lang.String st)
Convert a String object which contains only ANSI 8-bit characters, to another String which contains unicode characters.
|
static java.lang.String |
stringToANSI(java.lang.String st)
Convert a String object to another String which only contains characters which cleanly map to ANSI 8-bit characters.
|
byte[] |
toBinData()
Get out the event's data as a byte array.
|
java.lang.String |
toFormattedString(java.lang.String formatString)
Format an event string.
|
java.lang.String |
toFormattedString(java.lang.String formatString,
java.util.Locale locale)
Format an event string.
|
java.lang.String |
toLocalizedFormattedString(java.lang.String formatString)
Format an event string.
|
java.lang.String |
toLocalizedString()
Get event content as a string which includes newlines formatted for the default locale.
|
void |
toObject(java.lang.Object obj)
Deprecated.
As of Java API v6.5.
|
java.lang.String |
toString()
Get event content as a string which includes newlines formatted for the US English locale.
|
java.lang.String |
toString(int indent_level)
Get event content as a string suitable for human viewing formatted for the US English locale.
|
java.lang.String |
toString(int indent_level,
java.util.Locale locale)
Get event content as a string suitable for human viewing formatted for the specified locale.
|
java.lang.String |
toString(java.util.Locale locale)
Get event content as a string which includes newlines formatted for the specified locale.
|
byte[] |
toWireEvent() |
void |
validate(BrokerClient client)
Validate event in the context of the specified client.
|
public static final int ENTIRE_SEQUENCE
public static final int AUTO_SIZE
public static final int ENVELOPE_FLAGS_INSERTED_EVENT
public static final int ENVELOPE_FLAGS_LOGGED_EVENT
public static final int ENVELOPE_FLAGS_OPEN_VALIDATION
public static final int ENVELOPE_FLAGS_NO_VALIDATION
public static final int DEFAULT_PRIORITY
public static final int HIGH_PRIORITY
public static final int LOW_PRIORITY
protected transient COM.activesw.api.client.NativeEvent native_event
protected transient byte[] wire_event
protected transient int[] sub_ids
protected transient long pub_seqn
protected transient long recv_seqn
protected transient int redelivery_count
protected transient boolean client_validation
protected transient long event_id
protected transient java.lang.String event_type_name
protected transient BrokerClient the_client
protected transient java.lang.String broker_host
protected transient java.lang.String broker_name
protected transient int broker_port
protected transient boolean dirty
protected transient BrokerTypeDef type_def
protected transient boolean ack_status
protected transient int session_id
protected COM.activesw.api.client.BrokerEventFieldTypeMapper fieldTypeMapper
public BrokerEvent(BrokerClient client, java.lang.String event_type_name) throws BrokerException
BrokerInvalidEventTypeNameException
- If the type name is not valid.BrokerNoPermissionException
- If a client is specified and the client does not have permission to publish or subscribe to the event type.BrokerNullParameterException
- If event_type_name is null.BrokerUnknownEventTypeException
- If a client is specified and the broker does not have an event type with the specified name.BrokerException
public BrokerEvent(BrokerClient client, java.lang.String event_type_name, java.lang.Class storage_class) throws BrokerException
If both a client and a class are provided, the event will be typechecked and all fields in the type definition that also appear in the Java class will appear to be there at all times. Fields that appear only in the type definition are not accessible. Field types in the class must match exactly. There is no implicit type conversion.
If no client is provided, then fields will still be typechecked, but only ones in the Java class will be accessible.
BrokerFieldNotFoundException
- If the event is typechecked and a public data member exists in the class when there is no field in the event type using the same name.BrokerFieldTypeMismatchException
- If the event is typechecked and a data member in the class is a different type than the same field in the event type.BrokerInvalidClassException
- If the storage_class cannot be instantiated using the Class.newInstance() method.BrokerInvalidEventTypeNameException
- If the type name is not valid.BrokerNoPermissionException
- If a client is specified and the client does not have permission to publish or subscribe to the event type. Or if the class provided
cannot be instantiated.BrokerNullParameterException
- If event_type_name or storage_class are null.BrokerUnknownEventTypeException
- If a client is specified and the broker does not have an event type with the specified name.BrokerException
public BrokerEvent(BrokerClient client, java.lang.String event_type_name, java.lang.Object storage_object) throws BrokerException
BrokerFieldNotFoundException
- If the event is typechecked and a public data member exists in the object's class when there is no field in the event type using the same
name.BrokerFieldTypeMismatchException
- If the event is typechecked and a data member in the object's class is a different type than the same field in the event type.BrokerInvalidEventTypeNameException
- If the type name is not valid.BrokerNoPermissionException
- If a client is specified and the client does not have permission to publish or subscribe to the event type.BrokerNullParameterException
- If event_type_name or storage_object are null.BrokerUnknownEventTypeException
- If a client is specified and the broker does not have an event type with the specified name.BrokerException
public BrokerEvent(java.lang.String event_type_name, BrokerClusterPublisher bcp) throws BrokerException
BrokerInvalidEventTypeNameException
- If the type name is not valid.BrokerNoPermissionException
- If a client is specified and the client does not have permission to publish or subscribe to the event type.BrokerNullParameterException
- If event_type_name is null.BrokerUnknownEventTypeException
- If a client is specified and the broker does not have an event type with the specified name.BrokerClusterPublisherException
- If no broker is available on the cluster pool.BrokerException
public BrokerEvent(java.lang.String event_type_name, BrokerClusterPublisher bcp, java.lang.Class storage_class) throws BrokerException
If both a cluster publisher and a class are provided, the event will be typechecked and all fields in the type definition that also appear in the Java class will appear to be there at all times. Fields that appear only in the type definition are not accessible. Field types in the class must match exactly. There is no implicit type conversion.
If no cluster publisher is provided, then fields will still be typechecked, but only ones in the Java class will be accessible.
BrokerFieldNotFoundException
- If the event is typechecked and a public data member exists in the class when there is no field in the event type using the same name.BrokerFieldTypeMismatchException
- If the event is typechecked and a data member in the class is a different type than the same field in the event type.BrokerInvalidClassException
- If the storage_class cannot be instantiated using the Class.newInstance() method.BrokerInvalidEventTypeNameException
- If the type name is not valid.BrokerNoPermissionException
- If a client is specified and the client does not have permission to publish or subscribe to the event type. Or if the class provided
cannot be instantiated.BrokerNullParameterException
- If event_type_name or storage_class are null.BrokerUnknownEventTypeException
- If a client is specified and the broker does not have an event type with the specified name.BrokerClusterPublisherException
- If no broker is available on the cluster pool.BrokerException
public BrokerEvent(java.lang.String event_type_name, BrokerClusterPublisher bcp, java.lang.Object storage_object) throws BrokerException
BrokerFieldNotFoundException
- If the event is typechecked and a public data member exists in the object's class when there is no field in the event type using the same
name.BrokerFieldTypeMismatchException
- If the event is typechecked and a data member in the object's class is a different type than the same field in the event type.BrokerInvalidEventTypeNameException
- If the type name is not valid.BrokerNoPermissionException
- If a client is specified and the client does not have permission to publish or subscribe to the event type.BrokerNullParameterException
- If event_type_name or storage_object are null.BrokerUnknownEventTypeException
- If a client is specified and the broker does not have an event type with the specified name.BrokerClusterPublisherException
- If no broker is available on the cluster pool.BrokerException
public BrokerEvent(BrokerEvent event) throws BrokerException
BrokerNullParameterException
- If event is null.BrokerException
public java.lang.String getTypeName()
public void setTypeName(java.lang.String event_type_name) throws BrokerException
BrokerException
public java.lang.String getBaseTypeName()
public java.lang.String getScopeTypeName()
public BrokerClient getClient()
public BrokerTypeDef getTypeDef() throws BrokerException
BrokerInvalidTypeDefException
- If the event is not associated with a valid client.BrokerException
public java.lang.Object getStorageObject()
If the event was created with an object instance, that instance will be returned. If the event was created with a Java class, the instance of that class created for the event will be returned.
public void toObject(java.lang.Object obj) throws BrokerException
BrokerNullParameterException
- If obj is null.BrokerFieldNotFoundException
- If a public data member exists in the object's class when there is no field in the event type using the same name.BrokerFieldTypeMismatchException
- If a public data member of the object's class has a different type than the field in the event type.BrokerException
public void fromObject(java.lang.Object obj, boolean readOnly) throws BrokerException
BrokerNullParameterException
- If obj is null.BrokerFieldNotFoundException
- If the event is typechecked and a public data member exists in the object's class when there is no field in the event type using the same
name.BrokerFieldTypeMismatchException
- If the event is typechecked and a data member in the object's class is a different type than the same field in the event type.BrokerException
public void fromObject(java.lang.Object obj) throws BrokerException
BrokerNullParameterException
- If obj is null.BrokerFieldNotFoundException
- If the event is typechecked and a public data member exists in the object's class when there is no field in the event type using the same
name.BrokerFieldTypeMismatchException
- If the event is typechecked and a data member in the object's class is a different type than the same field in the event type.BrokerException
public long getPublishSequenceNumber()
public void setPublishSequenceNumber(long seqn)
public long getReceiptSequenceNumber()
public int getRedeliveryCount()
public long getEventId()
public boolean getRetrievedStatus() throws BrokerException
BrokerNotImplementedException
- If the event was not a result of a peek operation.BrokerException
public int getRetrievedSessionId() throws BrokerException
BrokerNotImplementedException
- If the event was not a result of a peek operation.BrokerException
public int[] getSubscriptionIds()
public void setClientValidation(boolean client_validation)
public boolean getClientValidation()
public short getFieldType(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void setByteField(java.lang.String field_name, byte value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void setShortField(java.lang.String field_name, short value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void setIntegerField(java.lang.String field_name, int value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void setLongField(java.lang.String field_name, long value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void setFloatField(java.lang.String field_name, float value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void setDoubleField(java.lang.String field_name, double value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void setBooleanField(java.lang.String field_name, boolean value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void setDateField(java.lang.String field_name, BrokerDate value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerException
public void setCharField(java.lang.String field_name, char value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void setUCCharField(java.lang.String field_name, char value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void setStringField(java.lang.String field_name, java.lang.String value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerException
public void setUCStringField(java.lang.String field_name, java.lang.String value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerException
public void setStringFieldToSubstring(java.lang.String field_name, int offset, int nc, java.lang.String value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If offset is not within the size of the string, or if nc would exceed the size of the string.BrokerException
public void setUCStringFieldToSubstring(java.lang.String field_name, int offset, int nc, java.lang.String value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If offset is not within the size of the string, or if nc would exceed the size of the string.BrokerException
public void setByteSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, byte[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setShortSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, short[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setIntegerSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, int[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setLongSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, long[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setFloatSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, float[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setDoubleSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, double[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setBooleanSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, boolean[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setDateSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, BrokerDate[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null, or if any of the elements of the value array are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setCharSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, char[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setUCCharSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, char[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setStringSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, java.lang.String[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null, or if any of the elements of the value array are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setUCStringSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, java.lang.String[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null, or if any of the elements of the value array are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setSequenceField(java.lang.String field_name, short field_type, int src_offset, int dest_offset, int n, java.lang.Object value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or if the value field is not of the type required for the field_type specified, or the name
incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerInvalidTypeException
- If field_type is BrokerTypeDef.FIELD_TYPE_SEQUENCE or is not a supported field type.BrokerNullParameterException
- If field_name or value are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setSequenceFieldSize(java.lang.String field_name, int size) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not a sequence, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If size is less than zero.BrokerException
public void setStructFieldFromEvent(java.lang.String field_name, BrokerEvent value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not a structure, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If value is null.BrokerException
public void setStructSeqFieldFromEvents(java.lang.String field_name, int src_offset, int dest_offset, int n, BrokerEvent[] value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name or value are null, or if any of the elements in the value array are null.BrokerOutOfRangeException
- If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.BrokerException
public void setField(java.lang.String field_name, short field_type, java.lang.Object value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the value object type does not match the field_type specified, or the name incorrectly
accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerInvalidTypeException
- If field_type is BrokerTypeDef.FIELD_TYPE_SEQUENCE or is not a supported field type.BrokerNullParameterException
- If field_name or value are null.BrokerException
public void setField(java.lang.String field_name, BrokerField field) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the value object type does not match the field_type specified, or the name incorrectly
accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerInvalidTypeException
- If the field_type field is BrokerTypeDef.FIELD_TYPE_SEQUENCE or is not a supported field type.BrokerNullParameterException
- If field_name, field, or the value field in 'field' are null.BrokerException
public byte getByteField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public short getShortField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public int getIntegerField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public long getLongField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public float getFloatField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public double getDoubleField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public boolean getBooleanField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public BrokerDate getDateField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public char getCharField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public char getUCCharField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public java.lang.String getStringField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public java.lang.String getUCStringField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public byte[] getByteSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public short[] getShortSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public short[] getShortSeqFieldInternal(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerException
public int[] getIntegerSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public long[] getLongSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public float[] getFloatSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public double[] getDoubleSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public boolean[] getBooleanSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public BrokerDate[] getDateSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public char[] getCharSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public char[] getUCCharSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public java.lang.String[] getStringSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public java.lang.String[] getUCStringSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public int getSequenceFieldSize(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public BrokerField getSequenceField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerInvalidTypeException
- If the field is a sequence of sequences.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public BrokerEvent getStructFieldAsEvent(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerException
public BrokerEvent[] getStructSeqFieldAsEvents(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerException
public BrokerField getField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerInvalidTypeException
- If the field is a sequence.BrokerNullParameterException
- If field_name is null.BrokerException
public java.lang.String[] getFieldNames(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerException
public boolean isFieldSet(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public boolean isFieldSetInternal(java.lang.String field_name) throws BrokerException
BrokerException
public void clear()
public void clearField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void clearField(java.lang.String field_name, boolean ignoreEx) throws BrokerException
field_name
- is the field that needs to be cleared from event.ignoreEx
- set to true, no exception is thrown if field is not found ignoreEx is set to false, exception is thrown if field is not found.BrokerFieldNotFoundException
- If the field name does not exist in the event and ignoreEx is set to false.BrokerFieldTypeMismatchException
- If the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerException
public void clearFieldInternal(java.lang.String field_name, boolean ignoreEx) throws BrokerException
BrokerException
public void validate(BrokerClient client) throws BrokerException
BrokerFieldTypeMismatchException
- If the event does not pass validation.BrokerInvalidClientException
- If the client parameter is null and the event is not typechecked.BrokerException
public int getTag() throws BrokerException
BrokerFieldNotFoundException
- If "_env.tag" is not set on the event.BrokerException
public void setTag(int tag) throws BrokerException
BrokerException
public boolean isLastReply()
public boolean isErrorReply()
public boolean isAckReply()
public boolean isNullReply()
public boolean hasBeenModified()
public void clearModificationFlag()
public void setModificationFlag()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(java.util.Locale locale)
public java.lang.String toString(int indent_level)
public java.lang.String toString(int indent_level, java.util.Locale locale)
public java.lang.String toLocalizedString()
toString(java.util.Locale.getDefault())
public java.lang.String toFormattedString(java.lang.String formatString) throws BrokerException
toFormattedString(formatString, java.util.Locale.US)
. See class BrokerFormat for details.BrokerException
public java.lang.String toFormattedString(java.lang.String formatString, java.util.Locale locale) throws BrokerException
BrokerException
public java.lang.String toLocalizedFormattedString(java.lang.String formatString) throws BrokerException
toFormattedString(formatString, java.util.Locale.getDefault())
See class BrokerFormat for details.BrokerException
public static java.lang.String stringToANSI(java.lang.String st)
public static java.lang.String stringFromANSI(java.lang.String st)
public byte[] toBinData()
public static BrokerEvent fromBinData(BrokerClient client, byte[] data, java.lang.String event_type_name) throws BrokerException
BrokerCorruptDataException
- If data is not a valid event.BrokerNoPermissionException
- If a client is specified and the client does not have permission to publish or subscribe to the event type.BrokerNullParameterException
- If data is null.BrokerUnknownEventTypeException
- If a client is specified and the broker does not have an event type with the specified name.BrokerException
public static BrokerEvent fromBinData(BrokerClient client, byte[] data) throws BrokerException
BrokerException
protected COM.activesw.api.client.NativeEvent getNativeEvent()
protected COM.activesw.api.client.NativeFieldIterator getBodyIterator()
protected COM.activesw.api.client.NativeFieldIterator getEnvelopeIterator()
protected COM.activesw.api.client.NativeStruct getBody()
protected COM.activesw.api.client.NativeStruct getEnvelope()
protected byte[] getWireEvent()
public void setWireEvent(byte[] w_event)
public byte[] toWireEvent() throws BrokerException
BrokerException
protected static void checkSetEnvField(java.lang.String field_name, java.lang.String full_field_name) throws BrokerException
BrokerException
public BrokerEvent getEventField(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerException
public void setEventField(java.lang.String field_name, BrokerEvent value) throws BrokerException
BrokerFieldNotFoundException
- If the event is associated with a client and the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not a structure, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If value is null.BrokerNotImplementedException
- If this event is not typechecked.BrokerException
public BrokerEvent[] getEventSeqField(java.lang.String field_name, int offset, int max_n) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerNotImplementedException
- If this event is not typechecked.BrokerException
public void setEventSeqField(java.lang.String field_name, int src_offset, int dest_offset, int n, BrokerEvent[] value) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerNullParameterException
- If field_name is null.BrokerOutOfRangeException
- If offset is less than zero or greater than the sequence size, or max_n is less than zero.BrokerNotImplementedException
- If this event is not typechecked.BrokerException
public void setStringProperty(java.lang.String property_name, java.lang.String value) throws BrokerException
BrokerException
public void setLongProperty(java.lang.String property_name, long value) throws BrokerException
BrokerException
public void setShortProperty(java.lang.String property_name, short value) throws BrokerException
BrokerException
public void setFloatProperty(java.lang.String property_name, float value) throws BrokerException
BrokerException
public void setIntProperty(java.lang.String property_name, int value) throws BrokerException
BrokerException
public void setDoubleProperty(java.lang.String property_name, double value) throws BrokerException
BrokerException
public void setBooleanProperty(java.lang.String property_name, boolean value) throws BrokerException
BrokerException
public void setByteProperty(java.lang.String property_name, byte value) throws BrokerException
BrokerException
public void setNullProperty(java.lang.String property_name, java.lang.String value) throws BrokerException
BrokerException
public java.lang.String getStringProperty(java.lang.String property_name) throws BrokerException
BrokerException
public int getIntProperty(java.lang.String property_name) throws BrokerException
BrokerException
public double getDoubleProperty(java.lang.String property_name) throws BrokerException
BrokerException
public short getShortProperty(java.lang.String property_name) throws BrokerException
BrokerException
public byte getByteProperty(java.lang.String property_name) throws BrokerException
BrokerException
public float getFloatProperty(java.lang.String property_name) throws BrokerException
BrokerException
public boolean getBooleanProperty(java.lang.String property_name) throws BrokerException
BrokerException
public long getLongProperty(java.lang.String property_name) throws BrokerException
BrokerException
public java.lang.Object getProperty(java.lang.String property_name) throws BrokerException
BrokerException
public java.lang.String[] getPropertyNames(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event.BrokerFieldTypeMismatchException
- If the name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerException
public int getPriority()
public void setPriority(int priority) throws BrokerOutOfRangeException
BrokerOutOfRangeException
- - the specified priority is not in the legal range
Copyright © 2002-2006 webMethods, Inc. Copyright © 2007-2021 Software AG Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.