Package com.adaptris.hpcc

Class ListLogicalFiles

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.hpcc.DfuPlusWrapper

com.adaptris.hpcc.RequestOnlyImpl

com.adaptris.hpcc.ListLogicalFiles

All Implemented Interfaces:

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

@ComponentProfile(summary="Query HPCC for a list of files",
                  tag="producer,hpcc,dfuplus,thor",
                  recommended=DfuplusConnection.class)
public class ListLogicalFiles
extends RequestOnlyImpl

Query Thor for a list of files.

This simply uses dfuplus to query Thor and get a list of logical files. The list replaces the existing message payload.

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 getFilemask() returns the logical filename mask of the file(s) that you wish to retrieve.

In the adapter configuration file this class is aliased as list-logical-files-in-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
ListLogicalFiles()

Method Summary

Modifier and Type	Method	Description
protected AdaptrisMessage	doRequest(AdaptrisMessage msg, java.lang.String filespec, long timeoutMs)
java.lang.String	endpoint(AdaptrisMessage msg)
java.lang.String	getFilemask()	The filename to write in Thor
void	prepare()
void	setFilemask(java.lang.String filemask)	The filename to write in Thor

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, stop

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

ListLogicalFiles

public ListLogicalFiles()

Method Detail

doRequest

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

Specified by:

doRequest in class DfuPlusWrapper

Throws:

ProduceException

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Overrides:

prepare in class DfuPlusWrapper

Throws:

CoreException

endpoint

public java.lang.String endpoint(AdaptrisMessage msg)
                          throws ProduceException

Specified by:

endpoint in class AdaptrisMessageProducerImp

Throws:

ProduceException

getFilemask

public java.lang.String getFilemask()

The filename to write in Thor

setFilemask

public void setFilemask(java.lang.String filemask)

The filename to write in Thor