org.nuxeo.runtime.pubsub

Class PubSubServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.runtime.pubsub.PubSubServiceImpl

All Implemented Interfaces:

Adaptable, Component, Extensible, PubSubService, TimestampedService

public class PubSubServiceImpl
extends DefaultComponent
implements PubSubService

Implementation for the Publish/Subscribe Service.

Since:

9.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_XP
protected Map<String,String>	options
protected PubSubProvider	provider The currently-configured provider.
protected PubSubProviderDescriptor	providerDescriptor The descriptor for the currently-configured provider, or null if it's the default.
protected List<PubSubProviderDescriptor>	providerDescriptors All the registered descriptors.
protected Map<String,List<BiConsumer<String,byte[]>>>	subscribers List of subscribers for each topic.

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified

Constructor Summary

Constructors

Constructor and Description
PubSubServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	deactivate(ComponentContext context) Deactivates the component.
int	getApplicationStartedOrder() The component notification order for Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext).
protected void	providerDescriptorChanged()
void	publish(String topic, byte[] message) Publishes a message to the given topic.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
protected void	registerProvider(PubSubProviderDescriptor descriptor)
void	registerSubscriber(String topic, BiConsumer<String,byte[]> subscriber) Registers a subscriber for the given topic.
void	start(ComponentContext context) Start the component.
void	stop(ComponentContext context) Stop the component.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
protected void	unregisterProvider(PubSubProviderDescriptor descriptor)
void	unregisterSubscriber(String topic, BiConsumer<String,byte[]> subscriber) Unregisters a subscriber for the given topic.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

getAdapter, getLastModified, registerExtension, setLastModified, setModifiedNow, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted

Field Detail

CONFIG_XP

public static final String CONFIG_XP

See Also:

Constant Field Values

providerDescriptors

protected List<PubSubProviderDescriptor> providerDescriptors

All the registered descriptors.

provider

protected PubSubProvider provider

The currently-configured provider.

providerDescriptor

protected PubSubProviderDescriptor providerDescriptor

The descriptor for the currently-configured provider, or null if it's the default.

subscribers

protected Map<String,List<BiConsumer<String,byte[]>>> subscribers

List of subscribers for each topic.

options

protected Map<String,String> options

Constructor Detail

PubSubServiceImpl

public PubSubServiceImpl()

Method Detail

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

stop

public void stop(ComponentContext context)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

getApplicationStartedOrder

public int getApplicationStartedOrder()

Description copied from interface: Component

The component notification order for Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext).

Components are notified in increasing order. Order 1000 is the default order for components that don't care. Order 100 is the repository initialization.

Specified by:

getApplicationStartedOrder in interface Component

Returns:

the order, 1000 by default

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

registerProvider

protected void registerProvider(PubSubProviderDescriptor descriptor)

unregisterProvider

protected void unregisterProvider(PubSubProviderDescriptor descriptor)

providerDescriptorChanged

protected void providerDescriptorChanged()

publish

public void publish(String topic,
                    byte[] message)

Description copied from interface: PubSubService

Publishes a message to the given topic.

Specified by:

publish in interface PubSubService

Parameters:

topic - the topic

message - the message

registerSubscriber

public void registerSubscriber(String topic,
                               BiConsumer<String,byte[]> subscriber)

Description copied from interface: PubSubService

Registers a subscriber for the given topic.

The subscriber must deal with the message without delay and return immediately, usually by storing it in a thread-safe datastructure.

Specified by:

registerSubscriber in interface PubSubService

Parameters:

topic - the topic

subscriber - the subscriber, who will receive the topic and a byte[] message

unregisterSubscriber

public void unregisterSubscriber(String topic,
                                 BiConsumer<String,byte[]> subscriber)

Description copied from interface: PubSubService

Unregisters a subscriber for the given topic.

Specified by:

unregisterSubscriber in interface PubSubService

Parameters:

topic - the topic

subscriber - the subscriber