org.apache.camel.component.quickfixj.QuickfixjComponent Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.component.quickfixj;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
import org.apache.camel.StartupListener;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.annotations.Component;
import org.apache.camel.support.DefaultComponent;
import org.apache.camel.support.service.ServiceHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import quickfix.LogFactory;
import quickfix.MessageFactory;
import quickfix.MessageStoreFactory;
import quickfix.SessionSettings;
@Component("quickfix")
public class QuickfixjComponent extends DefaultComponent implements StartupListener {
private static final Logger LOG = LoggerFactory.getLogger(QuickfixjComponent.class);
private static final String PARAMETER_LAZY_CREATE_ENGINE = "lazyCreateEngine";
private final Object engineInstancesLock = new Object();
private final Map engines = new HashMap<>();
private final Map provisionalEngines = new HashMap<>();
private final Map endpoints = new HashMap<>();
private Map configurations = new HashMap<>();
@Metadata(label = "advanced")
private MessageStoreFactory messageStoreFactory;
@Metadata(label = "advanced")
private LogFactory logFactory;
@Metadata(label = "advanced")
private MessageFactory messageFactory;
@Metadata
private boolean lazyCreateEngines;
@Metadata(defaultValue = "true")
private boolean eagerStopEngines = true;
public QuickfixjComponent() {
}
public QuickfixjComponent(CamelContext context) {
super(context);
}
@Override
protected Endpoint createEndpoint(String uri, String remaining, Map parameters) throws Exception {
// Look up the engine instance based on the settings file ("remaining")
QuickfixjEngine engine;
synchronized (engineInstancesLock) {
QuickfixjEndpoint endpoint = endpoints.get(uri);
if (endpoint == null) {
engine = engines.get(remaining);
if (engine == null) {
engine = provisionalEngines.get(remaining);
}
if (engine == null) {
QuickfixjConfiguration configuration = configurations.get(remaining);
SessionSettings settings;
if (configuration != null) {
settings = configuration.createSessionSettings();
} else {
settings = QuickfixjEngine.loadSettings(getCamelContext(), remaining);
}
Boolean lazyCreateEngineForEndpoint
= super.getAndRemoveParameter(parameters, PARAMETER_LAZY_CREATE_ENGINE, Boolean.TYPE);
if (lazyCreateEngineForEndpoint == null) {
lazyCreateEngineForEndpoint = isLazyCreateEngines();
}
engine = new QuickfixjEngine(
uri, settings, messageStoreFactory, logFactory, messageFactory,
lazyCreateEngineForEndpoint);
// only start engine if CamelContext is already started, otherwise the engines gets started
// automatic later when CamelContext has been started using the StartupListener
if (getCamelContext().getStatus().isStarted()) {
startQuickfixjEngine(engine);
engines.put(remaining, engine);
} else {
// engines to be started later
provisionalEngines.put(remaining, engine);
}
}
endpoint = new QuickfixjEndpoint(engine, uri, this);
endpoint.setConfigurationName(remaining);
endpoint.setLazyCreateEngine(engine.isLazy());
engine.addEventListener(endpoint);
endpoints.put(uri, endpoint);
}
return endpoint;
}
}
@Override
protected void doStop() throws Exception {
// stop engines when stopping component
synchronized (engineInstancesLock) {
for (QuickfixjEngine engine : engines.values()) {
engine.stop();
}
}
super.doStop();
}
@Override
protected void doShutdown() throws Exception {
// cleanup when shutting down
engines.clear();
provisionalEngines.clear();
endpoints.clear();
super.doShutdown();
}
private void startQuickfixjEngine(QuickfixjEngine engine) {
if (!engine.isLazy()) {
LOG.info("Starting QuickFIX/J engine: {}", engine.getUri());
ServiceHelper.startService(engine);
} else {
LOG.info("QuickFIX/J engine: {} will start lazily", engine.getUri());
}
}
// Test Support
Map getEngines() {
return Collections.unmodifiableMap(engines);
}
// Test Support
Map getProvisionalEngines() {
return Collections.unmodifiableMap(provisionalEngines);
}
/**
* To use the given MessageFactory
*/
public void setMessageFactory(MessageFactory messageFactory) {
this.messageFactory = messageFactory;
}
public MessageFactory getMessageFactory() {
return messageFactory;
}
/**
* To use the given LogFactory
*/
public void setLogFactory(LogFactory logFactory) {
this.logFactory = logFactory;
}
public LogFactory getLogFactory() {
return logFactory;
}
/**
* To use the given MessageStoreFactory
*/
public void setMessageStoreFactory(MessageStoreFactory messageStoreFactory) {
this.messageStoreFactory = messageStoreFactory;
}
public MessageStoreFactory getMessageStoreFactory() {
return messageStoreFactory;
}
public Map getConfigurations() {
return configurations;
}
/**
* To use the given map of pre configured QuickFix configurations mapped to the key
*/
public void setConfigurations(Map configurations) {
this.configurations = configurations;
}
public boolean isLazyCreateEngines() {
return this.lazyCreateEngines;
}
/**
* If set to true, the engines will be created and started when needed (when first message is send)
*/
public void setLazyCreateEngines(boolean lazyCreateEngines) {
this.lazyCreateEngines = lazyCreateEngines;
}
public boolean isEagerStopEngines() {
return eagerStopEngines;
}
/**
* Whether to eager stop engines when there are no active consumer or producers using the engine.
*
* For example when stopping a route, then the engine can be stopped as well. And when the route is started, then
* the engine is started again.
*
* This can be turned off to only stop the engines when Camel is shutdown.
*/
public void setEagerStopEngines(boolean eagerStopEngines) {
this.eagerStopEngines = eagerStopEngines;
}
@Override
public void onCamelContextStarted(CamelContext camelContext, boolean alreadyStarted) throws Exception {
// only start quickfix engines when CamelContext have finished starting
synchronized (engineInstancesLock) {
for (QuickfixjEngine engine : engines.values()) {
startQuickfixjEngine(engine);
}
for (Map.Entry entry : provisionalEngines.entrySet()) {
startQuickfixjEngine(entry.getValue());
engines.put(entry.getKey(), entry.getValue());
}
provisionalEngines.clear();
}
}
public void ensureEngineStarted(QuickfixjEngine engine) {
// only start engine after provisional engines is no longer in use
// as they are used for holding created engines during bootstrap of Camel
if (provisionalEngines.isEmpty()) {
ServiceHelper.startService(engine);
}
}
}