ApplicationFunctionalAdapter (QuickFIX/J Distribution 2.3.0 API)

java.lang.Object
- quickfix.ApplicationFunctionalAdapter

All Implemented Interfaces:

Application

Direct Known Subclasses:

ApplicationExtendedFunctionalAdapter
```
public class ApplicationFunctionalAdapter
extends Object
implements Application
```
This is an adapter implementation of Application interface that transforms the usage into more functional style. It breaks down each interface method into a number of single-method interfaces, which can be supplied with lambda expressions. Each single-method interface has its own add and remove listener method.
1. Support multiple listeners of the same operation, e.g. onLogon. The method of the listeners will be invoked in the same order of when add method was invoked, i.e. FIFO
2. Support type-safe listeners to be registered. However, FIFO order is maintained separated for type-safe and generic Message listeners
3. Support fail fast exception propagation for fromAdmin, toApp, and fromApp. The exception will be thrown for the first encountered exception.
4. Provides a thread-safe way to delegate to, add and remove listeners, by the means of concurrent and immutable collections, under the assumption that adding and removing listeners are rare.

Constructor Summary

Constructors
Constructor and Description

ApplicationFunctionalAdapter()

Constructors
Constructor and Description
`ApplicationFunctionalAdapter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Message> void`	`addFromAdminListener(Class<T> clazz, FromAdminListener<T> fromAdminListener)` Add a listener of fromAdmin operation.
`void`	`addFromAdminListener(FromAdminListener<Message> fromAdminListener)` Add a listener of fromAdmin operation.
`<T extends Message> void`	`addFromAppListener(Class<T> clazz, FromAppListener<T> fromAppListener)` Add a listener of fromApp operation.
`void`	`addFromAppListener(FromAppListener<Message> fromAppListener)` Add a listener of fromApp operation.
`void`	`addOnCreateListener(Consumer<SessionID> onCreateListener)` Add a Consumer of SessionID to listen to onCreate operation.
`void`	`addOnLogonListener(Consumer<SessionID> onLogonListener)` Add a Consumer of SessionID to listen to onLogon operation.
`void`	`addOnLogoutListener(Consumer<SessionID> onLogoutListener)` Add a Consumer of SessionID to listen to onLogout operation.
`void`	`addToAdminListener(BiConsumer<Message,SessionID> toAdminListener)` Add a BiConsumer of SessionID to listen to toAdmin operation.
`<T extends Message> void`	`addToAdminListener(Class<T> clazz, BiConsumer<T,SessionID> toAdminListener)` Add a type-safe BiConsumer of SessionID to listen to toAdmin operation.
`<T extends Message> void`	`addToAppListener(Class<T> clazz, ToAppListener<T> toAppListener)` Add a listener of toApp operation.
`void`	`addToAppListener(ToAppListener<Message> toAppListener)` Add a listener of toApp operation.
`void`	`fromAdmin(Message message, SessionID sessionId)` This callback notifies you when an administrative message is sent from a counterparty to your FIX engine.
`void`	`fromApp(Message message, SessionID sessionId)` This callback receives messages for the application.
`void`	`onCreate(SessionID sessionId)` This method is called when quickfix creates a new session.
`void`	`onLogon(SessionID sessionId)` This callback notifies you when a valid logon has been established with a counter party.
`void`	`onLogout(SessionID sessionId)` This callback notifies you when an FIX session is no longer online.
`<T extends Message> void`	`removeFromAdminListener(FromAdminListener<T> fromAdminListener)` Remove a listener of fromAdmin operation.
`<T extends Message> void`	`removeFromAppListener(FromAppListener<T> fromAppListener)` Remove a listener of fromApp operation.
`void`	`removeOnCreateListener(Consumer<SessionID> onCreateListener)` Remove a Consumer of SessionID from onCreate operation.
`void`	`removeOnLogonListener(Consumer<SessionID> onLogonListener)` Remove a Consumer of SessionID from onLogon operation.
`void`	`removeOnLogoutListener(Consumer<SessionID> onLogoutListener)` Remove a Consumer of SessionID from onLogout operation.
`<T extends Message> void`	`removeToAdminListener(BiConsumer<T,SessionID> toAdminListener)` Remove a BiConsumer of SessionID from toAdmin operation.
`<T extends Message> void`	`removeToAppListener(ToAppListener<T> toAppListener)` Remove a listener of toApp operation.
`void`	`toAdmin(Message message, SessionID sessionId)` This callback provides you with a peek at the administrative messages that are being sent from your FIX engine to the counter party.
`void`	`toApp(Message message, SessionID sessionId)` This is a callback for application messages that you are sending to a counterparty.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApplicationFunctionalAdapter
```
public ApplicationFunctionalAdapter()
```
- Method Detail
  - addOnCreateListener
```
public void addOnCreateListener(Consumer<SessionID> onCreateListener)
```
    Add a Consumer of SessionID to listen to onCreate operation.
    
    Parameters:
    
    onCreateListener - the Consumer of Session for onCreate operation.
  - removeOnCreateListener
