This is an automated email from the ASF dual-hosted git repository. quantranhong1999 pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 236e808a59e4934007a6183c3200c50b4be676d6 Author: Quan Tran <[email protected]> AuthorDate: Thu Aug 13 09:44:10 2026 +0700 JAMES-4210 Resolve configured ManageSieve SASL factories with Guice Reuse the shared Guice SASL resolver for configured factory classes while preserving ManageSieve default mechanisms and their stable order. --- .../container/guice/protocols/managedsieve/pom.xml | 4 ++ .../ManageSieveDefaultSaslMechanismFactories.java | 36 ++++++++++++++++++ .../modules/protocols/ManageSieveServerModule.java | 33 +++++++++++++++-- .../protocols/ManageSieveServerModuleTest.java | 43 ++++++++++++++++++++++ 4 files changed, 112 insertions(+), 4 deletions(-) diff --git a/server/container/guice/protocols/managedsieve/pom.xml b/server/container/guice/protocols/managedsieve/pom.xml index d5a15d1e64..fac3b655af 100644 --- a/server/container/guice/protocols/managedsieve/pom.xml +++ b/server/container/guice/protocols/managedsieve/pom.xml @@ -53,6 +53,10 @@ <groupId>${james.protocols.groupId}</groupId> <artifactId>protocols-managesieve</artifactId> </dependency> + <dependency> + <groupId>${james.protocols.groupId}</groupId> + <artifactId>protocols-sasl</artifactId> + </dependency> <dependency> <groupId>com.google.inject</groupId> <artifactId>guice</artifactId> diff --git a/server/container/guice/protocols/managedsieve/src/main/java/org/apache/james/modules/protocols/ManageSieveDefaultSaslMechanismFactories.java b/server/container/guice/protocols/managedsieve/src/main/java/org/apache/james/modules/protocols/ManageSieveDefaultSaslMechanismFactories.java new file mode 100644 index 0000000000..0b8fe00c97 --- /dev/null +++ b/server/container/guice/protocols/managedsieve/src/main/java/org/apache/james/modules/protocols/ManageSieveDefaultSaslMechanismFactories.java @@ -0,0 +1,36 @@ +/**************************************************************** + * 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.james.modules.protocols; + +import static java.lang.annotation.ElementType.FIELD; +import static java.lang.annotation.ElementType.METHOD; +import static java.lang.annotation.ElementType.PARAMETER; +import static java.lang.annotation.RetentionPolicy.RUNTIME; + +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import com.google.inject.BindingAnnotation; + +@BindingAnnotation +@Target({ FIELD, PARAMETER, METHOD }) +@Retention(RUNTIME) +public @interface ManageSieveDefaultSaslMechanismFactories { +} diff --git a/server/container/guice/protocols/managedsieve/src/main/java/org/apache/james/modules/protocols/ManageSieveServerModule.java b/server/container/guice/protocols/managedsieve/src/main/java/org/apache/james/modules/protocols/ManageSieveServerModule.java index 8eb469d48a..7cbd932637 100644 --- a/server/container/guice/protocols/managedsieve/src/main/java/org/apache/james/modules/protocols/ManageSieveServerModule.java +++ b/server/container/guice/protocols/managedsieve/src/main/java/org/apache/james/modules/protocols/ManageSieveServerModule.java @@ -22,19 +22,27 @@ import org.apache.james.ProtocolConfigurationSanitizer; import org.apache.james.RunArguments; import org.apache.james.filesystem.api.FileSystem; import org.apache.james.lifecycle.api.ConfigurationSanitizer; -import org.apache.james.managesieve.api.commands.CoreCommands; -import org.apache.james.managesieve.core.CoreProcessor; import org.apache.james.managesieveserver.netty.ManageSieveServerFactory; +import org.apache.james.managesieveserver.netty.ManageSieveServerFactory.ManageSieveSaslMechanismLoader; +import org.apache.james.protocols.api.sasl.SaslMechanismFactory; import org.apache.james.protocols.lib.netty.CertificateReloadable; +import org.apache.james.protocols.sasl.BuiltInSaslMechanismFactories; +import org.apache.james.protocols.sasl.OauthBearerSaslMechanismFactory; +import org.apache.james.protocols.sasl.PlainSaslMechanismFactory; +import org.apache.james.protocols.sasl.XOauth2SaslMechanismFactory; import org.apache.james.server.core.configuration.ConfigurationProvider; import org.apache.james.util.LoggingLevel; import org.apache.james.utils.GuiceProbe; +import org.apache.james.utils.GuiceSaslMechanismResolver; import org.apache.james.utils.InitializationOperation; import org.apache.james.utils.InitilizationOperationBuilder; import org.apache.james.utils.KeystoreCreator; +import com.google.common.collect.ImmutableList; import com.google.inject.AbstractModule; +import com.google.inject.Provides; import com.google.inject.Scopes; +import com.google.inject.Singleton; import com.google.inject.multibindings.Multibinder; import com.google.inject.multibindings.ProvidesIntoSet; @@ -44,12 +52,29 @@ public class ManageSieveServerModule extends AbstractModule { protected void configure() { install(new SieveModule()); bind(ManageSieveServerFactory.class).in(Scopes.SINGLETON); - bind(CoreCommands.class).to(CoreProcessor.class); Multibinder.newSetBinder(binder(), GuiceProbe.class).addBinding().to(SieveProbeImpl.class); Multibinder.newSetBinder(binder(), CertificateReloadable.Factory.class).addBinding().to(ManageSieveServerFactory.class); } + @Provides + @Singleton + @ManageSieveDefaultSaslMechanismFactories + ImmutableList<SaslMechanismFactory> provideDefaultManageSieveSaslMechanismFactories(OauthBearerSaslMechanismFactory oauthBearer, + XOauth2SaslMechanismFactory xoauth2) { + return ImmutableList.of(new PlainSaslMechanismFactory(false), oauthBearer, xoauth2); + } + + @Provides + @Singleton + ManageSieveSaslMechanismLoader provideManageSieveSaslMechanismLoader(GuiceSaslMechanismResolver resolver, + @ManageSieveDefaultSaslMechanismFactories ImmutableList<SaslMechanismFactory> defaultFactories) { + return configuration -> resolver.resolve( + ManageSieveServerFactory.retrieveSaslMechanismFactoryClassNames(configuration), + BuiltInSaslMechanismFactories.enabledForServer(defaultFactories, configuration), + configuration); + } + @ProvidesIntoSet InitializationOperation configureManageSieve(ConfigurationProvider configurationProvider, ManageSieveServerFactory manageSieveServerFactory) { return InitilizationOperationBuilder @@ -65,4 +90,4 @@ public class ManageSieveServerModule extends AbstractModule { FileSystem fileSystem, RunArguments runArguments) { return new ProtocolConfigurationSanitizer(configurationProvider, keystoreCreator, fileSystem, runArguments, "managesieveserver"); } -} \ No newline at end of file +} diff --git a/server/container/guice/protocols/managedsieve/src/test/java/org/apache/james/modules/protocols/ManageSieveServerModuleTest.java b/server/container/guice/protocols/managedsieve/src/test/java/org/apache/james/modules/protocols/ManageSieveServerModuleTest.java new file mode 100644 index 0000000000..bb4ddc813c --- /dev/null +++ b/server/container/guice/protocols/managedsieve/src/test/java/org/apache/james/modules/protocols/ManageSieveServerModuleTest.java @@ -0,0 +1,43 @@ +/**************************************************************** + * 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.james.modules.protocols; + +import static org.assertj.core.api.Assertions.assertThat; + +import org.apache.james.protocols.sasl.OauthBearerSaslMechanismFactory; +import org.apache.james.protocols.sasl.PlainSaslMechanismFactory; +import org.apache.james.protocols.sasl.XOauth2SaslMechanismFactory; +import org.junit.jupiter.api.Test; + +class ManageSieveServerModuleTest { + private final ManageSieveServerModule testee = new ManageSieveServerModule(); + + @Test + void provideDefaultManageSieveSaslMechanismFactoriesShouldPreserveManageSieveDefaults() { + assertThat(testee.provideDefaultManageSieveSaslMechanismFactories( + new OauthBearerSaslMechanismFactory(), + new XOauth2SaslMechanismFactory())) + .map(factory -> factory.getClass().getSimpleName()) + .containsExactly( + PlainSaslMechanismFactory.class.getSimpleName(), + OauthBearerSaslMechanismFactory.class.getSimpleName(), + XOauth2SaslMechanismFactory.class.getSimpleName()); + } +} --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
