Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,9 @@
import org.flowable.job.service.impl.asyncexecutor.ExecuteAsyncRunnableFactory;
import org.flowable.job.service.impl.asyncexecutor.FailedJobCommandFactory;
import org.flowable.job.service.impl.asyncexecutor.JobManager;
import org.flowable.common.engine.impl.cfg.mail.DefaultMailClientProvider;
import org.flowable.mail.common.api.client.FlowableMailClient;
import org.flowable.mail.common.api.client.MailClientProvider;
import org.flowable.task.service.InternalTaskAssignmentManager;
import org.flowable.task.service.InternalTaskVariableScopeResolver;
import org.flowable.task.service.TaskPostProcessor;
Expand Down Expand Up @@ -526,11 +528,10 @@ public class CmmnEngineConfiguration extends AbstractBuildableEngineConfiguratio
protected HttpClientConfig httpClientConfig = new HttpClientConfig();

// Email
protected FlowableMailClient defaultMailClient;
protected MailClientProvider mailClientProvider = new DefaultMailClientProvider();
protected MailServerInfo defaultMailServer;
protected String mailSessionJndi;
protected Map<String, MailServerInfo> mailServers = new HashMap<>();
protected Map<String, FlowableMailClient> mailClients = new HashMap<>();
protected Map<String, String> mailSessionsJndi = new HashMap<>();

// Async executor
Expand Down Expand Up @@ -929,24 +930,31 @@ public void initExpressionManager() {
}

