org.jacorb.notification.servant

Class AbstractProxySupplier

public abstract class AbstractProxySupplier extends AbstractProxy implements MessageConsumer, NotifySubscribeOperations, AbstractProxySupplierMBean

Abstract base class for ProxySuppliers. This class provides base functionality for the different ProxySuppliers:

Version: $Id: AbstractProxySupplier.java,v 1.31 2006/05/23 10:50:35 alphonse.bendt Exp $

Author: Alphonse Bendt

UNKNOWN: extends = "AbstractProxyMBean" name = "notification.proxy.message_discarded" description = "queue overflow causes messages to be discarded" notificationType = "java.lang.String"

Constructor Summary
protected AbstractProxySupplier(IAdmin admin, ORB orb, POA poa, Configuration conf, TaskProcessor taskProcessor, OfferManager offerManager, SubscriptionManager subscriptionManager, ConsumerAdmin consumerAdmin)
Method Summary
voidclearPendingMessageQueue()
protected voidclientDisconnected()
intcompareTo(Object o)
voidconnectClient(Object client)
voiddispose()
protected voidenqueue(Message message)
put a copy of the Message in the queue of pending Messages.
protected Message[]getAllMessages()
protected Message[]getAtLeastMessages(int min)
protected abstract longgetCost()
StringgetDiscardPolicy()
intgetErrorThreshold()
intgetMaxEventsPerConsumer()
MessagegetMessageBlocking()
MessageConsumergetMessageConsumer()
protected MessagegetMessageNoBlock()
protected EventQueueFactorygetMessageQueueFactory()
intgetNumberOfDiscardedMessages()
StringgetOrderPolicy()
intgetPendingMessagesCount()
ListgetSubsequentFilterStages()
protected Message[]getUpToMessages(int max)
booleanhasMessageConsumer()
booleanhasPendingData()
booleanisRetryAllowed()
protected voidmessageQueued()
this is an extension point.
ConsumerAdminMyAdmin()
EventType[]obtain_offered_types(ObtainInfoMode obtainInfoMode)
voidqueueMessage(Message message)
protected voidremoveListener()
voidsetMaxEventsPerConsumer(int max)
voidsubscription_change(EventType[] added, EventType[] removed)

Constructor Detail

AbstractProxySupplier

protected AbstractProxySupplier(IAdmin admin, ORB orb, POA poa, Configuration conf, TaskProcessor taskProcessor, OfferManager offerManager, SubscriptionManager subscriptionManager, ConsumerAdmin consumerAdmin)

Method Detail

clearPendingMessageQueue

public void clearPendingMessageQueue()

UNKNOWN: impact = "ACTION" description = "delete all queued Messages"

clientDisconnected

protected final void clientDisconnected()

compareTo

public int compareTo(Object o)

connectClient

public void connectClient(Object client)

dispose

public final void dispose()

enqueue

protected void enqueue(Message message)
put a copy of the Message in the queue of pending Messages.

Parameters: message the Message to queue.

getAllMessages

protected Message[] getAllMessages()

getAtLeastMessages

protected Message[] getAtLeastMessages(int min)

Parameters: min minimum number of messages

Returns: an array containing the requested number of Messages or null

getCost

protected abstract long getCost()

getDiscardPolicy

public final String getDiscardPolicy()

UNKNOWN: description = "current DiscardPolicy" access = "read-only"

getErrorThreshold

public int getErrorThreshold()

getMaxEventsPerConsumer

public final int getMaxEventsPerConsumer()

UNKNOWN: description = "maximum number of events that may be queued per consumer" access = "read-write"

getMessageBlocking

public Message getMessageBlocking()

getMessageConsumer

public final MessageConsumer getMessageConsumer()

getMessageNoBlock

protected Message getMessageNoBlock()

getMessageQueueFactory

protected EventQueueFactory getMessageQueueFactory()

getNumberOfDiscardedMessages

public int getNumberOfDiscardedMessages()

UNKNOWN: access = "read-only"

getOrderPolicy

public final String getOrderPolicy()

UNKNOWN: description = "current OrderPolicy" access = "read-only"

getPendingMessagesCount

public int getPendingMessagesCount()

UNKNOWN: description = "Number of Pending Messages" access = "read-only"

getSubsequentFilterStages

public final List getSubsequentFilterStages()

getUpToMessages

protected Message[] getUpToMessages(int max)

Parameters: max maximum number of messages

Returns: an array containing at most max Messages

hasMessageConsumer

public final boolean hasMessageConsumer()

hasPendingData

public boolean hasPendingData()

isRetryAllowed

public boolean isRetryAllowed()

messageQueued

protected void messageQueued()
this is an extension point.

MyAdmin

public final ConsumerAdmin MyAdmin()

obtain_offered_types

public final EventType[] obtain_offered_types(ObtainInfoMode obtainInfoMode)

queueMessage

public void queueMessage(Message message)

removeListener

protected void removeListener()

setMaxEventsPerConsumer

public void setMaxEventsPerConsumer(int max)

UNKNOWN: access = "read-write"

subscription_change

public final void subscription_change(EventType[] added, EventType[] removed)