| /* |
| * 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.samza.task; |
| |
| import com.google.common.base.Preconditions; |
| import org.apache.commons.lang3.StringUtils; |
| import org.apache.samza.SamzaException; |
| import org.apache.samza.application.descriptors.ApplicationDescriptor; |
| import org.apache.samza.application.descriptors.ApplicationDescriptorImpl; |
| import org.apache.samza.application.descriptors.StreamApplicationDescriptorImpl; |
| import org.apache.samza.application.descriptors.TaskApplicationDescriptorImpl; |
| import org.apache.samza.config.ConfigException; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import java.util.concurrent.ExecutorService; |
| |
| /** |
| * This class provides utility functions to load task factory classes based on config, and to wrap {@link StreamTaskFactory} |
| * in {@link AsyncStreamTaskFactory} when running {@link StreamTask}s in multi-thread mode |
| */ |
| public class TaskFactoryUtil { |
| private static final Logger log = LoggerFactory.getLogger(TaskFactoryUtil.class); |
| |
| /** |
| * Creates a {@link TaskFactory} based on {@link ApplicationDescriptorImpl} |
| * |
| * @param appDesc {@link ApplicationDescriptorImpl} for this application |
| * @return {@link TaskFactory} object defined by {@code appDesc} |
| */ |
| public static TaskFactory getTaskFactory(ApplicationDescriptorImpl<? extends ApplicationDescriptor> appDesc) { |
| if (appDesc instanceof TaskApplicationDescriptorImpl) { |
| return ((TaskApplicationDescriptorImpl) appDesc).getTaskFactory(); |
| } else if (appDesc instanceof StreamApplicationDescriptorImpl) { |
| return (StreamOperatorTaskFactory) () -> new StreamOperatorTask( |
| ((StreamApplicationDescriptorImpl) appDesc).getOperatorSpecGraph()); |
| } |
| throw new IllegalArgumentException(String.format("ApplicationDescriptorImpl has to be either TaskApplicationDescriptorImpl or " |
| + "StreamApplicationDescriptorImpl. class %s is not supported", appDesc.getClass().getName())); |
| } |
| |
| /** |
| * Creates a {@link TaskFactory} based on the configuration. |
| * <p> |
| * This should only be used to create {@link TaskFactory} defined in task.class |
| * |
| * @param taskClassName the task class name for this job |
| * @return a {@link TaskFactory} object, either a instance of {@link StreamTaskFactory} or {@link AsyncStreamTaskFactory} |
| */ |
| public static TaskFactory getTaskFactory(String taskClassName) { |
| Preconditions.checkArgument(StringUtils.isNotBlank(taskClassName), "task.class cannot be empty"); |
| log.info("Got task class name: {}", taskClassName); |
| |
| boolean isAsyncTaskClass; |
| try { |
| isAsyncTaskClass = AsyncStreamTask.class.isAssignableFrom(Class.forName(taskClassName)); |
| } catch (Throwable t) { |
| throw new ConfigException(String.format("Invalid configuration for AsyncStreamTask class: %s", taskClassName), t); |
| } |
| |
| if (isAsyncTaskClass) { |
| return (AsyncStreamTaskFactory) () -> { |
| try { |
| return (AsyncStreamTask) Class.forName(taskClassName).newInstance(); |
| } catch (Throwable t) { |
| log.error("Error loading AsyncStreamTask class: {}. error: {}", taskClassName, t); |
| throw new SamzaException(String.format("Error loading AsyncStreamTask class: %s", taskClassName), t); |
| } |
| }; |
| } |
| |
| return (StreamTaskFactory) () -> { |
| try { |
| return (StreamTask) Class.forName(taskClassName).newInstance(); |
| } catch (Throwable t) { |
| log.error("Error loading StreamTask class: {}. error: {}", taskClassName, t); |
| throw new SamzaException(String.format("Error loading StreamTask class: %s", taskClassName), t); |
| } |
| }; |
| } |
| |
| /** |
| * Optionally wrap the {@link StreamTaskFactory} in a {@link AsyncStreamTaskFactory}, when running {@link StreamTask} |
| * in multi-thread mode. |
| * |
| * @param factory the task factory instance loaded according to the task class |
| * @param taskThreadPool the thread pool to run the {@link AsyncStreamTaskAdapter} tasks |
| * @return the finalized task factory object |
| */ |
| public static TaskFactory finalizeTaskFactory(TaskFactory factory, ExecutorService taskThreadPool) { |
| validateFactory(factory); |
| boolean isAsyncTaskClass = factory instanceof AsyncStreamTaskFactory; |
| |
| if (isAsyncTaskClass) { |
| log.info("Got an AsyncStreamTask implementation."); |
| return factory; |
| } |
| |
| boolean isStreamOperatorTaskClass = factory instanceof StreamOperatorTaskFactory; |
| |
| /* |
| * Note: Even though StreamOperatorTask is an instanceof AsyncStreamTask, we still need to |
| * adapt it in order to inject the container thread pool. Long term, this will go away once we have the |
| * InternalTaskContext refactor, which would then become the entry point for exposing any of the runtime objects |
| * created in the container. |
| * Refer to SAMZA-2203 for more details. |
| */ |
| if (isStreamOperatorTaskClass) { |
| log.info("Adapting StreamOperatorTaskFactory to inject container thread pool"); |
| return (AsyncStreamTaskFactory) () -> { |
| StreamOperatorTask operatorTask = (StreamOperatorTask) factory.createInstance(); |
| operatorTask.setTaskThreadPool(taskThreadPool); |
| return operatorTask; |
| }; |
| } |
| |
| log.info("Converting StreamTask to AsyncStreamTaskAdapter"); |
| return (AsyncStreamTaskFactory) () -> |
| new AsyncStreamTaskAdapter(((StreamTaskFactory) factory).createInstance(), taskThreadPool); |
| } |
| |
| private static void validateFactory(TaskFactory factory) { |
| if (factory == null) { |
| throw new SamzaException("Either the task class name or the task factory instance is required."); |
| } |
| |
| boolean isValidFactory = factory instanceof StreamTaskFactory |
| || factory instanceof AsyncStreamTaskFactory |
| || factory instanceof StreamOperatorTaskFactory; |
| |
| if (!isValidFactory) { |
| throw new SamzaException(String.format("TaskFactory must be either StreamTaskFactory or AsyncStreamTaskFactory or StreamOperatorTaskFactory. %s is not supported", |
| factory.getClass())); |
| } |
| } |
| |
| } |