From 77951efb71dabe46d8336cbbca4e905ccbabd862 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Wed, 14 Sep 2011 11:46:50 +0200 Subject: [PATCH] added plain text support for blame --- .../scm/api/rest/PlainBlameProvider.java | 172 ++++++++++++++++++ .../scm/api/rest/UriExtensionsConfig.java | 6 + 2 files changed, 178 insertions(+) create mode 100644 scm-webapp/src/main/java/sonia/scm/api/rest/PlainBlameProvider.java diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/PlainBlameProvider.java b/scm-webapp/src/main/java/sonia/scm/api/rest/PlainBlameProvider.java new file mode 100644 index 0000000000..a13ffd963f --- /dev/null +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/PlainBlameProvider.java @@ -0,0 +1,172 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of SCM-Manager; nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS 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. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.api.rest; + +//~--- non-JDK imports -------------------------------------------------------- + +import sonia.scm.repository.BlameLine; +import sonia.scm.repository.BlamePagingResult; +import sonia.scm.util.Util; + +//~--- JDK imports ------------------------------------------------------------ + +import com.sun.jersey.core.provider.AbstractMessageReaderWriterProvider; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.PrintWriter; + +import java.lang.annotation.Annotation; +import java.lang.reflect.Type; + +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.MultivaluedMap; +import javax.ws.rs.ext.Provider; + +/** + * + * @author Sebastian Sdorra + */ +@Provider +public class PlainBlameProvider + extends AbstractMessageReaderWriterProvider +{ + + /** + * Method description + * + * + * @param type + * @param genericType + * @param annotations + * @param mediaType + * @param httpHeaders + * @param entityStream + * + * @return + * + * @throws IOException + * @throws WebApplicationException + */ + @Override + public BlamePagingResult readFrom(Class type, + Type genericType, Annotation[] annotations, + MediaType mediaType, + MultivaluedMap httpHeaders, + InputStream entityStream) + throws IOException, WebApplicationException + { + throw new IOException("method is not implemented"); + } + + /** + * Method description + * + * + * @param bpr + * @param type + * @param genericType + * @param annotations + * @param mediaType + * @param httpHeaders + * @param entityStream + * + * @throws IOException + * @throws WebApplicationException + */ + @Override + public void writeTo(BlamePagingResult bpr, Class type, Type genericType, + Annotation[] annotations, MediaType mediaType, + MultivaluedMap httpHeaders, + OutputStream entityStream) + throws IOException, WebApplicationException + { + PrintWriter writer = new PrintWriter(entityStream); + + for (BlameLine line : bpr.getBlameLines()) + { + String name = line.getName(); + + if (Util.isNotEmpty(name)) + { + writer.append(name).append(" "); + } + + writer.println(line.getCode()); + } + + writer.flush(); + } + + //~--- get methods ---------------------------------------------------------- + + /** + * Method description + * + * + * @param type + * @param genericType + * @param annotations + * @param mediaType + * + * @return + */ + @Override + public boolean isReadable(Class type, Type genericType, + Annotation[] annotations, MediaType mediaType) + { + return false; + } + + /** + * Method description + * + * + * @param type + * @param genericType + * @param annotations + * @param mediaType + * + * @return + */ + @Override + public boolean isWriteable(Class type, Type genericType, + Annotation[] annotations, MediaType mediaType) + { + return (type == BlamePagingResult.class) + && mediaType.equals(MediaType.TEXT_PLAIN_TYPE); + } +} diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/UriExtensionsConfig.java b/scm-webapp/src/main/java/sonia/scm/api/rest/UriExtensionsConfig.java index 5bf7ea7337..de5b748243 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/UriExtensionsConfig.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/UriExtensionsConfig.java @@ -29,6 +29,8 @@ * */ + + package sonia.scm.api.rest; //~--- JDK imports ------------------------------------------------------------ @@ -50,6 +52,9 @@ public class UriExtensionsConfig extends PackagesResourceConfig /** Field description */ public static final String EXTENSION_JSON = "json"; + /** Field description */ + public static final String EXTENSION_TXT = "txt"; + /** Field description */ public static final String EXTENSION_XML = "xml"; @@ -102,6 +107,7 @@ public class UriExtensionsConfig extends PackagesResourceConfig mediaTypeMap = new HashMap(); mediaTypeMap.put(EXTENSION_JSON, MediaType.APPLICATION_JSON_TYPE); mediaTypeMap.put(EXTENSION_XML, MediaType.APPLICATION_XML_TYPE); + mediaTypeMap.put(EXTENSION_TXT, MediaType.TEXT_PLAIN_TYPE); } return mediaTypeMap;