ca.nrc.cadc.net.HttpUpload Maven / Gradle / Ivy
Show all versions of cadc-util Show documentation
/*
************************************************************************
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2023. (c) 2023.
* Government of Canada Gouvernement du Canada
* National Research Council Conseil national de recherches
* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
* All rights reserved Tous droits réservés
*
* NRC disclaims any warranties, Le CNRC dénie toute garantie
* expressed, implied, or énoncée, implicite ou légale,
* statutory, of any kind with de quelque nature que ce
* respect to the software, soit, concernant le logiciel,
* including without limitation y compris sans restriction
* any warranty of merchantability toute garantie de valeur
* or fitness for a particular marchande ou de pertinence
* purpose. NRC shall not be pour un usage particulier.
* liable in any event for any Le CNRC ne pourra en aucun cas
* damages, whether direct or être tenu responsable de tout
* indirect, special or general, dommage, direct ou indirect,
* consequential or incidental, particulier ou général,
* arising from the use of the accessoire ou fortuit, résultant
* software. Neither the name de l'utilisation du logiciel. Ni
* of the National Research le nom du Conseil National de
* Council of Canada nor the Recherches du Canada ni les noms
* names of its contributors may de ses participants ne peuvent
* be used to endorse or promote être utilisés pour approuver ou
* products derived from this promouvoir les produits dérivés
* software without specific prior de ce logiciel sans autorisation
* written permission. préalable et particulière
* par écrit.
*
* This file is part of the Ce fichier fait partie du projet
* OpenCADC project. OpenCADC.
*
* OpenCADC is free software: OpenCADC est un logiciel libre ;
* you can redistribute it and/or vous pouvez le redistribuer ou le
* modify it under the terms of modifier suivant les termes de
* the GNU Affero General Public la “GNU Affero General Public
* License as published by the License” telle que publiée
* Free Software Foundation, par la Free Software Foundation
* either version 3 of the : soit la version 3 de cette
* License, or (at your option) licence, soit (à votre gré)
* any later version. toute version ultérieure.
*
* OpenCADC is distributed in the OpenCADC est distribué
* hope that it will be useful, dans l’espoir qu’il vous
* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
* without even the implied GARANTIE : sans même la garantie
* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
* General Public License for Générale Publique GNU Affero
* more details. pour plus de détails.
*
* You should have received Vous devriez avoir reçu une
* a copy of the GNU Affero copie de la Licence Générale
* General Public License along Publique GNU Affero avec
* with OpenCADC. If not, see OpenCADC ; si ce n’est
* Note: Redirects are never followed.
*
* @author zhangsa, pdowler
*
*/
public class HttpUpload extends HttpTransfer {
private static Logger log = Logger.getLogger(HttpUpload.class);
// input
private InputStream istream;
private OutputStreamWrapper wrapper;
private FileContent fileContent;
public HttpUpload(File src, URL dest) {
super(dest, false);
this.localFile = src;
if (localFile == null) {
throw new IllegalArgumentException("source File cannot be null");
}
setRequestProperty(CONTENT_LENGTH, Long.toString(localFile.length()));
}
public HttpUpload(FileContent src, URL dest) {
super(dest, false);
this.fileContent = src;
if (fileContent == null) {
throw new IllegalArgumentException("source FileContent cannot be null");
}
byte[] b = fileContent.getBytes();
this.istream = new ByteArrayInputStream(b);
setRequestProperty(CONTENT_LENGTH, Long.toString(b.length));
if (src.getContentType() != null) {
setRequestProperty(CONTENT_TYPE, src.getContentType());
}
}
public HttpUpload(InputStream src, URL dest) {
super(dest, false);
this.istream = src;
if (istream == null) {
throw new IllegalArgumentException("source InputStream cannot be null");
}
}
public HttpUpload(OutputStreamWrapper src, URL dest) {
super(dest, false);
this.wrapper = src;
if (wrapper == null) {
throw new IllegalArgumentException("source OutputStreamWrapper cannot be null");
}
}
/**
* @param val
* @deprecated use setRequestProperty(String, String)
*/
@Deprecated
public void setContentLength(long val) {
setRequestProperty(CONTENT_LENGTH, Long.toString(val));
}
/**
* @param val
* @deprecated use setRequestProperty(String, String)
*/
@Deprecated
public void setContentMD5(String val) {
setRequestProperty(CONTENT_MD5, val);
}
/**
* @param val
* @deprecated use setRequestProperty(String, String)
*/
@Deprecated
public void setContentEncoding(String val) {
setRequestProperty(CONTENT_ENCODING, val);
}
/**
* @param val
* @deprecated use setRequestProperty(String, String)
*/
@Deprecated
public void setContentType(String val) {
setRequestProperty(CONTENT_TYPE, val);
}
/**
* @return response converted to UTF-8 string
* @throws java.io.IOException
* @deprecated use prepare() and getInputStream()
*/
@Deprecated
public String getResponseBody() throws IOException {
try {
if (responseStream != null) {
return readResponseBody(responseStream);
}
} catch (InterruptedException ex) {
throw new RuntimeException("read interrupted", ex);
}
return null;
}
public void setResponseDestination(OutputStream responseDestination) {
this.responseDestination = responseDestination;
this.responseStreamWrapper = null;
}
public void setResponseStreamWrapper(InputStreamWrapper responseStreamWrapper) {
this.responseStreamWrapper = responseStreamWrapper;
this.responseDestination = null;
}
@Override
public void setFollowRedirects(boolean followRedirects) {
if (followRedirects) {
throw new IllegalArgumentException("followRedirects=true not allowed for upload");
}
}
@Override
public String toString() {
return "HttpUpload[" + remoteURL + "," + localFile + "]";
}
@Override
public void prepare()
throws AccessControlException, NotAuthenticatedException,
ByteLimitExceededException, ExpectationFailedException,
IllegalArgumentException, PreconditionFailedException,
ResourceAlreadyExistsException, ResourceNotFoundException,
TransientException, IOException, InterruptedException,
RangeNotSatisfiableException {
boolean ok = false;
try {
doActionWithRetryLoop();
ok = true;
} finally {
if (!ok) {
fireEvent(TransferEvent.FAILED);
}
}
}
@Override
protected void doAction()
throws AccessControlException, NotAuthenticatedException,
ByteLimitExceededException, ExpectationFailedException,
IllegalArgumentException, PreconditionFailedException,
ResourceAlreadyExistsException, ResourceNotFoundException,
TransientException, IOException, InterruptedException {
log.debug(this.toString());
if (!go) {
return; // cancelled while queued, event notification handled in terminate()
}
boolean throwTE = false;
try {
this.thread = Thread.currentThread();
fireEvent(TransferEvent.CONNECTING);
HttpURLConnection conn = (HttpURLConnection) this.remoteURL.openConnection();
super.setRequestOptions(conn);
conn.setRequestMethod("PUT");
conn.setUseCaches(false);
conn.setDoInput(true);
conn.setDoOutput(true);
setRequestHeaders(conn);
setRequestAuthHeaders(conn);
if (conn instanceof HttpsURLConnection) {
HttpsURLConnection sslConn = (HttpsURLConnection) conn;
initHTTPS(sslConn);
}
doPut(conn);
this.responseStream = conn.getInputStream();
log.debug("completed");
fireEvent(TransferEvent.COMPLETED);
} finally {
synchronized (this) {
// vs sync block in terminate()
if (thread != null) {
// clear interrupt status
if (Thread.interrupted()) {
go = false;
}
this.thread = null;
}
}
}
}
private void doPut(HttpURLConnection conn)
throws AccessControlException, NotAuthenticatedException,
ByteLimitExceededException, ExpectationFailedException,
IllegalArgumentException, PreconditionFailedException,
ResourceAlreadyExistsException, ResourceNotFoundException,
TransientException, IOException, InterruptedException,
RangeNotSatisfiableException {
OutputStream ostream = null;
FileInputStream fin = null;
InputStream in = null;
try {
ostream = conn.getOutputStream();
fireEvent(TransferEvent.CONNECTED);
if (localFile != null) {
fin = new FileInputStream(localFile);
in = fin;
} else if (istream != null) {
in = istream;
}
if (!(ostream instanceof BufferedOutputStream)) {
log.debug("using BufferedOutputStream");
ostream = new BufferedOutputStream(ostream, bufferSize);
}
if (in != null) {
log.debug("using BufferedInputStream");
in = new BufferedInputStream(in, bufferSize);
}
fireEvent(TransferEvent.TRANSFERING);
log.debug("before ioLoop: content-length = " + conn.getRequestProperty(CONTENT_LENGTH));
if (in != null) {
ioLoop(in, ostream, 2 * this.bufferSize, 0);
} else {
wrapper.write(ostream);
}
log.debug("OutputStream.flush");
long writeStart = System.currentTimeMillis();
ostream.flush();
if (logIO) {
long flushTime = System.currentTimeMillis() - writeStart;
writeTime += flushTime;
log.debug("Time (ms) to flush: " + flushTime);
}
log.debug("OutputStream.flush OK");
} finally {
// this makes the upload non-retry-able when streaming
if (istream != null) {
log.debug("closing InputStream");
try {
istream.close();
} catch (IOException ignore) {
// do nothing
}
}
try {
if (ostream != null) {
log.debug("OutputStream.close");
ostream.close();
log.debug("OutputStream.close OK");
}
} catch (IOException ignore) {
log.debug("OutputStream.close FAIL", ignore);
}
try {
if (fin != null) {
fin.close();
}
} catch (IOException ignore) {
// do nothing
}
}
checkErrors(remoteURL, conn);
}
}