/*
 * Copyright 2002-2020 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.scheduling.concurrent;

import java.util.Properties;
import java.util.concurrent.Executor;

import javax.naming.NamingException;

import org.springframework.beans.factory.InitializingBean;
import org.springframework.jndi.JndiLocatorDelegate;
import org.springframework.jndi.JndiTemplate;
import org.springframework.lang.Nullable;

JNDI-based variant of ConcurrentTaskExecutor, performing a default lookup for JSR-236's "java:comp/DefaultManagedExecutorService" in a Java EE 7/8 environment.

Note: This class is not strictly JSR-236 based; it can work with any regular Executor that can be found in JNDI. The actual adapting to ManagedExecutorService happens in the base class ConcurrentTaskExecutor itself.

Author:Juergen Hoeller
See Also:
  • ManagedExecutorService
Since:4.0
/** * JNDI-based variant of {@link ConcurrentTaskExecutor}, performing a default lookup for * JSR-236's "java:comp/DefaultManagedExecutorService" in a Java EE 7/8 environment. * * <p>Note: This class is not strictly JSR-236 based; it can work with any regular * {@link java.util.concurrent.Executor} that can be found in JNDI. * The actual adapting to {@link javax.enterprise.concurrent.ManagedExecutorService} * happens in the base class {@link ConcurrentTaskExecutor} itself. * * @author Juergen Hoeller * @since 4.0 * @see javax.enterprise.concurrent.ManagedExecutorService */
public class DefaultManagedTaskExecutor extends ConcurrentTaskExecutor implements InitializingBean { private final JndiLocatorDelegate jndiLocator = new JndiLocatorDelegate(); @Nullable private String jndiName = "java:comp/DefaultManagedExecutorService";
Set the JNDI template to use for JNDI lookups.
See Also:
  • setJndiTemplate.setJndiTemplate
/** * Set the JNDI template to use for JNDI lookups. * @see org.springframework.jndi.JndiAccessor#setJndiTemplate */
public void setJndiTemplate(JndiTemplate jndiTemplate) { this.jndiLocator.setJndiTemplate(jndiTemplate); }
Set the JNDI environment to use for JNDI lookups.
See Also:
  • setJndiEnvironment.setJndiEnvironment
/** * Set the JNDI environment to use for JNDI lookups. * @see org.springframework.jndi.JndiAccessor#setJndiEnvironment */
public void setJndiEnvironment(Properties jndiEnvironment) { this.jndiLocator.setJndiEnvironment(jndiEnvironment); }
Set whether the lookup occurs in a Java EE container, i.e. if the prefix "java:comp/env/" needs to be added if the JNDI name doesn't already contain it. PersistenceAnnotationBeanPostProcessor's default is "true".
See Also:
  • setResourceRef.setResourceRef
/** * Set whether the lookup occurs in a Java EE container, i.e. if the prefix * "java:comp/env/" needs to be added if the JNDI name doesn't already * contain it. PersistenceAnnotationBeanPostProcessor's default is "true". * @see org.springframework.jndi.JndiLocatorSupport#setResourceRef */
public void setResourceRef(boolean resourceRef) { this.jndiLocator.setResourceRef(resourceRef); }
Specify a JNDI name of the Executor to delegate to, replacing the default JNDI name "java:comp/DefaultManagedExecutorService".

This can either be a fully qualified JNDI name, or the JNDI name relative to the current environment naming context if "resourceRef" is set to "true".

See Also:
/** * Specify a JNDI name of the {@link java.util.concurrent.Executor} to delegate to, * replacing the default JNDI name "java:comp/DefaultManagedExecutorService". * <p>This can either be a fully qualified JNDI name, or the JNDI name relative * to the current environment naming context if "resourceRef" is set to "true". * @see #setConcurrentExecutor * @see #setResourceRef */
public void setJndiName(String jndiName) { this.jndiName = jndiName; } @Override public void afterPropertiesSet() throws NamingException { if (this.jndiName != null) { setConcurrentExecutor(this.jndiLocator.lookup(this.jndiName, Executor.class)); } } }