FileTransferSample.java

/*
 * Copyright 2012 Artur Keska.
 *
 * 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 org.jaxygen.netserviceapisample.business;

import java.io.File;
import java.io.IOException;
import org.apache.commons.io.FileUtils;
import org.jaxygen.annotations.NetAPI;
import org.jaxygen.annotations.Status;
import org.jaxygen.dto.Downloadable;
import org.jaxygen.dto.Uploadable;
import org.jaxygen.mime.MimeTypeAnalyser;
import org.jaxygen.netserviceapisample.business.dto.AddImageRequestDTO;
import org.jaxygen.network.DownloadableFile;

/**
 * Class demonstrates usage of the UploadedFile structure.
 *
 * @author Artur Keska
 */
public class FileTransferSample {

  private final static String TMP = System.getProperty("java.io.tmpdir");
  private final static File SHARED_DIR = new File(TMP);
  private static String sharedFileMimeType = "";
  private static Uploadable upladedFile;
  private static File sharedFile;
  
  @NetAPI(description = "Function demonstrates usage of the UploadedFile class usage",
         status= Status.ReleaseCandidate,
         version="1.0")
  public Uploadable uploadFile(AddImageRequestDTO request) throws IOException {
    // Get reference to the uploaded file descriptor
    upladedFile = request.getFile();

    // Get reference to the phisical temporary file
    // Note that it's not guaranteed that the file exists
    // after this call exited.
    File f = upladedFile.getFile();
    
    sharedFile = new File(SHARED_DIR, upladedFile.getOriginalName());
    
    // Copy file to the SESSION_FILE
    // OK. It's not session related, but it's just a demo
    FileUtils.copyFile(f, sharedFile);

    // Get the content type follow the original file name
    sharedFileMimeType = MimeTypeAnalyser.getMimeForExtension(new File(upladedFile.getOriginalName()));
    
    // Alternatively mime type could be read from request:
    // sharedFileMimeType = uf.getMimeType();

    return upladedFile;
  }

  @NetAPI(description = "Function demonstrates how to make the file downloadable. "
          + "The file is transfered using inline dispostion. "
          + "That mean it is shown directly in the browser window.",
         status= Status.ReleaseCandidate,
         version="1.0")
  public Downloadable showFile() {
    return new DownloadableFile(sharedFile, Downloadable.ContentDisposition.inline, sharedFileMimeType);
  }

  @NetAPI(description = "Function demonstrates how to make the file downloadable. "
          + "File is transfered using attachment content disposition. "
          + "That mean browser shall save it to the local storage.",
         status= Status.ReleaseCandidate,
         version="1.0")
  public Downloadable downloadFile() {
    return new DownloadableFile(sharedFile, Downloadable.ContentDisposition.attachment, sharedFileMimeType);
  }
}