```
public void removeOnCreateListener(Consumer<SessionID> onCreateListener)
```
    Remove a Consumer of SessionID from onCreate operation.
    
    Parameters:
    
    onCreateListener - the Consumer of Session for onCreate operation.
  - addOnLogonListener
```
public void addOnLogonListener(Consumer<SessionID> onLogonListener)
```
    Add a Consumer of SessionID to listen to onLogon operation.
    
    Parameters:
    
    onLogonListener - the Consumer of Session for onLogon operation.
  - removeOnLogonListener
```
public void removeOnLogonListener(Consumer<SessionID> onLogonListener)
```
    Remove a Consumer of SessionID from onLogon operation.
    
    Parameters:
    
    onLogonListener - the Consumer of Session for onLogon operation.
  - addOnLogoutListener
```
public void addOnLogoutListener(Consumer<SessionID> onLogoutListener)
```
    Add a Consumer of SessionID to listen to onLogout operation.
    
    Parameters:
    
    onLogoutListener - the Consumer of Session for onLogout operation.
  - removeOnLogoutListener
```
public void removeOnLogoutListener(Consumer<SessionID> onLogoutListener)
```
    Remove a Consumer of SessionID from onLogout operation.
    
    Parameters:
    
    onLogoutListener - the Consumer of Session for onLogout operation.
  - addToAdminListener
```
public void addToAdminListener(BiConsumer<Message,SessionID> toAdminListener)
```
    Add a BiConsumer of SessionID to listen to toAdmin operation.
    
    Parameters:
    
    toAdminListener - the BiConsumer of Session for toAdmin operation.
  - addToAdminListener
```
public <T extends Message> void addToAdminListener(Class<T> clazz,
                                                   BiConsumer<T,SessionID> toAdminListener)
```
    Add a type-safe BiConsumer of SessionID to listen to toAdmin operation.
    
    Parameters:
    
    clazz - the specific Message class the listener expects
    
    toAdminListener - the BiConsumer of Session for toAdmin operation.
  - removeToAdminListener
```
public <T extends Message> void removeToAdminListener(BiConsumer<T,SessionID> toAdminListener)
```
    Remove a BiConsumer of SessionID from toAdmin operation.
    
    Parameters:
    
    toAdminListener - the BiConsumer of Session for toAdmin operation.
  - addFromAdminListener
```
public void addFromAdminListener(FromAdminListener<Message> fromAdminListener)
```
    Add a listener of fromAdmin operation.
    
    Parameters:
    
    fromAdminListener - the listener of fromAdmin operation.
  - addFromAdminListener
```
public <T extends Message> void addFromAdminListener(Class<T> clazz,
                                                     FromAdminListener<T> fromAdminListener)
```
    Add a listener of fromAdmin operation.
    
    Parameters:
    
    clazz - the specific Message class the listener expects
    
    fromAdminListener - the listener of fromAdmin operation.
  - removeFromAdminListener
```
public <T extends Message> void removeFromAdminListener(FromAdminListener<T> fromAdminListener)
```
    Remove a listener of fromAdmin operation.
    
    Parameters:
    
    fromAdminListener - the listener of fromAdmin operation.
  - addToAppListener
```
public void addToAppListener(ToAppListener<Message> toAppListener)
```
    Add a listener of toApp operation.
    
    Parameters:
    
    toAppListener - the listener of fromAdmin operation.
  - addToAppListener
```
public <T extends Message> void addToAppListener(Class<T> clazz,
                                                 ToAppListener<T> toAppListener)
```
    Add a listener of toApp operation.
    
    Parameters:
    
    clazz - the specific Message class the listener expects
    
    toAppListener - the listener of fromAdmin operation.
  - removeToAppListener
```
public <T extends Message> void removeToAppListener(ToAppListener<T> toAppListener)
```
    Remove a listener of toApp operation.
    
    Parameters:
    
    toAppListener - the listener of toApp operation.
  - addFromAppListener
```
public void addFromAppListener(FromAppListener<Message> fromAppListener)
```
    Add a listener of fromApp operation.
    
    Parameters:
    
    fromAppListener - the listener of fromApp operation.
  - addFromAppListener
```
public <T extends Message> void addFromAppListener(Class<T> clazz,
                                                   FromAppListener<T> fromAppListener)
```
    Add a listener of fromApp operation.
    
    Parameters:
    
    clazz - the specific Message class the listener expects
    
    fromAppListener - the listener of fromApp operation.
  - removeFromAppListener
```
public <T extends Message> void removeFromAppListener(FromAppListener<T> fromAppListener)
```
    Remove a listener of fromApp operation.
    
    Parameters:
    
    fromAppListener - the listener of fromApp operation.
  - onCreate