public void initMailClients() {
if (defaultMailClient == null) {
if (mailClientProvider == null) {
mailClientProvider = new DefaultMailClientProvider();
}
if (!(mailClientProvider instanceof DefaultMailClientProvider defaultMailClientProvider)) {
return; // custom provider handles resolution at runtime
}
if (defaultMailClientProvider.getDefaultMailClient() == null) {
String sessionJndi = getMailSessionJndi();
if (sessionJndi != null) {
defaultMailClient = FlowableMailClientCreator.createSessionClient(sessionJndi, getDefaultMailServer());
defaultMailClientProvider.setDefaultMailClient(FlowableMailClientCreator.createSessionClient(sessionJndi, getDefaultMailServer()));
} else {
MailServerInfo mailServer = getDefaultMailServer();
String host = mailServer.getMailServerHost();
if (host == null) {
throw new FlowableException("no SMTP host is configured for the default mail server");
}
defaultMailClient = FlowableMailClientCreator.createHostClient(host, mailServer);
defaultMailClientProvider.setDefaultMailClient(FlowableMailClientCreator.createHostClient(host, mailServer));
}
}

Collection<String> tenantIds = new HashSet<>(mailSessionsJndi.keySet());
tenantIds.addAll(mailServers.keySet());

if (!tenantIds.isEmpty()) {
Map<String, FlowableMailClient> mailClients = defaultMailClientProvider.getMailClients();
MailServerInfo defaultMailServer = getDefaultMailServer();
for (String tenantId : tenantIds) {
if (mailClients.containsKey(tenantId)) {
Expand Down Expand Up @@ -4078,12 +4086,34 @@ public CmmnEngineConfiguration setHttpClientConfig(HttpClientConfig httpClientCo
return this;
}

public MailClientProvider getMailClientProvider() {
return mailClientProvider;
}

public CmmnEngineConfiguration setMailClientProvider(MailClientProvider mailClientProvider) {
this.mailClientProvider = mailClientProvider;
return this;
}

/**
* @deprecated use {@link #getMailClientProvider()} and {@link MailClientProvider#getMailClient(String)} with tenantId {@code null} instead
*/
@Deprecated
public FlowableMailClient getDefaultMailClient() {
return defaultMailClient;
return mailClientProvider.getMailClient(null);
}

/**
* @deprecated use {@link #setMailClientProvider(MailClientProvider)} instead
*/
@Deprecated
public CmmnEngineConfiguration setDefaultMailClient(FlowableMailClient defaultMailClient) {
this.defaultMailClient = defaultMailClient;
if (mailClientProvider instanceof DefaultMailClientProvider defaultProvider) {
defaultProvider.setDefaultMailClient(defaultMailClient);
} else {
throw new FlowableException("The mail client provider is not an instance of DefaultMailClientProvider. "
+ "Use setMailClientProvider instead.");
}
return this;
}

Expand Down Expand Up @@ -4219,17 +4249,37 @@ public MailServerInfo getMailServer(String tenantId) {
return mailServers.get(tenantId);
}

/**
* @deprecated use {@link #getMailClientProvider()} instead
*/
@Deprecated
public Map<String, FlowableMailClient> getMailClients() {
return mailClients;
if (mailClientProvider instanceof DefaultMailClientProvider defaultProvider) {
return defaultProvider.getMailClients();
}
return Collections.emptyMap();
}

/**
* @deprecated use {@link #setMailClientProvider(MailClientProvider)} instead
*/
@Deprecated
public CmmnEngineConfiguration setMailClients(Map<String, FlowableMailClient> mailClients) {
this.mailClients = mailClients;
if (this.mailClientProvider instanceof DefaultMailClientProvider defaultProvider) {
defaultProvider.getMailClients().putAll(mailClients);
} else {
throw new FlowableException("The mail client provider is not an instance of DefaultMailClientProvider. "
+ "Use setMailClientProvider instead.");
}
return this;
}

/**
* @deprecated use {@link #getMailClientProvider().getMailClient(String)} instead
*/
@Deprecated
public FlowableMailClient getMailClient(String tenantId) {
return mailClients.get(tenantId);
return mailClientProvider.getMailClient(tenantId);
}

public Map<String, String> getMailSessionsJndi() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
*/
package org.flowable.cmmn.engine.impl.behavior.impl.mail;

import org.apache.commons.lang3.StringUtils;
import org.flowable.cmmn.api.delegate.DelegatePlanItemInstance;
import org.flowable.cmmn.api.delegate.PlanItemJavaDelegate;
import org.flowable.cmmn.engine.CmmnEngineConfiguration;
Expand All @@ -35,17 +34,7 @@ public void execute(DelegatePlanItemInstance planItemInstance) {
@Override
protected FlowableMailClient getMailClient(DelegatePlanItemInstance planItemInstance) {
CmmnEngineConfiguration cmmnEngineConfiguration = CommandContextUtil.getCmmnEngineConfiguration();
String tenantId = planItemInstance.getTenantId();
FlowableMailClient mailClient = null;
if (StringUtils.isNotBlank(tenantId)) {
mailClient = cmmnEngineConfiguration.getMailClient(tenantId);
}

if (mailClient == null) {
mailClient = cmmnEngineConfiguration.getDefaultMailClient();
}

return mailClient;
return cmmnEngineConfiguration.getMailClientProvider().getMailClient(planItemInstance.getTenantId());
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
/* Licensed 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.flowable.cmmn.test.task;

import java.util.HashMap;
import java.util.Map;

import org.flowable.cmmn.test.FlowableCmmnTestCase;
import org.flowable.common.engine.impl.cfg.mail.MailServerInfo;
import org.flowable.mail.common.api.client.MailClientProvider;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Tag;
import org.subethamail.wiser.Wiser;

/**
* @author Valentin Zickner
*/
@Tag("email")
public abstract class CmmnEmailTestCase extends FlowableCmmnTestCase {

protected static Wiser wiser;
private MailClientProvider initialMailClientProvider;
private Map<String, MailServerInfo> initialMailServers;

@BeforeAll
public static void setupWiser() throws Exception {
int counter = 0;
boolean serverUpAndRunning = false;
while (!serverUpAndRunning && counter++ < 11) {
wiser = Wiser.port(5025);
try {
wiser.start();
serverUpAndRunning = true;
} catch (RuntimeException e) { // Fix for slow port-closing Jenkins
if (e.getMessage().toLowerCase().contains("bindexception")) {
Thread.sleep(250L);
}
}
}
}

@BeforeEach
public void setUp() {
wiser.getMessages().clear();
initialMailClientProvider = cmmnEngineConfiguration.getMailClientProvider();
reinitializeMailClients();
Map<String, MailServerInfo> mailServers = cmmnEngineConfiguration.getMailServers();
initialMailServers = mailServers == null ? null : new HashMap<>(mailServers);
}

@AfterEach
public void tearDown() {
if (initialMailServers != null) {
cmmnEngineConfiguration.getMailServers().clear();
cmmnEngineConfiguration.getMailServers().putAll(initialMailServers);
}
cmmnEngineConfiguration.setMailClientProvider(initialMailClientProvider);
}

@AfterAll
public static void stopWiser() {
wiser.stop();
}

protected void reinitializeMailClients() {
cmmnEngineConfiguration.setMailClientProvider(null);
cmmnEngineConfiguration.initMailClients();
}

protected void addMailServer(String tenantId, String defaultFrom, String forceTo) {
MailServerInfo mailServerInfo = new MailServerInfo();
mailServerInfo.setMailServerHost("localhost");
mailServerInfo.setMailServerPort(5025);
mailServerInfo.setMailServerUseSSL(false);
mailServerInfo.setMailServerUseTLS(false);
mailServerInfo.setMailServerDefaultFrom(defaultFrom);
mailServerInfo.setMailServerForceTo(forceTo);
mailServerInfo.setMailServerUsername(defaultFrom);
mailServerInfo.setMailServerPassword("password");

cmmnEngineConfiguration.getMailServers().put(tenantId, mailServerInfo);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -33,57 +33,17 @@

import org.apache.commons.lang3.Validate;
import org.flowable.cmmn.engine.test.CmmnDeployment;
import org.flowable.cmmn.test.FlowableCmmnTestCase;
import org.flowable.common.engine.impl.cfg.mail.FlowableMailClientCreator;
import org.flowable.common.engine.impl.cfg.mail.MailServerInfo;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
import org.subethamail.wiser.Wiser;
import org.subethamail.wiser.WiserMessage;

import tools.jackson.databind.node.ArrayNode;

/**
* @author Joram Barrez
*/
@Tag("email")
public class CmmnMailTaskTest extends FlowableCmmnTestCase {

protected static Wiser wiser;

@BeforeAll
public static void setupWiser() throws Exception {
wiser = Wiser.port(5025);

int counter = 0;
boolean serverUpAndRunning = false;
while (!serverUpAndRunning && counter++ < 11) {

wiser = Wiser.port(5025);

try {
wiser.start();
serverUpAndRunning = true;
} catch (RuntimeException e) { // Fix for slow port-closing Jenkins
if (e.getMessage().toLowerCase().contains("bindexception")) {
Thread.sleep(250L);
}
}
}
}

@BeforeEach
public void resetMessages() {
wiser.getMessages().clear();
}

@AfterAll
public static void stopWiser() {
wiser.stop();
}
public class CmmnMailTaskTest extends CmmnEmailTestCase {

@Test
@CmmnDeployment
Expand Down
Loading