com.adaptris.hpcc.ListLogicalFiles.java Source code

Introduction

Here is the source code for com.adaptris.hpcc.ListLogicalFiles.java

Source

/*
 * Copyright 2016 Adaptris Ltd.
 * 
 * Licensed 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 com.adaptris.hpcc;

import java.io.PrintWriter;

import org.apache.commons.exec.CommandLine;

import com.adaptris.annotation.AdapterComponent;
import com.adaptris.annotation.ComponentProfile;
import com.adaptris.core.AdaptrisMessage;
import com.adaptris.core.AdaptrisMessageProducerImp;
import com.adaptris.core.ProduceDestination;
import com.adaptris.core.ProduceException;
import com.adaptris.core.StandaloneRequestor;
import com.adaptris.core.util.ExceptionHelper;
import com.thoughtworks.xstream.annotations.XStreamAlias;

/**
 * Query Thor for a list of files.
 * <p>
 * This simply uses dfuplus to query Thor and get a list of logical files. The list replaces the existing message payload.
 * </p>
 * <p>
 * Note that although this is an implementation of {@link AdaptrisMessageProducerImp} the {@code AdaptrisMessageProducer#produce()}
 * methods will throw a {@link UnsupportedOperationException}. It should be used as part of a {@link StandaloneRequestor} where the
 * {@link ProduceDestination} returns the logical filename mask of the file(s) that you wish to retrieve.
 * </p>
 * 
 * @config list-logical-files-in-thor
 */
@XStreamAlias("list-logical-files-in-thor")
@AdapterComponent
@ComponentProfile(summary = "Query HPCC for a list of files", tag = "producer,hpcc,dfuplus,thor", recommended = {
        DfuplusConnection.class })
public class ListLogicalFiles extends RequestOnlyImpl {

    public ListLogicalFiles() {

    }

    @Override
    public AdaptrisMessage request(AdaptrisMessage msg, ProduceDestination destination, long timeoutMs)
            throws ProduceException {
        try {
            String dest = destination.getDestination(msg);
            CommandLine commandLine = retrieveConnection(DfuplusConnection.class).createCommand();
            commandLine.addArgument("action=list");
            commandLine.addArgument(String.format("name=%s", dest));
            log.trace("Executing {}", commandLine);
            try (PrintWriter out = new PrintWriter(msg.getWriter())) {
                // parser is closed as part of the execution
                ListLogicalFilesOutput parser = new ListLogicalFilesOutput(dest, out); // lgtm [java/output-resource-leak]
                executeInternal(commandLine, parser);
            }
        } catch (Exception e) {
            throw ExceptionHelper.wrapProduceException(e);
        }
        return msg;
    }
}