org.glassfish.jersey.process.internal.ExecutorProviders Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-common Show documentation
Show all versions of jersey-common Show documentation
Jersey core common packages
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2015 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.jersey.process.internal;
import java.lang.annotation.Annotation;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.inject.Named;
import javax.inject.Qualifier;
import javax.inject.Singleton;
import org.glassfish.jersey.internal.LocalizationMessages;
import org.glassfish.jersey.internal.inject.Injections;
import org.glassfish.jersey.internal.inject.Providers;
import org.glassfish.jersey.internal.util.ExtendedLogger;
import org.glassfish.jersey.internal.util.ReflectionHelper;
import org.glassfish.jersey.spi.ExecutorServiceProvider;
import org.glassfish.jersey.spi.ScheduledExecutorServiceProvider;
import org.glassfish.hk2.api.DynamicConfiguration;
import org.glassfish.hk2.api.Factory;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.hk2.utilities.binding.ScopedBindingBuilder;
/**
* A utility class with a methods for handling executor injection registration and proper disposal.
*
* @author Marek Potociar (marek.potociar at oracle.com)
*/
public final class ExecutorProviders {
private static final ExtendedLogger LOGGER =
new ExtendedLogger(Logger.getLogger(ExecutorProviders.class.getName()), Level.FINEST);
private ExecutorProviders() {
throw new AssertionError("Instantiation not allowed.");
}
/**
* Create qualified {@link java.util.concurrent.ExecutorService} and {@link java.util.concurrent.ScheduledExecutorService}
* injection bindings based on the registered providers implementing the
* {@link org.glassfish.jersey.spi.ExecutorServiceProvider} and/or
* {@link org.glassfish.jersey.spi.ScheduledExecutorServiceProvider} SPI.
*
* This method supports creation of qualified injection bindings based on custom
* {@link javax.inject.Qualifier qualifier annotations} attached to the registered provider implementation classes
* as well as named injection bindings based on the {@link javax.inject.Named} qualifier annotation attached to the
* registered provider implementation classes.
*
*
* @param locator application's HK2 service locator.
*/
public static void createInjectionBindings(final ServiceLocator locator) {
final Map, List> executorProviderMap =
getQualifierToProviderMap(locator, ExecutorServiceProvider.class);
// for each bucket, create a new injection binding for the first provider in the list and discard the rest
final DynamicConfiguration dc = Injections.getConfiguration(locator);
for (Map.Entry, List> qualifierToProviders
: executorProviderMap.entrySet()) {
final Class qualifierAnnotationClass = qualifierToProviders.getKey();
final Iterator bucketProviderIterator = qualifierToProviders.getValue().iterator();
final ExecutorServiceProvider executorProvider = bucketProviderIterator.next();
if (LOGGER.isLoggable(Level.CONFIG)) {
LOGGER.config(LocalizationMessages.USING_EXECUTOR_PROVIDER(
executorProvider.getClass().getName(), qualifierAnnotationClass.getName()));
if (bucketProviderIterator.hasNext()) {
StringBuilder msg = new StringBuilder(bucketProviderIterator.next().getClass().getName());
while (bucketProviderIterator.hasNext()) {
msg.append(", ").append(bucketProviderIterator.next().getClass().getName());
}
LOGGER.config(LocalizationMessages.IGNORED_EXECUTOR_PROVIDERS(
msg.toString(), qualifierAnnotationClass.getName()));
}
}
ScopedBindingBuilder bindingBuilder = Injections
.newFactoryBinder(new ExecutorServiceFactory(executorProvider))
.to(ExecutorService.class)
.in(Singleton.class);
final Annotation qualifier = executorProvider.getClass().getAnnotation(qualifierAnnotationClass);
if (qualifier instanceof Named) {
Injections.addBinding(bindingBuilder.named(((Named) qualifier).value()), dc);
} else {
Injections.addBinding(bindingBuilder.qualifiedBy(qualifier), dc);
}
}
final Map, List> schedulerProviderMap =
getQualifierToProviderMap(locator, ScheduledExecutorServiceProvider.class);
for (Map.Entry, List> qualifierToProviders
: schedulerProviderMap.entrySet()) {
final Class qualifierAnnotationClass = qualifierToProviders.getKey();
final Iterator bucketProviderIterator = qualifierToProviders.getValue().iterator();
final ScheduledExecutorServiceProvider executorProvider = bucketProviderIterator.next();
if (LOGGER.isLoggable(Level.CONFIG)) {
LOGGER.config(LocalizationMessages.USING_SCHEDULER_PROVIDER(
executorProvider.getClass().getName(), qualifierAnnotationClass.getName()));
if (bucketProviderIterator.hasNext()) {
StringBuilder msg = new StringBuilder(bucketProviderIterator.next().getClass().getName());
while (bucketProviderIterator.hasNext()) {
msg.append(", ").append(bucketProviderIterator.next().getClass().getName());
}
LOGGER.config(LocalizationMessages.IGNORED_SCHEDULER_PROVIDERS(
msg.toString(), qualifierAnnotationClass.getName()));
}
}
final ScopedBindingBuilder bindingBuilder =
Injections.newFactoryBinder(new ScheduledExecutorServiceFactory(executorProvider))
.in(Singleton.class)
.to(ScheduledExecutorService.class);
if (!executorProviderMap.containsKey(qualifierAnnotationClass)) {
// it is safe to register binding for ExecutorService too...
bindingBuilder.to(ExecutorService.class);
}
final Annotation qualifier = executorProvider.getClass().getAnnotation(qualifierAnnotationClass);
if (qualifier instanceof Named) {
Injections.addBinding(bindingBuilder.named(((Named) qualifier).value()), dc);
} else {
Injections.addBinding(bindingBuilder.qualifiedBy(qualifier), dc);
}
}
dc.commit();
}
private static Map, List> getQualifierToProviderMap(
final ServiceLocator locator,
final Class providerClass) {
// get all ExecutorServiceProvider registrations and create iterator with custom providers in the front
final Set customExecutorProviders =
Providers.getCustomProviders(locator, providerClass);
final Set defaultExecutorProviders =
Providers.getProviders(locator, providerClass);
defaultExecutorProviders.removeAll(customExecutorProviders);
final List executorProviders = new LinkedList(customExecutorProviders);
executorProviders.addAll(defaultExecutorProviders);
final Iterator providersIterator = executorProviders.iterator();
// iterate over providers and map them by Qualifier annotations (custom ones will be added to the buckets first)
final Map, List> executorProviderMap =
new HashMap, List>();
while (providersIterator.hasNext()) {
final T provider = providersIterator.next();
for (Class qualifier
: ReflectionHelper.getAnnotationTypes(provider.getClass(), Qualifier.class)) {
List providersForQualifier;
if (!executorProviderMap.containsKey(qualifier)) {
providersForQualifier = new LinkedList();
executorProviderMap.put(qualifier, providersForQualifier);
} else {
providersForQualifier = executorProviderMap.get(qualifier);
}
providersForQualifier.add(provider);
}
}
return executorProviderMap;
}
private static class ExecutorServiceFactory implements Factory {
private final ExecutorServiceProvider executorProvider;
private ExecutorServiceFactory(ExecutorServiceProvider executorServiceProvider) {
executorProvider = executorServiceProvider;
}
@Override
public ExecutorService provide() {
return executorProvider.getExecutorService();
}
@Override
public void dispose(final ExecutorService instance) {
executorProvider.dispose(instance);
}
}
private static class ScheduledExecutorServiceFactory implements Factory {
private final ScheduledExecutorServiceProvider executorProvider;
private ScheduledExecutorServiceFactory(ScheduledExecutorServiceProvider executorServiceProvider) {
executorProvider = executorServiceProvider;
}
@Override
public ScheduledExecutorService provide() {
return executorProvider.getExecutorService();
}
@Override
public void dispose(final ScheduledExecutorService instance) {
executorProvider.dispose(instance);
}
}
}