/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package com.sun.appserv.management.helper;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;

import com.sun.appserv.management.base.UploadDownloadMgr;

/**
	Miscellaneous helper routines specific to AMX.  These routines
	may be moved prior to the release of 9.0
	@since AppServer 9.0
 */
public class Misc
{
	private	Misc()	{}
	
	/**
		Upload a file to the server and return an opaque identifier which server-side
		code may use to identify and use the file.  Uploading a file is typically done
		prior to deploying it, but may be done for other purposes.
		
		@param mgr  an instance of UploadDownloadMgr,
			obtained via getDomainRoot().getUploadDownloadMgr()
		@param theFile	the file to upload
		@return an upload ID
	 */
		public static Object
	uploadFile(
		final UploadDownloadMgr	mgr,
		final File	theFile  )
		throws IOException
	{
		final FileInputStream	input	= new FileInputStream( theFile );
		final long		length	= input.available();
		final Object	uploadID	= mgr.initiateUpload( theFile.getName(), length );
			
		try
		{
			final int	chunkSize	= 256 * 1024;
			long remaining	= length;
			while ( remaining != 0 )
			{
				final int	actual	= remaining < chunkSize ? (int)remaining : chunkSize;
				
				final byte[]	bytes	= new byte[ actual ];
				final int	num	= input.read( bytes );
				if ( num != actual )
				{
					throw new IOException();
				}

				mgr.uploadBytes( uploadID, bytes );
				remaining	-= actual;
			}
		}
		finally
		{
			input.close();
		}
		
		return( uploadID );
	}
}