diff options
Diffstat (limited to 'org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexFragmentService.java')
-rw-r--r-- | org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexFragmentService.java | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexFragmentService.java b/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexFragmentService.java new file mode 100644 index 000000000..1fae9c881 --- /dev/null +++ b/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexFragmentService.java @@ -0,0 +1,112 @@ +/******************************************************************************* + * Copyright (c) 2011 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + *******************************************************************************/ +package org.eclipse.help.internal.webapp.service; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStream; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.eclipse.help.internal.webapp.parser.IndexFragmentParser; +import org.eclipse.help.internal.webapp.servlet.IndexFragmentServlet; +import org.eclipse.help.internal.webapp.utils.Utils; + +/** + * Returns <code>xml</code> or <code>json</code> representing selected parts + * of the index. + * + * <p>This servlet is called on infocenters by client workbenches + * configured for remote help in order to gather selected parts of the index. + * + * <p>Extends the {@link org.eclipse.help.internal.webapp.servlet.IndexFragmentServlet} + * servlet. + * + * @param start - (optional) represents the part of the index to + * start reading from + * @param size - (optional) indicates the number of entries to read, + * no size parameter or a negative size parameter + * indicates that all entries which match the start + * letters should be displayed + * @param mode - (optional) specifies either <code>next</code> or + * <code>previous</code> + * @param entry - (optional) represents the starting point relative + * to the start + * @param showAll - (optional) specifies either <code>on</code> or + * <code>off</code> to set filter enablement of + * activity support + * @param showconfirm - (optional) specifies <code>true</code> or + * <code>false</code> to show/hide all confirm dialog + * @param lang - (optional) specifies the locale + * @param returnType - (Optional) specifies the return type of the servlet. + * Accepts either <code>xml</code> (default) or + * <code>json</code> + * + * @return Selected parts of the index, either as <code>xml</code> + * (default) or <code>json</code> + * + * @version $Version$ + * + **/ +public class IndexFragmentService extends IndexFragmentServlet { + + private static final long serialVersionUID = 1L; + + protected void doGet(HttpServletRequest req, HttpServletResponse resp) + throws ServletException, IOException { + + req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$ + // Set standard HTTP/1.1 no-cache headers. + resp.setHeader("Cache-Control", //$NON-NLS-1$ + "no-store, no-cache, must-revalidate"); //$NON-NLS-1$ + resp.setContentType("application/xml; charset=UTF-8"); //$NON-NLS-1$ + + String response = processRequest(req, resp); + + String returnType = req.getParameter(Utils.RETURN_TYPE); + boolean boolIsJSON = (returnType != null + && returnType.equalsIgnoreCase(Utils.JSON)); + + // If JSON output is required + if (boolIsJSON) { + resp.setContentType("text/plain"); //$NON-NLS-1$ + response = getJSONResponse(response); + } + + resp.getWriter().write(response); + } + + protected String getJSONResponse(String response) + throws IOException { + IndexFragmentParser indexParser = new IndexFragmentParser(); + InputStream is = null; + try { + if (response != null) { + is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$ + indexParser.parse(is); + } + + } catch (Exception e) { + e.printStackTrace(); + } + + if (is != null) + is.close(); + + // Call after the catch. + // An empty JSON is created if any Exception is thrown + // Else returns the complete JSON + return indexParser.toJSON(); + } + +} |