Package com.adaptris.hpcc

Class DfuPlusWrapper

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.hpcc.DfuPlusWrapper

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageProducer, AdaptrisMessageSender, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator

Direct Known Subclasses:

RequestOnlyImpl, SprayToThorImpl

public abstract class DfuPlusWrapper
extends AdaptrisMessageProducerImp

Base class for dfuplus based activities.

Field Summary

Fields

Modifier and Type	Field	Description
protected ExecutorService	executor

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Constructor Summary

Constructors

Constructor	Description
DfuPlusWrapper()

Method Summary

Modifier and Type	Method	Description
protected long	calculateWait(long current)
void	close()
protected abstract void	doProduce(AdaptrisMessage msg, String endpoint)
protected abstract AdaptrisMessage	doRequest(AdaptrisMessage msg, String endpoint, long timeout)
protected void	execute(org.apache.commons.exec.CommandLine cmdLine)
protected void	executeInternal(org.apache.commons.exec.CommandLine cmdLine, OutputStream stdout)
protected static String	generateExceptionMessage(Exception e)
TimeInterval	getMaxWait()	Set the max wait for a workunit to complete.
TimeInterval	getMonitorInterval()	Set the monitor interval between attempts to query job status.
void	init()
protected long	maxWaitMs()
protected long	monitorIntervalMs()
void	prepare()
final void	produce(AdaptrisMessage msg)
final AdaptrisMessage	request(AdaptrisMessage msg)
final AdaptrisMessage	request(AdaptrisMessage msg, long timeout)
void	setMaxWait(TimeInterval maxWait)	Set the max wait for a workunit to complete.
void	setMonitorInterval(TimeInterval monitorInterval)	Set the monitor interval between attempts to query job status.
void	start()
void	stop()

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

createName, doRequest, endpoint, maybeHandleProduceException

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory, withUniqueID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createQualifier, isTrackingEndpoint

Field Details

executor

protected transient ExecutorService executor

Constructor Details

DfuPlusWrapper

public DfuPlusWrapper()

Method Details

close

public void close()

init

public void init()
          throws CoreException

Throws:

CoreException

start

public void start()
           throws CoreException

Throws:

CoreException

stop

public void stop()

prepare

public void prepare()
             throws CoreException

Throws:

CoreException

produce

public final void produce(AdaptrisMessage msg)
                   throws ProduceException

Specified by:

produce in interface AdaptrisMessageSender

Overrides:

produce in class AdaptrisMessageProducerImp

Throws:

ProduceException

doProduce

protected abstract void doProduce(AdaptrisMessage msg,
 String endpoint)
                           throws ProduceException

Specified by:

doProduce in class AdaptrisMessageProducerImp

Throws:

ProduceException

request

public final AdaptrisMessage request(AdaptrisMessage msg)
                              throws ProduceException

Specified by:

request in interface AdaptrisMessageProducer

Overrides:

request in class AdaptrisMessageProducerImp

Throws:

ProduceException

request

public final AdaptrisMessage request(AdaptrisMessage msg,
 long timeout)
                              throws ProduceException

Specified by:

request in interface AdaptrisMessageProducer

Overrides:

request in class AdaptrisMessageProducerImp

Throws:

ProduceException

doRequest

protected abstract AdaptrisMessage doRequest(AdaptrisMessage msg,
 String endpoint,
 long timeout)
                                      throws ProduceException

Specified by:

doRequest in class AdaptrisMessageProducerImp

Throws:

ProduceException

monitorIntervalMs

protected long monitorIntervalMs()

maxWaitMs

protected long maxWaitMs()

execute

protected void execute(org.apache.commons.exec.CommandLine cmdLine)
                throws ProduceException

Throws:

ProduceException

executeInternal

protected void executeInternal(org.apache.commons.exec.CommandLine cmdLine,
 OutputStream stdout)
                        throws ProduceException,
com.adaptris.hpcc.AbortJobException

Throws:

ProduceException

com.adaptris.hpcc.AbortJobException

generateExceptionMessage

protected static String generateExceptionMessage(Exception e)

calculateWait

protected long calculateWait(long current)

getMonitorInterval

public TimeInterval getMonitorInterval()

Set the monitor interval between attempts to query job status.

If not specified, then it defaults to 30 seconds

setMonitorInterval

public void setMonitorInterval(TimeInterval monitorInterval)

Set the monitor interval between attempts to query job status.

If not specified, then it defaults to 30 seconds

getMaxWait

public TimeInterval getMaxWait()

Set the max wait for a workunit to complete.

if not specified, defaults to 1 hour.

setMaxWait

public void setMaxWait(TimeInterval maxWait)

Set the max wait for a workunit to complete.

if not specified, defaults to 1 hour.