org.apache.ace.obr/src/org/apache/ace/obr/servlet/BundleServlet.java - ace - Git at Google

 /*
  * 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 org.apache.ace.obr.servlet;

 import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
 import static javax.servlet.http.HttpServletResponse.SC_CONFLICT;
 import static javax.servlet.http.HttpServletResponse.SC_CREATED;
 import static javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
 import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
 import static javax.servlet.http.HttpServletResponse.SC_OK;
 import static org.osgi.service.log.LogService.LOG_DEBUG;
 import static org.osgi.service.log.LogService.LOG_INFO;
 import static org.osgi.service.log.LogService.LOG_WARNING;

 import java.io.EOFException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Dictionary;

 import javax.servlet.ServletException;
 import javax.servlet.ServletOutputStream;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;

 import org.apache.ace.obr.storage.BundleStore;
 import org.osgi.service.cm.ConfigurationException;
 import org.osgi.service.cm.ManagedService;
 import org.osgi.service.log.LogService;

 /**
  * Provides access to the OBR through a REST-ish API.
  */
 public class BundleServlet extends HttpServlet implements ManagedService {
     /**
      * If defined, allows you to return a different base URL for uploaded resources. Otherwise, the base URL is derived
      * from the originating request. Use this function in case your OBR is, for example, running behind a SSL offloading
      * proxy.
      */
     private static final String KEY_OBR_BASE_URL = "obrBaseUrl";

     private static final long serialVersionUID = 1L;

     private static final int COPY_BUFFER_SIZE = 4096;

     public static final String TEXT_MIMETYPE = "text/plain";
     public static final String SERVLET_ENDPOINT = "/obr/";

     // Managed by Felix DM...
     private volatile LogService m_log;
     private volatile BundleStore m_store;
     // Locally managed...
     private volatile String m_obrBaseURL;

     @Override
     public String getServletInfo() {
         return "Apache ACE OBR Servlet";
     }

     @Override
     public void updated(Dictionary<String, ?> properties) throws ConfigurationException {
         String obrBaseURL = null;
         if (properties != null) {
             obrBaseURL = (String) properties.get(KEY_OBR_BASE_URL);
             // Coerse empty values back to null...
             if (obrBaseURL != null && "".equals(obrBaseURL.trim())) {
                 obrBaseURL = null;
             }
             if (m_log != null) {
                 m_log.log(LOG_INFO, "Bundle servlet is using " + (obrBaseURL == null ? "(default)" : obrBaseURL)
                     + " as default base for uploaded bundles...");
             }
         }
         m_obrBaseURL = obrBaseURL;
     }

     /**
      * Responds to POST requests sent to http://host:port/obr by writing the received data to the bundle store and
      * returning the persistent location. Will send out a response that contains one of the following status codes:
      * <ul>
      * <li><code>HttpServletResponse.SC_BAD_REQUEST</code> - if no resource was specified</li>
      * <li><code>HttpServletResponse.SC_CONFLICT</code> - if the resource already exists</li>
      * <li><code>HttpServletResponse.SC_INTERNAL_SERVER_ERROR</code> - if there was a problem storing the resource</li>
      * <li><code>HttpServletResponse.SC_CREATED</code> - if all went fine</li>
      * </ul>
      */
     @Override
     protected void doPost(HttpServletRequest request, HttpServletResponse response) {
         String fileName = request.getParameter("filename");
         boolean replace = Boolean.parseBoolean(request.getParameter("replace"));

         try {
             String storePath = m_store.put(request.getInputStream(), fileName, replace);
             if (storePath != null) {
                 m_log.log(LOG_INFO, "Uploaded '" + fileName + "' to OBR as: " + storePath + " (replace = " + replace + ")");

                 sendCreated(request, response, storePath);
             }
             else {
                 m_log.log(LOG_INFO, "Conflicting upload for '" + fileName + "': already exists and not replacing it...");

                 sendResponse(response, SC_CONFLICT);
             }
         }
         catch (IOException e) {
             m_log.log(LOG_WARNING, "Exception handling request: " + request.getRequestURL(), e);
             sendResponse(response, SC_INTERNAL_SERVER_ERROR);
         }
     }

     /**
      * Responds to DELETE requests sent to http://host:port/obr/resource by deleting the file specified. Will send out a
      * response that contains one of the following status codes: <br>
      * <li><code>HttpServletResponse.SC_BAD_REQUEST</code> - if no resource was specified
      * <li><code>HttpServletResponse.SC_NOT_FOUND</code> - if the specified resource did not exist
      * <li><code>HttpServletResponse.SC_INTERNAL_SERVER_ERROR</code> - if there was a problem deleting the resource
      * <li><code>HttpServletResponse.SC_OK</code> - if all went fine
      */
     @Override
     protected void doDelete(HttpServletRequest request, HttpServletResponse response) {
         String path = request.getPathInfo();
         if ((path == null) || (path.length() <= 1)) {
             sendResponse(response, SC_BAD_REQUEST);
         }
         else {
             // Remove leading slash...
             String id = path.substring(1);
             try {
                 if (m_store.remove(id)) {
                     m_log.log(LOG_INFO, "Deleted '" + id + "' from OBR...");

                     sendResponse(response, SC_OK);
                 }
                 else {
                     m_log.log(LOG_INFO, "Unable to delete '" + id + "': it does not exist.");

                     sendResponse(response, SC_NOT_FOUND);
                 }
             }
             catch (IOException e) {
                 m_log.log(LOG_WARNING, "Exception handling request: " + request.getRequestURL(), e);
                 sendResponse(response, SC_INTERNAL_SERVER_ERROR);
             }
         }
     }

     /**
      * Responds to GET requests sent to http://host:port/obr/resource with a stream to the specified filename. Will send
      * out a response that contains one of the following status codes: <br>
      * <li><code>HttpServletResponse.SC_BAD_REQUEST</code> - if no resource is specified
      * <li><code>HttpServletResponse.SC_INTERNAL_SERVER_ERROR</code> - if there was a problem storing the resource
      * <li><code>HttpServletResponse.SC_OK</code> - if all went fine <br>
      * The response will only contain the data of the requested resource if the status code of the response is
      * <code>HttpServletResponse.SC_OK</code>.
      */
     @Override
     protected void doGet(HttpServletRequest request, HttpServletResponse response) {
         String path = request.getPathInfo();
         if ((path == null) || (path.length() <= 1)) {
             sendResponse(response, SC_BAD_REQUEST);
         }
         else {
             // Remove leading slash...
             String id = path.substring(1);

             try (InputStream fileStream = m_store.get(id); ServletOutputStream output = response.getOutputStream()) {
                 if (fileStream == null) {
                     sendResponse(response, HttpServletResponse.SC_NOT_FOUND);
                 }
                 else {
                     // send the bundle as stream to the caller
                     response.setContentType(TEXT_MIMETYPE);

                     byte[] buffer = new byte[COPY_BUFFER_SIZE];
                     for (int bytes = fileStream.read(buffer); bytes != -1; bytes = fileStream.read(buffer)) {
                         output.write(buffer, 0, bytes);
                     }
                 }
             }
             catch (EOFException ex) {
                 // ACE-260: lower log-level of this exception; as it is probably because the
                 // remote hung up early...
                 m_log.log(LOG_DEBUG, "EOF Exception in request: " + request.getRequestURL()
                     + "; probably the remote hung up early.");
             }
             catch (IOException ex) {
                 // ACE-260: all other exception are logged, as we might have a possible resource
                 // leak...
                 m_log.log(LOG_WARNING, "Exception in request: " + request.getRequestURL(), ex);
                 sendResponse(response, SC_INTERNAL_SERVER_ERROR);
             }
         }
     }

     /**
      * Responds to HEAD requests sent to http://host:port/obr/resource with a stream to the specified filename. Will
      * send out a response that contains one of the following status codes: <br>
      * <li><code>HttpServletResponse.SC_BAD_REQUEST</code> - if no resource is specified
      * <li><code>HttpServletResponse.SC_INTERNAL_SERVER_ERROR</code> - if there was a problem storing the resource
      * <li><code>HttpServletResponse.SC_NOT_FOUND</code> - if the requested resource does not exist
      * <li><code>HttpServletResponse.SC_OK</code> - if all went fine <br>
      * The response is empty in all situations.
      */
     @Override
     protected void doHead(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
         String path = request.getPathInfo();
         if ((path == null) || (path.length() <= 1)) {
             sendResponse(response, SC_BAD_REQUEST);
         }
         else {
             // Remove leasing slash...
             String id = path.substring(1);

             try {
                 if (m_store.exists(id)) {
                     sendResponse(response, HttpServletResponse.SC_OK);
                 }
                 else {
                     sendResponse(response, HttpServletResponse.SC_NOT_FOUND);
                 }
             }
             catch (IOException ex) {
                 // ACE-260: all other exception are logged, as we might have a possible resource
                 // leak...
                 m_log.log(LOG_WARNING, "Exception in request: " + request.getRequestURL(), ex);
                 sendResponse(response, SC_INTERNAL_SERVER_ERROR);
             }
         }
     }

     // send a created response with location header
     private void sendCreated(HttpServletRequest request, HttpServletResponse response, String relativePath) {
         StringBuffer location;

         String obrBaseURL = m_obrBaseURL;
         if (obrBaseURL != null) {
             location = new StringBuffer(obrBaseURL);
         }
         else {
             location = request.getRequestURL();
         }

         if (location.charAt(location.length() - 1) != '/') {
             location.append('/');
         }
         location.append(relativePath);

         response.setHeader("Location", location.toString());
         response.setStatus(SC_CREATED);
     }

     // send a response with the specified status code
     private void sendResponse(HttpServletResponse response, int statusCode) {
         sendResponse(response, statusCode, "");
     }

     // send a response with the specified status code and description
     private void sendResponse(HttpServletResponse response, int statusCode, String description) {
         try {
             response.sendError(statusCode, description);
         }
         catch (Exception e) {
             m_log.log(LOG_WARNING, "Unable to send response with status code '" + statusCode + "'", e);
         }
     }
 }
	/*
	* 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 org.apache.ace.obr.servlet;

	import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
	import static javax.servlet.http.HttpServletResponse.SC_CONFLICT;
	import static javax.servlet.http.HttpServletResponse.SC_CREATED;
	import static javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
	import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
	import static javax.servlet.http.HttpServletResponse.SC_OK;
	import static org.osgi.service.log.LogService.LOG_DEBUG;
	import static org.osgi.service.log.LogService.LOG_INFO;
	import static org.osgi.service.log.LogService.LOG_WARNING;

	import java.io.EOFException;
	import java.io.IOException;
	import java.io.InputStream;
	import java.util.Dictionary;

	import javax.servlet.ServletException;
	import javax.servlet.ServletOutputStream;
	import javax.servlet.http.HttpServlet;
	import javax.servlet.http.HttpServletRequest;
	import javax.servlet.http.HttpServletResponse;

	import org.apache.ace.obr.storage.BundleStore;
	import org.osgi.service.cm.ConfigurationException;
	import org.osgi.service.cm.ManagedService;
	import org.osgi.service.log.LogService;

	/**
	* Provides access to the OBR through a REST-ish API.
	*/
	public class BundleServlet extends HttpServlet implements ManagedService {
	/**
	* If defined, allows you to return a different base URL for uploaded resources. Otherwise, the base URL is derived
	* from the originating request. Use this function in case your OBR is, for example, running behind a SSL offloading
	* proxy.
	*/
	private static final String KEY_OBR_BASE_URL = "obrBaseUrl";

	private static final long serialVersionUID = 1L;

	private static final int COPY_BUFFER_SIZE = 4096;

	public static final String TEXT_MIMETYPE = "text/plain";
	public static final String SERVLET_ENDPOINT = "/obr/";

	// Managed by Felix DM...
	private volatile LogService m_log;
	private volatile BundleStore m_store;
	// Locally managed...
	private volatile String m_obrBaseURL;

	@Override
	public String getServletInfo() {
	return "Apache ACE OBR Servlet";
	}

	@Override
	public void updated(Dictionary<String, ?> properties) throws ConfigurationException {
	String obrBaseURL = null;
	if (properties != null) {
	obrBaseURL = (String) properties.get(KEY_OBR_BASE_URL);
	// Coerse empty values back to null...
	if (obrBaseURL != null && "".equals(obrBaseURL.trim())) {
	obrBaseURL = null;
	}
	if (m_log != null) {
	m_log.log(LOG_INFO, "Bundle servlet is using " + (obrBaseURL == null ? "(default)" : obrBaseURL)
	+ " as default base for uploaded bundles...");
	}
	}
	m_obrBaseURL = obrBaseURL;
	}

	/**
	* Responds to POST requests sent to http://host:port/obr by writing the received data to the bundle store and
	* returning the persistent location. Will send out a response that contains one of the following status codes:
	* <ul>
	* <li><code>HttpServletResponse.SC_BAD_REQUEST</code> - if no resource was specified</li>
	* <li><code>HttpServletResponse.SC_CONFLICT</code> - if the resource already exists</li>
	* <li><code>HttpServletResponse.SC_INTERNAL_SERVER_ERROR</code> - if there was a problem storing the resource</li>
	* <li><code>HttpServletResponse.SC_CREATED</code> - if all went fine</li>
	* </ul>
	*/
	@Override
	protected void doPost(HttpServletRequest request, HttpServletResponse response) {
	String fileName = request.getParameter("filename");
	boolean replace = Boolean.parseBoolean(request.getParameter("replace"));

	try {
	String storePath = m_store.put(request.getInputStream(), fileName, replace);
	if (storePath != null) {
	m_log.log(LOG_INFO, "Uploaded '" + fileName + "' to OBR as: " + storePath + " (replace = " + replace + ")");

	sendCreated(request, response, storePath);
	}
	else {
	m_log.log(LOG_INFO, "Conflicting upload for '" + fileName + "': already exists and not replacing it...");

	sendResponse(response, SC_CONFLICT);
	}
	}
	catch (IOException e) {
	m_log.log(LOG_WARNING, "Exception handling request: " + request.getRequestURL(), e);
	sendResponse(response, SC_INTERNAL_SERVER_ERROR);
	}
	}

	/**
	* Responds to DELETE requests sent to http://host:port/obr/resource by deleting the file specified. Will send out a
	* response that contains one of the following status codes: <br>
	* <li><code>HttpServletResponse.SC_BAD_REQUEST</code> - if no resource was specified
	* <li><code>HttpServletResponse.SC_NOT_FOUND</code> - if the specified resource did not exist
	* <li><code>HttpServletResponse.SC_INTERNAL_SERVER_ERROR</code> - if there was a problem deleting the resource
	* <li><code>HttpServletResponse.SC_OK</code> - if all went fine
	*/
	@Override
	protected void doDelete(HttpServletRequest request, HttpServletResponse response) {
	String path = request.getPathInfo();
	if ((path == null) \|\| (path.length() <= 1)) {
	sendResponse(response, SC_BAD_REQUEST);
	}
	else {
	// Remove leading slash...
	String id = path.substring(1);
	try {
	if (m_store.remove(id)) {
	m_log.log(LOG_INFO, "Deleted '" + id + "' from OBR...");

	sendResponse(response, SC_OK);
	}
	else {
	m_log.log(LOG_INFO, "Unable to delete '" + id + "': it does not exist.");

	sendResponse(response, SC_NOT_FOUND);
	}
	}
	catch (IOException e) {
	m_log.log(LOG_WARNING, "Exception handling request: " + request.getRequestURL(), e);
	sendResponse(response, SC_INTERNAL_SERVER_ERROR);
	}
	}
	}

	/**
	* Responds to GET requests sent to http://host:port/obr/resource with a stream to the specified filename. Will send
	* out a response that contains one of the following status codes: <br>
	* <li><code>HttpServletResponse.SC_BAD_REQUEST</code> - if no resource is specified
	* <li><code>HttpServletResponse.SC_INTERNAL_SERVER_ERROR</code> - if there was a problem storing the resource
	* <li><code>HttpServletResponse.SC_OK</code> - if all went fine <br>
	* The response will only contain the data of the requested resource if the status code of the response is
	* <code>HttpServletResponse.SC_OK</code>.
	*/
	@Override
	protected void doGet(HttpServletRequest request, HttpServletResponse response) {
	String path = request.getPathInfo();
	if ((path == null) \|\| (path.length() <= 1)) {
	sendResponse(response, SC_BAD_REQUEST);
	}
	else {
	// Remove leading slash...
	String id = path.substring(1);

	try (InputStream fileStream = m_store.get(id); ServletOutputStream output = response.getOutputStream()) {
	if (fileStream == null) {
	sendResponse(response, HttpServletResponse.SC_NOT_FOUND);
	}
	else {
	// send the bundle as stream to the caller
	response.setContentType(TEXT_MIMETYPE);

	byte[] buffer = new byte[COPY_BUFFER_SIZE];
	for (int bytes = fileStream.read(buffer); bytes != -1; bytes = fileStream.read(buffer)) {
	output.write(buffer, 0, bytes);
	}
	}
	}
	catch (EOFException ex) {
	// ACE-260: lower log-level of this exception; as it is probably because the
	// remote hung up early...
	m_log.log(LOG_DEBUG, "EOF Exception in request: " + request.getRequestURL()
	+ "; probably the remote hung up early.");
	}
	catch (IOException ex) {
	// ACE-260: all other exception are logged, as we might have a possible resource
	// leak...
	m_log.log(LOG_WARNING, "Exception in request: " + request.getRequestURL(), ex);
	sendResponse(response, SC_INTERNAL_SERVER_ERROR);
	}
	}
	}

	/**
	* Responds to HEAD requests sent to http://host:port/obr/resource with a stream to the specified filename. Will
	* send out a response that contains one of the following status codes: <br>
	* <li><code>HttpServletResponse.SC_BAD_REQUEST</code> - if no resource is specified
	* <li><code>HttpServletResponse.SC_INTERNAL_SERVER_ERROR</code> - if there was a problem storing the resource
	* <li><code>HttpServletResponse.SC_NOT_FOUND</code> - if the requested resource does not exist
	* <li><code>HttpServletResponse.SC_OK</code> - if all went fine <br>
	* The response is empty in all situations.
	*/
	@Override
	protected void doHead(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
	String path = request.getPathInfo();
	if ((path == null) \|\| (path.length() <= 1)) {
	sendResponse(response, SC_BAD_REQUEST);
	}
	else {
	// Remove leasing slash...
	String id = path.substring(1);

	try {
	if (m_store.exists(id)) {
	sendResponse(response, HttpServletResponse.SC_OK);
	}
	else {
	sendResponse(response, HttpServletResponse.SC_NOT_FOUND);
	}
	}
	catch (IOException ex) {
	// ACE-260: all other exception are logged, as we might have a possible resource
	// leak...
	m_log.log(LOG_WARNING, "Exception in request: " + request.getRequestURL(), ex);
	sendResponse(response, SC_INTERNAL_SERVER_ERROR);
	}
	}
	}

	// send a created response with location header
	private void sendCreated(HttpServletRequest request, HttpServletResponse response, String relativePath) {
	StringBuffer location;

	String obrBaseURL = m_obrBaseURL;
	if (obrBaseURL != null) {
	location = new StringBuffer(obrBaseURL);
	}
	else {
	location = request.getRequestURL();
	}

	if (location.charAt(location.length() - 1) != '/') {
	location.append('/');
	}
	location.append(relativePath);

	response.setHeader("Location", location.toString());
	response.setStatus(SC_CREATED);
	}

	// send a response with the specified status code
	private void sendResponse(HttpServletResponse response, int statusCode) {
	sendResponse(response, statusCode, "");
	}

	// send a response with the specified status code and description
	private void sendResponse(HttpServletResponse response, int statusCode, String description) {
	try {
	response.sendError(statusCode, description);
	}
	catch (Exception e) {
	m_log.log(LOG_WARNING, "Unable to send response with status code '" + statusCode + "'", e);
	}
	}
	}