Java tutorial
/** * The software subject to this notice and license includes both human readable * source code form and machine readable, binary, object code form. The NCI OCR * Software was developed in conjunction with the National Cancer Institute * (NCI) by NCI employees and 5AM Solutions, Inc. (5AM). To the extent * government employees are authors, any rights in such works shall be subject * to Title 17 of the United States Code, section 105. * * This NCI OCR Software License (the License) is between NCI and You. You (or * Your) shall mean a person or an entity, and all other entities that control, * are controlled by, or are under common control with the entity. Control for * purposes of this definition means (i) the direct or indirect power to cause * the direction or management of such entity, whether by contract or otherwise, * or (ii) ownership of fifty percent (50%) or more of the outstanding shares, * or (iii) beneficial ownership of such entity. * * This License is granted provided that You agree to the conditions described * below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up, * no-charge, irrevocable, transferable and royalty-free right and license in * its rights in the NCI OCR Software to (i) use, install, access, operate, * execute, copy, modify, translate, market, publicly display, publicly perform, * and prepare derivative works of the NCI OCR Software; (ii) distribute and * have distributed to and by third parties the NCI OCR Software and any * modifications and derivative works thereof; and (iii) sublicense the * foregoing rights set out in (i) and (ii) to third parties, including the * right to license such rights to further third parties. For sake of clarity, * and not by way of limitation, NCI shall have no right of accounting or right * of payment from You or Your sub-licensees for the rights granted under this * License. This License is granted at no charge to You. * * Your redistributions of the source code for the Software must retain the * above copyright notice, this list of conditions and the disclaimer and * limitation of liability of Article 6, below. Your redistributions in object * code form must reproduce the above copyright notice, this list of conditions * and the disclaimer of Article 6 in the documentation and/or other materials * provided with the distribution, if any. * * Your end-user documentation included with the redistribution, if any, must * include the following acknowledgment: This product includes software * developed by 5AM and the National Cancer Institute. If You do not include * such end-user documentation, You shall include this acknowledgment in the * Software itself, wherever such third-party acknowledgments normally appear. * * You may not use the names "The National Cancer Institute", "NCI", or "5AM" * to endorse or promote products derived from this Software. This License does * not authorize You to use any trademarks, service marks, trade names, logos or * product names of either NCI or 5AM, except as required to comply with the * terms of this License. * * For sake of clarity, and not by way of limitation, You may incorporate this * Software into Your proprietary programs and into any third party proprietary * programs. However, if You incorporate the Software into third party * proprietary programs, You agree that You are solely responsible for obtaining * any permission from such third parties required to incorporate the Software * into such third party proprietary programs and for informing Your * sub-licensees, including without limitation Your end-users, of their * obligation to secure any required permissions from such third parties before * incorporating the Software into such third party proprietary software * programs. In the event that You fail to obtain such permissions, You agree * to indemnify NCI for any claims against NCI by such third parties, except to * the extent prohibited by law, resulting from Your failure to obtain such * permissions. * * For sake of clarity, and not by way of limitation, You may add Your own * copyright statement to Your modifications and to the derivative works, and * You may provide additional or different license terms and conditions in Your * sublicenses of modifications of the Software, or any derivative works of the * Software as a whole, provided Your use, reproduction, and distribution of the * Work otherwise complies with the conditions stated in this License. * * THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES, * (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO * EVENT SHALL THE NATIONAL CANCER INSTITUTE, 5AM SOLUTIONS, INC. OR THEIR * AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ package gov.nih.nci.firebird.web.common; import gov.nih.nci.firebird.service.file.FileMetadata; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.Serializable; import javax.activation.FileTypeMap; import javax.servlet.ServletContext; import org.apache.commons.io.FileUtils; import org.apache.commons.io.IOUtils; import org.apache.log4j.Logger; import org.semanticdesktop.aperture.mime.identifier.magic.MagicMimeTypeIdentifier; /** * wrapper for file related info. * (nicely named for Struts) */ public class Struts2UploadedFileInfo implements Serializable { private static final long serialVersionUID = 1L; private static final Logger LOG = Logger.getLogger(Struts2UploadedFileInfo.class); private static final MagicMimeTypeIdentifier IDENTIFIER = new MagicMimeTypeIdentifier(); private File data; private String dataFileName; private String dataContentType; private String description; /** * ctor. * @param data the file containing the data. * @param dataFileName name of the file. * @param dataContentType mime type. * @param description description of the file. */ @SuppressWarnings("ucd") // convenience constructor used in tests public Struts2UploadedFileInfo(File data, String dataFileName, String dataContentType, String description) { this.data = data; this.dataFileName = dataFileName; this.dataContentType = dataContentType; this.description = description; } /** * default ctor. */ public Struts2UploadedFileInfo() { // no-op } /** * @return the file containing the data. */ public File getData() { return data; } /** * @param data the file containing the data. */ public void setData(File data) { this.data = data; } /** * @return mime type announced by the browser. */ public String getDataContentType() { return dataContentType; } /** * @return file type according to the system. * @see FileTypeMap. */ private String getSystemFileType() { return FileTypeMap.getDefaultFileTypeMap().getContentType(dataFileName); } /** * @return file type according to the web-app. * @see ServletContext#getMimeType(java.lang.String) . */ private String getContextFileType(ServletContext context) { return context.getMimeType(dataFileName); } /** * @return file type using magic number. * @see MagicFile#getMimeType(java.io.InputStream) . */ private String getMagicFileType() { byte[] litmus = new byte[(int) Math.min(data.length(), (long) IDENTIFIER.getMinArrayLength())]; FileInputStream in = null; String type = null; try { in = FileUtils.openInputStream(data); in.read(litmus); type = IDENTIFIER.identify(litmus, dataFileName, null); } catch (IOException ex) { LOG.warn(ex); } finally { IOUtils.closeQuietly(in); } return type; } /** * @param dataContentType mime type. */ public void setDataContentType(String dataContentType) { this.dataContentType = dataContentType; } /** * @return name of the file. */ public String getDataFileName() { return dataFileName; } /** * @param dataFileName name of the file. */ public void setDataFileName(String dataFileName) { this.dataFileName = dataFileName; } /** * @return description description of the file. */ public String getDescription() { return description; } /** * @param description description of the file. */ public void setDescription(String description) { this.description = description; } /** * Returns the file metadata recorded in this object. * use {@link #resolveContentType(ServletContext) if you don't trust the client's content type declaration. * @return the metadata object. */ public FileMetadata getMetadata() { return new FileMetadata(getDataFileName(), getDataContentType(), getDescription()); } /** * Types to replace the client's content type with a more reliable one. * @param context app context. */ public void resolveContentType(ServletContext context) { String type = getMagicFileType(); if (type == null) { type = getContextFileType(context); } if (type == null) { type = getSystemFileType(); } if (type != null) { this.dataContentType = type; } } }