Package com.adaptris.hpcc

Class PollThor

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.hpcc.DfuPlusWrapper

com.adaptris.hpcc.RequestOnlyImpl

com.adaptris.hpcc.SingleFileRequest

com.adaptris.hpcc.PollThor

All Implemented Interfaces:

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

@ComponentProfile(summary="Poll HPCC for the existence of a logical file",
                  tag="producer,hpcc,dfuplus,thor",
                  recommended=DfuplusConnection.class)
public class PollThor
extends SingleFileRequest

Poll Thor for the existence of a logical file.

The use case for this service is, if there is a long-running Job on Thor (scheduled or otherwise) that creates a logical file; you need to wait for the existence of this file before carrying on with the rest of the adapter workflow (usually despraying the logical file that was created).

Note that although this is an implementation of AdaptrisMessageProducerImp the AdaptrisMessageProducer#produce() methods will throw a UnsupportedOperationException. It should be used as part of a StandaloneRequestor where the SingleFileRequest.getLogicalFilename() returns the logical filename of the file that you wish to retrieve.

In the adapter configuration file this class is aliased as poll-thor which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.hpcc.DfuPlusWrapper

executor

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Constructor Summary

Constructors

Constructor	Description
PollThor()

Method Summary

Modifier and Type	Method	Description
protected AdaptrisMessage	doRequest(AdaptrisMessage msg, java.lang.String endpoint, long timeoutMs)
void	stop()

Methods inherited from class com.adaptris.hpcc.SingleFileRequest

endpoint, getLogicalFilename, prepare, setLogicalFilename

Methods inherited from class com.adaptris.hpcc.RequestOnlyImpl

doProduce

Methods inherited from class com.adaptris.hpcc.DfuPlusWrapper

calculateWait, close, execute, executeInternal, generateExceptionMessage, getMaxWait, getMonitorInterval, init, maxWaitMs, monitorIntervalMs, produce, request, request, setMaxWait, setMonitorInterval, start

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

createName

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

Constructor Detail

PollThor

public PollThor()

Method Detail

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

Overrides:

stop in class DfuPlusWrapper

doRequest

protected AdaptrisMessage doRequest(AdaptrisMessage msg,
                                    java.lang.String endpoint,
                                    long timeoutMs)
                             throws ProduceException

Specified by:

doRequest in class DfuPlusWrapper

Throws:

ProduceException