ca.nrc.cadc.rest.SyncInput Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cadc-rest Show documentation
Show all versions of cadc-rest Show documentation
OpenCADC REST server library
/*
************************************************************************
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2020. (c) 2020.
* 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
* content = new TreeMap<>(new CaseInsensitiveStringComparator());
private final Map> params = new TreeMap<>(new CaseInsensitiveStringComparator());
public SyncInput(HttpServletRequest request, InlineContentHandler handler)
throws IOException {
this.request = request;
this.inlineContentHandler = handler;
if (log.isDebugEnabled()) {
Enumeration e = request.getHeaderNames();
while (e.hasMoreElements()) {
String k = e.nextElement();
String v = request.getHeader(k);
log.debug("request header: " + k + " = " + v);
}
}
}
/**
* Get the real client IP address. The REST binding is split up as follows:
*
* requestURI = protocol :// hostname / requestPath
* requestPath = contextPath / componentPath / path
*
*
* @return client IP address
*/
public String getClientIP() {
return NetUtil.getClientIP(request);
}
/**
* Get the HTTP protocol used for the request.
*
* @return transport protocol (http or https)
*/
public String getProtocol() {
return request.getScheme();
}
/**
* Get the complete request URI. This contains everything from protocol, hostname,
* optional port, and request path.
*
* @return complete request URI
*/
public String getRequestURI() {
return request.getRequestURL().toString();
}
/**
* Get the complete path in the request. This is simply the path component of
* the requestURI.
*
* @return complete path
*/
public String getRequestPath() {
String uri = getRequestURI();
URI u = URI.create(uri);
return u.getPath();
}
/**
* Get the path up to the rest binding. This returns the base path of the
* REST application.
*
* @return context path
*/
public String getContextPath() {
String ret = request.getContextPath();
return ret;
}
/**
* Get the path up to the rest binding. This returns the path of the
* REST application component.
*
* @return context path
*/
public String getComponentPath() {
String ret = request.getServletPath();
return ret;
}
/**
* Get the application-specific path. This is the rest of the path after the
* context path with leading slash removed.
*
* @return application-specific sub-path, possibly null
*/
public String getPath() {
String ret = request.getPathInfo();
if (ret == null) {
return ret;
}
if (ret.charAt(0) == '/') {
ret = ret.substring(1);
}
return ret;
}
/**
* Get a URI of the Digest header. The header format is {algorithm}={base64 checksum}.
* Decodes the base64 checksum and returns a URI of the form {algorithm}:{hex checksum}.
* @return Digest URI, or null if Digest header not set.
*/
public URI getDigest() {
return DigestUtil.getURI(getHeader("Digest"));
}
/**
* Get a request header value.
*
* @param name HTTP header name
* @return header value, possibly null
*/
public String getHeader(String name) {
return request.getHeader(name);
}
/**
* Get set of all parameters included in the request.
*
* @return set of parameter names
*/
public Set getParameterNames() {
return params.keySet();
}
/**
* Get a request parameter value. If there are multiple instances of the parameter,
* the first is returned (see getParameters).
*
* @param name name of parameter
* @return a value for the specified parameter name; may be null
*/
public String getParameter(String name) {
List vals = params.get(name);
if (vals != null && !vals.isEmpty()) {
return vals.get(0);
}
return null;
}
/**
* Get all request parameter values.
*
* @param name name of parameter
* @return all values for the specified parameter name; may be null
*/
public List getParameters(String name) {
return params.get(name);
}
/**
* Get set of all names for inline content in the request. Accessing inline content
* requires an InlineContentHandler.
*
* @return set of inline content names
*/
public Set getContentNames() {
return content.keySet();
}
/**
* Get an inline content object.
*
* @param name name of inline object
* @return an object for the specified content name; may be null
*/
public Object getContent(String name) {
return content.get(name);
}
// called by RestAction
void init() throws IOException, ResourceNotFoundException, TransientException {
if (request.getMethod().equals("GET")
|| request.getMethod().equals("HEAD")
|| request.getMethod().equals("DELETE")) {
Enumeration names = request.getParameterNames();
while (names.hasMoreElements()) {
String name = names.nextElement();
processParameter(name, Arrays.asList(request.getParameterValues(name)));
}
} else {
String contentType = request.getContentType();
if (contentType != null) {
int i = contentType.indexOf(';');
if (i > 0) {
contentType = contentType.substring(0, i);
}
}
log.debug("Content-Type: " + contentType);
if (contentType != null && contentType.equalsIgnoreCase(RestAction.URLENCODED)) {
Enumeration names = request.getParameterNames();
while (names.hasMoreElements()) {
String name = names.nextElement();
processParameter(name, Arrays.asList(request.getParameterValues(name)));
}
} else if (contentType != null && contentType.startsWith(RestAction.MULTIPART)) {
try {
ServletFileUpload upload = new ServletFileUpload();
FileItemIterator itemIterator = upload.getItemIterator(request);
processMultiPart(itemIterator);
} catch (FileUploadException ex) {
throw new IOException("Failed to process " + RestAction.MULTIPART, ex);
}
} else {
processStream(null, contentType, request.getInputStream());
}
}
}
private void processParameter(String name, List values) {
List cur = params.get(name);
if (cur == null) {
params.put(name, values);
} else {
cur.addAll(values);
}
}
private void processMultiPart(FileItemIterator itemIterator)
throws FileUploadException, IOException, ResourceNotFoundException, TransientException {
while (itemIterator.hasNext()) {
FileItemStream item = itemIterator.next();
String name = item.getFieldName();
InputStream stream = item.openStream();
if (item.isFormField()) {
final List streamList = new ArrayList<>();
streamList.add(Streams.asString(stream));
processParameter(name, streamList);
} else {
processStream(name, item.getContentType(), stream);
}
}
}
private void processStream(String name, String contentType, InputStream inputStream)
throws IOException, ResourceNotFoundException, TransientException {
if (inlineContentHandler == null) {
log.warn("request includes inline content and InlineContentHandler is null");
// TODO: Need to figure if we need to process the stream to completion
return;
}
InlineContentHandler.Content c = inlineContentHandler.accept(name, contentType, new CloseWrapper(inputStream));
content.put(c.name, c.value);
}
// this is here to aid in debugging InputStream failures like the one where some library code
// called close() in a finalise() method, eg during garbage collection
private class CloseWrapper extends FilterInputStream {
final String tname;
CloseWrapper(InputStream in) {
super(in);
this.tname = "CloseWrapper[" + Thread.currentThread().getName() + "] ";
}
@Override
public void close() throws IOException {
//Exception ex = new Exception();
//String streamID = super.in.toString();
//log.debug(tname + " - " + streamID + ": close() was called: ", ex);
super.in.close();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy