/*
* JBoss, Home of Professional Open Source.
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.threads;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP_ADDR;
import static org.jboss.as.threads.CommonAttributes.KEEPALIVE_TIME;
import static org.jboss.as.threads.CommonAttributes.TIME;
import static org.jboss.as.threads.CommonAttributes.UNIT;
import java.util.Locale;
import java.util.concurrent.Executor;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;
import org.jboss.as.controller.OperationContext;
import org.jboss.as.controller.OperationFailedException;
import org.jboss.as.controller.PathAddress;
import org.jboss.dmr.ModelNode;
import org.jboss.msc.inject.Injector;
import org.jboss.msc.service.Service;
import org.jboss.msc.service.ServiceBuilder;
import org.jboss.msc.service.ServiceName;
import org.jboss.msc.service.ServiceTarget;
/**
* Utilities related to management of thread pools.
*
* @author <a href="kabir.khan@jboss.com">Kabir Khan</a>
* @author Brian Stansberry (c) 2011 Red Hat Inc.
*/
class ThreadPoolManagementUtils {
static <T> void installThreadPoolService(final Service<T> threadPoolService,
final String threadPoolName,
final ServiceName serviceNameBase,
final String threadFactoryName,
final ThreadFactoryResolver threadFactoryResolver,
final Injector<ThreadFactory> threadFactoryInjector,
final ServiceTarget target) {
installThreadPoolService(threadPoolService, threadPoolName, serviceNameBase,
threadFactoryName, threadFactoryResolver, threadFactoryInjector,
null, null, null,
target);
}
static <T> void installThreadPoolService(final Service<T> threadPoolService,
final String threadPoolName,
final ServiceName serviceNameBase,
final String threadFactoryName,
final ThreadFactoryResolver threadFactoryResolver,
final Injector<ThreadFactory> threadFactoryInjector,
final String handoffExecutorName,
final HandoffExecutorResolver handoffExecutorResolver,
final Injector<Executor> handoffExecutorInjector,
final ServiceTarget target) {
final ServiceName threadPoolServiceName = serviceNameBase.append(threadPoolName);
final ServiceBuilder<?> serviceBuilder = target.addService(threadPoolServiceName, threadPoolService);
final ServiceName threadFactoryServiceName = threadFactoryResolver.resolveThreadFactory(threadFactoryName,
threadPoolName, threadPoolServiceName, target);
serviceBuilder.addDependency(threadFactoryServiceName, ThreadFactory.class, threadFactoryInjector);
if (handoffExecutorInjector != null) {
ServiceName handoffServiceName = handoffExecutorResolver.resolveHandoffExecutor(handoffExecutorName,
threadPoolName, threadPoolServiceName, target);
if (handoffServiceName != null) {
serviceBuilder.addDependency(handoffServiceName, Executor.class, handoffExecutorInjector);
}
}
serviceBuilder.install();
}
static void removeThreadPoolService(final String threadPoolName,
final ServiceName serviceNameBase,
final String threadFactoryName,
final ThreadFactoryResolver threadFactoryResolver,
final OperationContext operationContext) {
removeThreadPoolService(threadPoolName, serviceNameBase, threadFactoryName, threadFactoryResolver, null, null, operationContext);
}
static void removeThreadPoolService(final String threadPoolName,
final ServiceName serviceNameBase,
final String threadFactoryName,
final ThreadFactoryResolver threadFactoryResolver,
final String handoffExecutorName,
final HandoffExecutorResolver handoffExecutorResolver,
final OperationContext operationContext) {
final ServiceName threadPoolServiceName = serviceNameBase.append(threadPoolName);
operationContext.removeService(threadPoolServiceName);
threadFactoryResolver.releaseThreadFactory(threadFactoryName, threadPoolName, threadPoolServiceName, operationContext);
if (handoffExecutorResolver != null) {
handoffExecutorResolver.releaseHandoffExecutor(handoffExecutorName, threadPoolName, threadPoolServiceName, operationContext);
}
}
static BaseThreadPoolParameters parseUnboundedQueueThreadPoolParameters(final OperationContext context, final ModelNode operation, final ModelNode model) throws OperationFailedException {
ThreadPoolParametersImpl params = new ThreadPoolParametersImpl();
return parseBaseThreadPoolOperationParameters(context, operation, model, params);
}
static BaseThreadPoolParameters parseScheduledThreadPoolParameters(final OperationContext context, final ModelNode operation, final ModelNode model) throws OperationFailedException {
ThreadPoolParametersImpl params = new ThreadPoolParametersImpl();
return parseBaseThreadPoolOperationParameters(context, operation, model, params);
}
static QueuelessThreadPoolParameters parseQueuelessThreadPoolParameters(final OperationContext context, final ModelNode operation, final ModelNode model, boolean blocking) throws OperationFailedException {
ThreadPoolParametersImpl params = new ThreadPoolParametersImpl();
parseBaseThreadPoolOperationParameters(context, operation, model, params);
if (!blocking) {
ModelNode handoffEx = PoolAttributeDefinitions.HANDOFF_EXECUTOR.resolveModelAttribute(context, model);
params.handoffExecutor = handoffEx.isDefined() ? handoffEx.asString() : null;
}
return params;
}
static BoundedThreadPoolParameters parseBoundedThreadPoolParameters(final OperationContext context, final ModelNode operation, final ModelNode model, boolean blocking) throws OperationFailedException {
ThreadPoolParametersImpl params = new ThreadPoolParametersImpl();
parseBaseThreadPoolOperationParameters(context, operation, model, params);
params.allowCoreTimeout = PoolAttributeDefinitions.ALLOW_CORE_TIMEOUT.resolveModelAttribute(context, model).asBoolean();
if (!blocking) {
ModelNode handoffEx = PoolAttributeDefinitions.HANDOFF_EXECUTOR.resolveModelAttribute(context, model);
params.handoffExecutor = handoffEx.isDefined() ? handoffEx.asString() : null;
}
ModelNode coreTh = PoolAttributeDefinitions.CORE_THREADS.resolveModelAttribute(context, model);
params.coreThreads = coreTh.isDefined() ? coreTh.asInt() : params.maxThreads;
params.queueLength = PoolAttributeDefinitions.QUEUE_LENGTH.resolveModelAttribute(context, model).asInt();
return params;
}
private static ThreadPoolParametersImpl parseBaseThreadPoolOperationParameters(final OperationContext context, final ModelNode operation,
final ModelNode model, final ThreadPoolParametersImpl params) throws OperationFailedException {
params.address = operation.require(OP_ADDR);
PathAddress pathAddress = PathAddress.pathAddress(params.address);
params.name = pathAddress.getLastElement().getValue();
//Get/validate the properties
ModelNode tfNode = PoolAttributeDefinitions.THREAD_FACTORY.resolveModelAttribute(context, model);
params.threadFactory = tfNode.isDefined() ? tfNode.asString() : null;
params.maxThreads = PoolAttributeDefinitions.MAX_THREADS.resolveModelAttribute(context, model).asInt();
if (model.hasDefined(KEEPALIVE_TIME)) {
ModelNode keepaliveTime = model.get(KEEPALIVE_TIME);
if (!keepaliveTime.hasDefined(TIME)) {
throw ThreadsLogger.ROOT_LOGGER.missingKeepAliveTime(TIME, KEEPALIVE_TIME);
}
if (!keepaliveTime.hasDefined(UNIT)) {
throw ThreadsLogger.ROOT_LOGGER.missingKeepAliveUnit(UNIT, KEEPALIVE_TIME);
}
long time = KeepAliveTimeAttributeDefinition.KEEPALIVE_TIME_TIME.resolveModelAttribute(context, keepaliveTime).asLong();
String unit = KeepAliveTimeAttributeDefinition.KEEPALIVE_TIME_UNIT.resolveModelAttribute(context, keepaliveTime).asString();
params.keepAliveTime = new TimeSpec(Enum.valueOf(TimeUnit.class, unit.toUpperCase(Locale.ENGLISH)), time);
}
return params;
}
interface BaseThreadPoolParameters {
ModelNode getAddress();
String getName();
String getThreadFactory();
int getMaxThreads();
TimeSpec getKeepAliveTime();
}
interface QueuelessThreadPoolParameters extends BaseThreadPoolParameters {
String getHandoffExecutor();
}
interface BoundedThreadPoolParameters extends QueuelessThreadPoolParameters {
boolean isAllowCoreTimeout();
int getCoreThreads();
int getQueueLength();
}
private static class ThreadPoolParametersImpl implements QueuelessThreadPoolParameters, BoundedThreadPoolParameters {
ModelNode address;
String name;
String threadFactory;
int maxThreads;
TimeSpec keepAliveTime;
String handoffExecutor;
boolean allowCoreTimeout;
int coreThreads;
int queueLength;
@Override
public ModelNode getAddress() {
return address;
}
@Override
public String getName() {
return name;
}
@Override
public String getThreadFactory() {
return threadFactory;
}
@Override
public int getMaxThreads() {
return maxThreads;
}
@Override
public TimeSpec getKeepAliveTime() {
return keepAliveTime;
}
@Override
public String getHandoffExecutor() {
return handoffExecutor;
}
@Override
public boolean isAllowCoreTimeout() {
return allowCoreTimeout;
}
@Override
public int getCoreThreads() {
return coreThreads;
}
@Override
public int getQueueLength() {
return queueLength;
}
}
}