```
public void onCreate(SessionID sessionId)
```
    Description copied from interface: Application
    
    This method is called when quickfix creates a new session. A session comes into and remains in existence for the life of the application. Sessions exist whether or not a counter party is connected to it. As soon as a session is created, you can begin sending messages to it. If no one is logged on, the messages will be sent at the time a connection is established with the counterparty.
    
    Specified by:
    
    onCreate in interface Application
  - onLogon
```
public void onLogon(SessionID sessionId)
```
    Description copied from interface: Application
    
    This callback notifies you when a valid logon has been established with a counter party. This is called when a connection has been established and the FIX logon process has completed with both parties exchanging valid logon messages.
    
    Specified by:
    
    onLogon in interface Application
    
    Parameters:
    
    sessionId - QuickFIX session ID
  - onLogout
```
public void onLogout(SessionID sessionId)
```
    Description copied from interface: Application
    
    This callback notifies you when an FIX session is no longer online. This could happen during a normal logout exchange or because of a forced termination or a loss of network connection.
    
    Specified by:
    
    onLogout in interface Application
    
    Parameters:
    
    sessionId - QuickFIX session ID
  - toAdmin
```
public void toAdmin(Message message,
                    SessionID sessionId)
```
    Description copied from interface: Application
    
    This callback provides you with a peek at the administrative messages that are being sent from your FIX engine to the counter party. This is normally not useful for an application however it is provided for any logging you may wish to do. You may add fields in an adminstrative message before it is sent.
    
    Specified by:
    
    toAdmin in interface Application
    
    Parameters:
    
    message - QuickFIX message
    
    sessionId - QuickFIX session ID
  - fromAdmin
```
public void fromAdmin(Message message,
                      SessionID sessionId)
               throws FieldNotFound,
                      IncorrectDataFormat,
                      IncorrectTagValue,
                      RejectLogon
```
    Description copied from interface: Application
    
    This callback notifies you when an administrative message is sent from a counterparty to your FIX engine. This can be useful for doing extra validation on logon messages such as for checking passwords. Throwing a RejectLogon exception will disconnect the counterparty.
    
    Specified by:
    
    fromAdmin in interface Application
    
    Parameters:
    
    message - QuickFIX message
    
    sessionId - QuickFIX session ID
    
    Throws:
    
    FieldNotFound
    
    IncorrectDataFormat
    
    IncorrectTagValue
    
    RejectLogon - causes a logon reject
  - toApp
```
public void toApp(Message message,
                  SessionID sessionId)
           throws DoNotSend
```
    Description copied from interface: Application
    
    This is a callback for application messages that you are sending to a counterparty. If you throw a DoNotSend exception in this function, the application will not send the message. This is mostly useful if the application has been asked to resend a message such as an order that is no longer relevant for the current market. Messages that are being resent are marked with the PossDupFlag in the header set to true; If a DoNotSend exception is thrown and the flag is set to true, a sequence reset will be sent in place of the message. If it is set to false, the message will simply not be sent. You may add fields before an application message before it is sent out.
    
    Specified by:
    
    toApp in interface Application
    
    Parameters:
    
    message - QuickFIX message
    
    sessionId - QuickFIX session ID
    
    Throws:
    
    DoNotSend - This exception aborts message transmission
  - fromApp
```
public void fromApp(Message message,
                    SessionID sessionId)
             throws FieldNotFound,
                    IncorrectDataFormat,
                    IncorrectTagValue,
                    UnsupportedMessageType
```
    Description copied from interface: Application
    
    This callback receives messages for the application. This is one of the core entry points for your FIX application. Every application level request will come through here. If, for example, your application is a sell-side OMS, this is where you will get your new order requests. If you were a buy side, you would get your execution reports here. If a FieldNotFound exception is thrown, the counterparty will receive a reject indicating a conditionally required field is missing. The Message class will throw this exception when trying to retrieve a missing field, so you will rarely need the throw this explicitly. You can also throw an UnsupportedMessageType exception. This will result in the counterparty getting a business reject informing them your application cannot process those types of messages. An IncorrectTagValue can also be thrown if a field contains a value that is out of range or you do not support.
    
    Specified by:
    
    fromApp in interface Application
    
    Parameters:
    
    message - QuickFIX message
    
    sessionId - QuickFIX session ID
    
    Throws:
    
    FieldNotFound
    
    IncorrectDataFormat
    
    IncorrectTagValue
    
    UnsupportedMessageType

Class ApplicationFunctionalAdapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApplicationFunctionalAdapter

Method Detail

addOnCreateListener

removeOnCreateListener

addOnLogonListener

removeOnLogonListener

addOnLogoutListener

removeOnLogoutListener

addToAdminListener

addToAdminListener

removeToAdminListener

addFromAdminListener

addFromAdminListener

removeFromAdminListener

addToAppListener

addToAppListener

removeToAppListener

addFromAppListener

addFromAppListener

removeFromAppListener

onCreate

onLogon

onLogout

toAdmin

fromAdmin

toApp

fromApp