PublisherModule (Miscellaneous Modules 4.1.1 API)

java.lang.Object
- org.marketcetera.module.Module
- - org.marketcetera.module.AbstractDataReemitterModule
  - - org.marketcetera.modules.publisher.PublisherModule

All Implemented Interfaces:: DataEmitter, DataReceiver

public class PublisherModule
extends AbstractDataReemitterModule

Publishes received data to a given publisher before optionally passing it on in the flow.

Module Features

Describes the module attributes
Capabilities	Data Emitter, Data Receiver
Stops data flows	No
Start Operation	None
Stop Operation	None
Management Interface	None
MX Notification	None
Factory	`PublisherModuleFactory`

Since:: $Release$
Version:: $Id$
Author:: Colin DuPlantis

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  private Subscriber subscriber
  subscriber to which to publish data
- Constructor Summary
  
  Constructors
  Constructor Description
  
  PublisherModule(ModuleURN inModuleURN, Subscriber inSubscriber)
  Create a new PublisherModule instance.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  void receiveData(DataFlowID inFlowID, Object inData)
  - Methods inherited from class org.marketcetera.module.AbstractDataReemitterModule
    cancel, getDataSupport, onReceiveData, preStart, preStop, requestData
  - Methods inherited from class org.marketcetera.module.Module
    getCreated, getLastStartFailure, getLastStopFailure, getStarted, getState, getStopped, getURN, isAutoCreated, isAutoStart
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - subscriber
```
private Subscriber subscriber
```
    subscriber to which to publish data
- Constructor Detail
  - PublisherModule
```
PublisherModule(ModuleURN inModuleURN,
                Subscriber inSubscriber)
```
    Create a new PublisherModule instance.
    
    Parameters:
    
    inModuleURN - a ModuleURN value
    
    inSubscriber - an Subscriber value
- Method Detail
  - receiveData
```
public void receiveData(DataFlowID inFlowID,
                        Object inData)
                 throws ReceiveDataException
```
    Specified by:
    
    receiveData in interface DataReceiver
    
    Overrides:
    
    receiveData in class AbstractDataReemitterModule
    
    Throws:
    
    ReceiveDataException