Package risesoft.data.transfer.core.context

Class JobContext

java.lang.Object

risesoft.data.transfer.core.context.JobContext

public class JobContext
extends Object

任务上下文存储任务所需的全部信息

Author:

lb

Date:

2023年12月4日

Constructor Summary

Constructors

Constructor	Description
JobContext(Communication communication, String jobId, HandleManager handles, JobListener jobListener, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
boolean	await(String message)	暂停当前任务 true: 暂停成功 false: 任务已结束暂停失败
<T> void	doHandle(Class<T> handleType, DoHandle<T> doHandle)
Communication	getCommunication()
Job	getConcurrentJob()	获取当前任务
Configuration	getConfiguration()
Map<String,Object>	getContext()	获取上下文对象，这个对象可以用于缓存等操作
Exchange	getCoreExchange()
HandleManager	getHandles()
InChannel	getInChannel()
ExecutorTaskQueue	getInExecutorTaskQueue()
<T> T	getInstance(Class<T> key)	获取实例
Map<Class<?>,Object>	getInstanceMap()
String	getJobId()
JobListener	getJobListener()
Logger	getLogger()	获取上下文日志
LoggerFactory	getLoggerFactory()	获取本次任务的日志工厂
String	getName()	获取任务名
ExecutorTaskQueue	getOutExecutorTaskQueue()
StreamContext	getStreamContext()
boolean	hasJob()	是否存在任务
boolean	isEnd()
Job	nextJob()	获取下一个任务
void	putInstance(Class<?> key, Object instance)
void	putInstance(Object instance)	已实例的类追加实例
boolean	running()	任务继续如果任务没有暂停则会返回false
void	setCommunication(Communication communication)
JobContext	setCoreExchange(Exchange exchange)
void	setEnd(boolean isEnd)
JobContext	setInChannelConfiguration(Configuration inChannelConfiguration)
JobContext	setInExecutorTaskQueue(ExecutorTaskQueue inExecutorTaskQueue)
void	setJobListener(JobListener jobListener)
void	setJobs(List<Job> jobs)
void	setLoggerFactory(LoggerFactory loggerFactory)
void	setName(String name)
JobContext	setOutExecutorTaskQueue(ExecutorTaskQueue outExecutorTaskQueue)
boolean	stop(Throwable e)	停止任务

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobContext

public JobContext(Communication communication,
                  String jobId,
                  HandleManager handles,
                  JobListener jobListener,
                  Configuration configuration)

Method Detail

getContext

public Map<String,Object> getContext()

获取上下文对象，这个对象可以用于缓存等操作

Returns:

getName

public String getName()

获取任务名

Returns:

setName

public void setName(String name)

getLoggerFactory

public LoggerFactory getLoggerFactory()

获取本次任务的日志工厂

Returns:

getLogger

public Logger getLogger()

获取上下文日志

Returns:

setLoggerFactory

public void setLoggerFactory(LoggerFactory loggerFactory)

isEnd

public boolean isEnd()

setEnd

public void setEnd(boolean isEnd)

getJobListener

public JobListener getJobListener()

setJobListener

public void setJobListener(JobListener jobListener)

setCoreExchange

public JobContext setCoreExchange(Exchange exchange)

getCoreExchange

public Exchange getCoreExchange()

putInstance

public void putInstance(Class<?> key,
                        Object instance)

getInstanceMap

public Map<Class<?>,Object> getInstanceMap()

getConfiguration

public Configuration getConfiguration()

putInstance

public void putInstance(Object instance)

已实例的类追加实例

Parameters:

instance -

getInstance

public <T> T getInstance(Class<T> key)

获取实例

Parameters:

key - 需要的类型

Returns:

getStreamContext

public StreamContext getStreamContext()

getCommunication

public Communication getCommunication()

setCommunication

public void setCommunication(Communication communication)

getJobId

public String getJobId()

getHandles

public HandleManager getHandles()

setJobs

public void setJobs(List<Job> jobs)

nextJob

public Job nextJob()

获取下一个任务

Returns:

hasJob

public boolean hasJob()

是否存在任务

Returns:

getConcurrentJob

public Job getConcurrentJob()

获取当前任务

Returns:

getInExecutorTaskQueue

public ExecutorTaskQueue getInExecutorTaskQueue()

setInExecutorTaskQueue

public JobContext setInExecutorTaskQueue(ExecutorTaskQueue inExecutorTaskQueue)

getOutExecutorTaskQueue

public ExecutorTaskQueue getOutExecutorTaskQueue()

setOutExecutorTaskQueue

public JobContext setOutExecutorTaskQueue(ExecutorTaskQueue outExecutorTaskQueue)

doHandle

public <T> void doHandle(Class<T> handleType,
                         DoHandle<T> doHandle)

setInChannelConfiguration

public JobContext setInChannelConfiguration(Configuration inChannelConfiguration)

stop

public boolean stop(Throwable e)

停止任务

Parameters:

e - 传递停止的异常信息

Returns:

await

public boolean await(String message)

暂停当前任务 true: 暂停成功 false: 任务已结束暂停失败

Parameters:

message - 暂停描述信息会记录到日志中

Returns:

running

public boolean running()

任务继续如果任务没有暂停则会返回false

Returns:

getInChannel

public InChannel getInChannel()