com.apama.services.event
Class ChannelConfig

java.lang.Object
  com.apama.services.event.ChannelConfig

public class ChannelConfig
extends java.lang.Object

ChannelConfig is a helper class that assists in building a properies map for use when creating a new EventServiceChannel via the IEventService.addChannel() method.

Any configuration property not explicitly specified will take its default value. Defaults are available for all configuration properties, in the same interface as the property.

Method Summary

static void	setDefaultRequestResponseTimeout(java.util.Map<java.lang.String,java.lang.Object> properties, long timeoutms) Set the configuration property to indicate the default request-response timeout that a new EventServiceChannel should use.
static void	setEnforceResponseSequencing(java.util.Map<java.lang.String,java.lang.Object> properties, boolean enforce) Set the configuration property to indicate if a new EventServiceChannel should use strict response sequencing for synchronous request-response invocations.
static void	setInboundEventQueueSoftReferencePrefixes(java.util.Map<java.lang.String,java.lang.Object> properties, java.util.Set<java.lang.String> prefixes) Set the configuration property to indicate for which event names a new EventServiceChannel should use SoftReferences in the inbound queue.
static void	setMessageIdFieldName(java.util.Map<java.lang.String,java.lang.Object> properties, java.lang.String fieldname) Set the configuration property to indicate the field name of message ID's (for request-response) that a new EventServiceChannel should use.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setEnforceResponseSequencing

public static void setEnforceResponseSequencing(java.util.Map<java.lang.String,java.lang.Object> properties,
                                                boolean enforce)

Set the configuration property to indicate if a new EventServiceChannel should use strict response sequencing for synchronous request-response invocations.

Parameters:

properties - The Map in which the configuration properties should be updated.

enforce - The new value of the property.

See Also:

IEventServiceChannel.CONFIG_ENFORCE_RESPONSE_SEQUENCING, IEventServiceChannel.DEFAULT_ENFORCE_RESPONSE_SEQUENCING

setInboundEventQueueSoftReferencePrefixes

public static void setInboundEventQueueSoftReferencePrefixes(java.util.Map<java.lang.String,java.lang.Object> properties,
                                                             java.util.Set<java.lang.String> prefixes)

Set the configuration property to indicate for which event names a new EventServiceChannel should use SoftReferences in the inbound queue.

Parameters:

properties - The Map in which the configuration properties should be updated.

prefixes - The new value of the property. Each value of the Set must be a String.

See Also:

IEventServiceChannel.CONFIG_INBOUND_EVENT_QUEUE_SOFT_REFERENCE_PREFIXES, IEventServiceChannel.DEFAULT_INBOUND_EVENT_QUEUE_SOFT_REFERENCE_PREFIXES

setDefaultRequestResponseTimeout

public static void setDefaultRequestResponseTimeout(java.util.Map<java.lang.String,java.lang.Object> properties,
                                                    long timeoutms)

Set the configuration property to indicate the default request-response timeout that a new EventServiceChannel should use.

Parameters:

properties - The Map in which the configuration properties should be updated.

timeoutms - The new value of the property.

See Also:

IEventServiceChannel.CONFIG_DEFAULT_REQUEST_RESPONSE_TIMEOUT, IEventServiceChannel.DEFAULT_REQUEST_RESPONSE_TIMEOUT_MS

setMessageIdFieldName

public static void setMessageIdFieldName(java.util.Map<java.lang.String,java.lang.Object> properties,
                                         java.lang.String fieldname)

Set the configuration property to indicate the field name of message ID's (for request-response) that a new EventServiceChannel should use.

Parameters:

properties - The Map in which the configuration properties should be updated.

fieldname - The new value of the property.

See Also:

IEventServiceChannel.CONFIG_MESSAGEID_FIELD_NAME, IEventServiceChannel.DEFAULT_MESSAGEID_FIELD_NAME