Download.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 de.unioninvestment.eai.portal.portlet.crud.domain.model;

import java.io.InputStream;

/**
 * Interface that provides creation of a document to be downloaded.
 * 
 * @author cmj
 */
public interface Download {

	/**
	 * Status Interface for updating the progress indicator.
	 * 
	 * @author cmj
	 * 
	 */
	public interface Status {
		/**
		 * Optionally called to allow for provision of a progress bar.
		 * 
		 * @param progress
		 *            The current progress (e.g. count / size)
		 * @throws ExportInterruptionException if the download was cancelled
		 */
		public void updateProgress(float progress);
	}

	/**
	 * @return the file name of the download
	 */
	String getFilename();

	/**
	 * @return the mime type of the download
	 */
	String getMimeType();

	/**
	 * Creates the document, called from within a background thread.
	 * 
	 * @param status
	 *            for progress updates
	 * @return the document content as a stream
	 */
	public InputStream build(Status status);

}