org.eclipse.help.internal.webapp.service;x-friends:="org.eclipse.ua.tests",

 org.eclipse.help.internal.webapp.utils;x-friends:="org.eclipse.ua.tests",

   <extension-point id="validatedServlet" name="Validated Servlet" schema="schema/validatedServlet.exsd"/>

      <servlet

            alias="/vs"

            class="org.eclipse.help.internal.webapp.servlet.ValidatorServlet"

            httpcontextId="help">

      </servlet>

   <extension

         point="org.eclipse.help.webapp.validatedServlet">

      <servlet

            alias="/service/control"

            class="org.eclipse.help.internal.webapp.service.ControlService">

      </servlet>

      <servlet

            alias="/service/content"

            class="org.eclipse.help.internal.webapp.service.ContentService">

      </servlet>

      <servlet

            alias="/service/topic"

            class="org.eclipse.help.internal.webapp.service.ContentService">

      </servlet>

      <servlet

            alias="/service/nftopic"

            class="org.eclipse.help.internal.webapp.service.ContentService">

      </servlet>

      <servlet

            alias="/service/ntopic"

            class="org.eclipse.help.internal.webapp.service.ContentService">

      </servlet>

      <servlet

            alias="/service/rtopic"

            class="org.eclipse.help.internal.webapp.service.ContentService">

      </servlet>

      <servlet

            alias="/service/nav"

            class="org.eclipse.help.internal.webapp.service.NavService">

      </servlet>

      <servlet

            alias="/service/livehelp"

            class="org.eclipse.help.internal.webapp.service.LiveHelpService">

      </servlet>

      <servlet

            alias="/service/toc"

            class="org.eclipse.help.internal.webapp.service.TocService">

      </servlet>

      <servlet

            alias="/service/tocfragment"

            class="org.eclipse.help.internal.webapp.service.TocFragmentService">

      </servlet>

      <servlet

            alias="/service/index"

            class="org.eclipse.help.internal.webapp.service.IndexService">

      </servlet>

      <servlet

            alias="/service/indexfragment"

            class="org.eclipse.help.internal.webapp.service.IndexFragmentService">

      </servlet>

      <servlet

            alias="/service/advancedsearch"

            class="org.eclipse.help.internal.webapp.service.AdvancedSearchService">

      </servlet>

      <servlet

            alias="/service/search"

            class="org.eclipse.help.internal.webapp.service.SearchService">

      </servlet>

      <servlet

            alias="/service/context"

            class="org.eclipse.help.internal.webapp.service.ContextService">

      </servlet>

      <servlet

            alias="/service/extension"

            class="org.eclipse.help.internal.webapp.service.ExtensionService">

      </servlet>

      <servlet

            alias="/service/about.html"

            class="org.eclipse.help.internal.webapp.service.AboutService">

      </servlet>

      <servlet

            alias="/service/state"

            class="org.eclipse.help.internal.webapp.service.SearchStateService">

      </servlet>

   </extension>

<?xml version='1.0' encoding='UTF-8'?>

<!-- Schema file written by PDE -->

<schema targetNamespace="org.eclipse.help.webapp" xmlns="http://www.w3.org/2001/XMLSchema">

<annotation>

      <appInfo>

         <meta.schema plugin="org.eclipse.help.webapp" id="validatedServlet" name="Validated Servlet"/>

      </appInfo>

      <documentation>

         This extension points implements a webapp security validator around a servlet.  All calls to the servlet are checked for known malicious threats before returning to the client.  Important: All context paths to servlet validator resources must start with /vs.  For example: http://host:port/help/vs/service/toc

      </documentation>

   </annotation>

   <element name="extension">

      <annotation>

         <appInfo>

            <meta.element />

         </appInfo>

      </annotation>

      <complexType>

         <sequence minOccurs="0" maxOccurs="unbounded">

            <element ref="servlet"/>

         </sequence>

         <attribute name="point" type="string" use="required">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

         <attribute name="id" type="string">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

         <attribute name="name" type="string">

            <annotation>

               <documentation>

               </documentation>

               <appInfo>

                  <meta.attribute translatable="true"/>

               </appInfo>

            </annotation>

         </attribute>

      </complexType>

   </element>

   <element name="servlet">

      <complexType>

         <attribute name="class" type="string" use="required">

            <annotation>

               <documentation>

               </documentation>

               <appInfo>

                  <meta.attribute kind="java" basedOn="javax.servlet.http.HttpServlet:"/>

               </appInfo>

            </annotation>

         </attribute>

         <attribute name="alias" type="string" use="required">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

      </complexType>

   </element>

   <annotation>

      <appInfo>

         <meta.section type="since"/>

      </appInfo>

      <documentation>

         3.7

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="examples"/>

      </appInfo>

      <documentation>

         Here is an example where a servlet 'ControlService' will be called and validated with the URL:

(path)/vs/service/control

<extension

      point="org.eclipse.help.webapp.validatedServlet">

   <servlet

         alias="/service/control"

         class="org.eclipse.help.internal.webapp.service.ControlService">

   </servlet>

</extension>

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="apiinfo"/>

      </appInfo>

      <documentation>

         The supplied servlet class must extend the class <samp>javax.servlet.http.HttpServlet</samp>.  The servlet class should function no differently then general servlets.

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="implementation"/>

      </appInfo>

      <documentation>

         A supplied implementation of this point can be found in <samp>org.eclipse.help.webapp</samp> for any of the services in org.eclipse.help.internal.webapp.services.

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="copyright"/>

      </appInfo>

      <documentation>

         Copyright (c) 2011 IBM Corporation and others.<br>

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 <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>

      </documentation>

   </annotation>

</schema>

# Validator Servlet

cantCreateServlet=Unable to create servlet: {0}

# Service API

StatusServlet_PARAM_MISSING=The "{0}" parameter is missing from the request.

	public void readSearchResults() {

		// try loading search results or get the indexing progress info.

		if (isSearchRequest() && !isScopeRequest()) {

			altList.clear();

	public SearchHit[] getResults() {

		return hits;

	}

/*******************************************************************************

 * 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.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;

import org.eclipse.help.internal.webapp.utils.XMLHelper;

import org.xml.sax.Attributes;

public class ContextParser extends ResultParser {

	private ParseElement element = null;

	private String currentTag;

	public ContextParser() {

		super(JSonHelper.TITLE);

	}

	public void startElement(String uri, String lname, String name, Attributes attrs) {

		currentTag = name;

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_DESCRIPTION))

			return;

		Properties properties = new Properties();

		properties.put(JSonHelper.PROPERTY_NAME, name);

		for (int i = 0; i < attrs.getLength(); i++) {

			String qname = attrs.getQName(i);

			String val = attrs.getValue(i);

			properties.put(qname, val);

		}

		ParseElement elem = new ParseElement(properties, element);

		if (element != null)

			element.addChild(elem);

		else

			items.add(elem);

		element = elem;

	}

	public void characters(char[] ch, int start, int length) {

		if (element != null 

				&& currentTag.equalsIgnoreCase(

						XMLHelper.ELEMENT_DESCRIPTION)) {

			Properties properties = element.getProps();

			if (properties != null) {

				String content = new String(ch, start, length);

				String existing = (String) properties.get(currentTag);

				if (existing == null)

					existing = ""; //$NON-NLS-1$

				content = content.replaceAll("[\\n\\t]", "").trim(); //$NON-NLS-1$ //$NON-NLS-2$

				properties.put(currentTag, existing + content);

				element.updateParseElement(properties);

			}

		}

	}

	public void endElement(String uri, String lname, String name) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_DESCRIPTION))

			return;

		if (element != null) {

			element = element.getParent();

		}		

	}

}

/*******************************************************************************

 * 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.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;

import org.xml.sax.Attributes;

public class ExtensionParser extends ResultParser {

	private ParseElement element = null;

	private String currentTag;

	public ExtensionParser() {

		super(JSonHelper.TITLE);

	}

	public void startElement(String uri, String lname, String name, Attributes attrs) {

		currentTag = name;

		Properties properties = new Properties();

		properties.put(JSonHelper.PROPERTY_NAME, name);

		for (int i = 0; i < attrs.getLength(); i++) {

			String qname = attrs.getQName(i);

			String val = attrs.getValue(i);

			properties.put(qname, val);

		}

		ParseElement elem = new ParseElement(properties, element);

		if (element != null)

			element.addChild(elem);

		else

			items.add(elem);

		element = elem;

	}

	public void characters(char[] ch, int start, int length) {

		if (element != null) {

			Properties properties = element.getProps();

			if (properties != null) {

				String content = new String(ch, start, length);

				String existing = (String) properties.get(currentTag);

				if (existing == null)

					existing = ""; //$NON-NLS-1$

				content = content.replaceAll("[\\n\\t]", "").trim(); //$NON-NLS-1$ //$NON-NLS-2$

				properties.put(currentTag, existing + content);

				element.updateParseElement(properties);

			}

		}

	}

	public void endElement(String uri, String lname, String name) {

		if (element != null) {

			element = element.getParent();

		}		

	}

}

/*******************************************************************************

 * 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.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;

import org.eclipse.help.internal.webapp.utils.XMLHelper;

import org.xml.sax.Attributes;

public class IndexFragmentParser extends ResultParser{

	private ParseElement element = null;

	public IndexFragmentParser() {

		super(JSonHelper.TITLE);

	}

	public void startElement(String uri, String lname, String name, Attributes attrs) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_NODE))

		{

			Properties properties = new Properties();

			properties.put(JSonHelper.PROPERTY_NAME, JSonHelper.INDEX);

			for (int i = 0; i < attrs.getLength(); i++) {

				String qname = attrs.getQName(i);

				String val = attrs.getValue(i);

				properties.put(qname, val);

			}

			ParseElement elem = new ParseElement(properties, element);

			if (element != null)

				element.addChild(elem);

			else

				items.add(elem);

			element = elem;

		}

	}

	public void endElement(String uri, String lname, String name) {

		if (element != null 

				&& name.equalsIgnoreCase(XMLHelper.ELEMENT_NODE)) {

			element = element.getParent();

		}		

	}

}

/*******************************************************************************

 * 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.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;

import org.eclipse.help.internal.webapp.utils.XMLHelper;

import org.xml.sax.Attributes;

public class IndexParser extends ResultParser {

	private ParseElement element = null;

	public IndexParser() {

		super(JSonHelper.TITLE);

	}

	public void startElement(String uri, String lname, String name, Attributes attrs) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_INDEX_CONTRIBUTIONS) 

				|| name.equalsIgnoreCase(XMLHelper.ELEMENT_INDEX))

			return;

		Properties properties = new Properties();

		properties.put(JSonHelper.PROPERTY_NAME, name);

		for (int i = 0; i < attrs.getLength(); i++) {

			String qname = attrs.getQName(i);

			String val = attrs.getValue(i);

			properties.put(qname, val);

		}

		ParseElement elem = new ParseElement(properties, element);

		if (element != null)

			element.addChild(elem);

		else

			items.add(elem);

		element = elem;

	}

	public void endElement(String uri, String lname, String name) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_INDEX_CONTRIBUTIONS) 

				|| name.equalsIgnoreCase(XMLHelper.ELEMENT_INDEX))

			return;

		if (element != null) {

			element = element.getParent();

		}		

	}

}

/*******************************************************************************

 * 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.parser;

import java.util.ArrayList;

import java.util.Enumeration;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;

public class ParseElement {

	private Properties props;

	private ArrayList children = new ArrayList();

	private ParseElement parent;

	public ParseElement(Properties props, ParseElement parent) {

		this.props = props;

		this.parent = parent;

	}

	public ParseElement(Properties props) {

		this(props, null);

	}

	public void updateParseElement(Properties props) {

		this.props = props;

	}

	public Properties getProps() {

		return props;

	}

	public ParseElement getParent() {

		return parent;

	}

	public String getProperty(String key) {

		return (props != null) ? props.getProperty(key) : ""; //$NON-NLS-1$

	}

	public String toString() {

		return (props != null) ? props.toString() : ""; //$NON-NLS-1$

	}

	public void addChild(ParseElement elem) {

		children.add(elem);

	}

	public int getChildrenCount() {

		return children.size();

	}

	public String toJSON(int level) {

		StringBuffer buff = new StringBuffer();

		String space = JSonHelper.SPACE;

		for (int s = 0; s < level; s++) {

			space += JSonHelper.SPACE;

		}

		buff.append(JSonHelper.NEWLINE + space);

		buff.append(JSonHelper.BEGIN_BRACE);

		if (props != null) {

			Enumeration enumObj = props.keys();

			while (enumObj.hasMoreElements()) {

				String key = (String) enumObj.nextElement();

				String val = props.getProperty(key);

				buff.append(JSonHelper.NEWLINE + space + JSonHelper.SPACE);

				buff.append(key);

				buff.append(JSonHelper.COLON);

				buff.append(JSonHelper.getQuotes(val));

				buff.append(JSonHelper.COMMA);

			}

		}

		if (children.size() <= 0) {

			int len = buff.length();

			char ch = buff.charAt(len - 1);

			if (ch == ',') {

				buff.deleteCharAt(len - 1);

				buff.append(JSonHelper.NEWLINE + space);

			}

		} else {

			buff.append(JSonHelper.NEWLINE + space + JSonHelper.SPACE);

			buff.append(JSonHelper.CHILDREN);

			buff.append(JSonHelper.COLON);

			buff.append(JSonHelper.BEGIN_BRACKET);

			for (int i = 0; i < children.size(); i++) {

				if (i > 0)

					buff.append(JSonHelper.COMMA);

				ParseElement element = (ParseElement) children.get(i);

				buff.append(element.toJSON(level + 2));

			}

			buff.append(JSonHelper.NEWLINE + space + JSonHelper.SPACE);

			buff.append(JSonHelper.END_BRACKET);

			buff.append(JSonHelper.NEWLINE + space);

		}

		buff.append(JSonHelper.END_BRACE);

		return buff.toString();

	}

}

/*******************************************************************************

 * 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.parser;

import java.io.IOException;

import java.io.InputStream;

import java.net.URL;

import java.util.ArrayList;

import javax.xml.parsers.ParserConfigurationException;

import javax.xml.parsers.SAXParser;

import javax.xml.parsers.SAXParserFactory;

import org.eclipse.help.internal.webapp.utils.JSonHelper;

import org.xml.sax.SAXException;

import org.xml.sax.helpers.DefaultHandler;

public class ResultParser extends DefaultHandler {

	private String label = ""; //$NON-NLS-1$

	protected ArrayList items = new ArrayList(); //parser populates the items arrayList withe parsed data.

	public ResultParser(String label) {

		this.label = label;

	}

	public void parse(URL tocURL) 

		throws ParserConfigurationException, SAXException, IOException

	{

		parse(tocURL.openStream());

	}

	public void parse(InputStream in) 

		throws ParserConfigurationException, SAXException, IOException

	{

		SAXParser parser = SAXParserFactory.newInstance().newSAXParser();

		parser.parse(in, this);

	}

	public ArrayList getItems()

	{

		return items;

	}

	public String toString()

	{

		return items.toString();

	}

	public String toJSON() {

		StringBuffer buf = new StringBuffer();

		buf.append(JSonHelper.BEGIN_BRACE);

		buf.append(JSonHelper.NEWLINE + JSonHelper.SPACE);

		buf.append(JSonHelper.IDENTIFIER);

		buf.append(JSonHelper.COLON);

		buf.append(JSonHelper.getQuotes(JSonHelper.ID));

		buf.append(JSonHelper.COMMA);

		buf.append(JSonHelper.NEWLINE + JSonHelper.SPACE);

		buf.append(JSonHelper.LABEL);

		buf.append(JSonHelper.COLON);

		buf.append(JSonHelper.getQuotes(label));

		buf.append(JSonHelper.COMMA);

		buf.append(JSonHelper.NEWLINE + JSonHelper.SPACE);

		buf.append(JSonHelper.ITEMS);

		buf.append(JSonHelper.COLON);

		buf.append(JSonHelper.BEGIN_BRACKET);

		for (int i = 0; i < items.size(); i++) {

			if (i > 0)

				buf.append(JSonHelper.COMMA);

			ParseElement element = (ParseElement) items.get(i);

			buf.append(element.toJSON(1));

		}

		if (items.size() > 0)

			buf.append(JSonHelper.NEWLINE + JSonHelper.SPACE);

		buf.append(JSonHelper.END_BRACKET);

		buf.append(JSonHelper.NEWLINE);

		buf.append(JSonHelper.END_BRACE);

		return buf.toString();

	}

}

/*******************************************************************************

 * 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.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;

import org.eclipse.help.internal.webapp.utils.XMLHelper;

import org.xml.sax.Attributes;

public class SearchParser extends ResultParser {

//	private ParseElement element;

	private Properties properties;

	private String currentTag;

	public SearchParser() {

		super(JSonHelper.LABEL);

	}

	public void startElement(String uri, 

			String lname, String name, Attributes attrs) {

		currentTag = name;

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_HIT)) {

			properties = new Properties();

			properties.put(JSonHelper.PROPERTY_NAME, name);

			for (int i = 0; i < attrs.getLength(); i++) {

				String qname = attrs.getQName(i);

				String val = attrs.getValue(i);

				properties.put(qname, val);

			}

			String id = "" + items.size(); //$NON-NLS-1$

			properties.put(JSonHelper.ID, id);

		} else if (name.equalsIgnoreCase(XMLHelper.ELEMENT_CATEGORY)) {

			for (int i = 0; i < attrs.getLength(); i++) {

				String qname = attrs.getQName(i);

				String val = attrs.getValue(i);

				if (qname.equalsIgnoreCase(XMLHelper.ATTR_HREF))

					qname = XMLHelper.CATEGORY_HREF;

				properties.put(qname, val);

			}

		}

	}

	public void characters(char[] ch, int start, int length) {

		if (currentTag.equalsIgnoreCase(XMLHelper.ELEMENT_HIT) 

				|| currentTag.equalsIgnoreCase(XMLHelper.ELEMENT_HITS))

			return;

		if (properties != null)

		{

			String content = new String(ch, start, length);

			String existing = (String) properties.get(currentTag);

			if (existing == null)

				existing = ""; //$NON-NLS-1$

			content = content.replaceAll("[\\n\\t]", "").trim(); //$NON-NLS-1$ //$NON-NLS-2$

			properties.put(currentTag, existing + content);

		}

	}

	public void endElement(String uri, String lname, String name) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_HIT)) {

			ParseElement element = new ParseElement(properties);

			items.add(element);

		}

	}

}

/*******************************************************************************

 * 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.parser;

import java.io.IOException;

import java.io.InputStream;

import java.net.URL;

import java.util.Properties;

import javax.xml.parsers.ParserConfigurationException;

import org.eclipse.help.internal.webapp.utils.JSonHelper;

import org.eclipse.help.internal.webapp.utils.XMLHelper;

import org.xml.sax.Attributes;

import org.xml.sax.SAXException;

public class TocFragmentParser extends ResultParser {

	private Properties properties;

	private String parentId = ""; //$NON-NLS-1$

	private int tagLevel = -1;

	private int level = 0;

	public TocFragmentParser() {

		super(JSonHelper.TITLE);

	}

	public void parse(URL tocURL, int level) 

		throws ParserConfigurationException, SAXException, IOException

	{

		parse(tocURL.openStream(), level);

	}

	public void parse(InputStream in, int level) 

		throws ParserConfigurationException, SAXException, IOException

	{

		this.level = level;

		super.parse(in);

	}

	public void startElement(String uri, 

			String lname, String name, Attributes attrs) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_NODE))

		{

			tagLevel++;

			if (tagLevel == level) {

				properties = new Properties();

				properties.put(JSonHelper.PROPERTY_NAME, JSonHelper.TOPIC);

				for (int i = 0; i < attrs.getLength(); i++) {

					String qname = attrs.getQName(i);

					String val = attrs.getValue(i);

					if (qname.equals(XMLHelper.ATTR_ID)) {

						if (parentId.length() > 0)

							val = parentId + '$' + val;

					}

					properties.put(qname, val);

				}

			} else if (parentId.length() <= 0) {

				for (int i = 0; i < attrs.getLength(); i++) {

					if (attrs.getQName(i).equals(XMLHelper.ATTR_ID))

						parentId = attrs.getValue(i);

				}

			}

		}

	}

	public void endElement(String uri, String lname, String name) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_NODE))

		{

			if (tagLevel == level && properties != null ) {

				properties.setProperty("type", "toc"); //$NON-NLS-1$ //$NON-NLS-2$

				ParseElement element = new ParseElement(properties);

				items.add(element);

				properties = null;

			}

			tagLevel--;

		}

	}

}

/*******************************************************************************

 * 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.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;

import org.eclipse.help.internal.webapp.utils.XMLHelper;

import org.xml.sax.Attributes;

public class TocParser extends ResultParser {

	private ParseElement element = null;

	public TocParser() {

		super(JSonHelper.LABEL);

	}

	public void startElement(String uri, String lname, String name, Attributes attrs) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_TOC_CONTRIBUTIONS))

			return;

		Properties properties = new Properties();

		properties.put(JSonHelper.PROPERTY_NAME, name);

		for (int i = 0; i < attrs.getLength(); i++) {

			String qname = attrs.getQName(i);

			String val = attrs.getValue(i);

			properties.put(qname, val);

		}

		ParseElement elem = new ParseElement(properties, element);

		if (element != null)

			element.addChild(elem);

		else

			items.add(elem);

		element = elem;

	}

	public void endElement(String uri, String lname, String name) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_TOC_CONTRIBUTIONS))

			return;

		if (element != null) {

			element = element.getParent();

		}		

	}

}

/*******************************************************************************

 * 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 org.eclipse.help.internal.webapp.servlet.AboutServlet;

/**

 * Generates an html page having informations about either <code>User-Agent</code>,

 * Help system <code>preferences</code> or the available plug-ins in Help system

 * like Provider, Plugin name, Version and PluginId.

 * 

 * <p>Extends the {@link org.eclipse.help.internal.webapp.servlet.AboutServlet}

 * servlet.

 * 

 * @param show			- (Optional) specifying either <code>agent</code>

 * 						to view the request's <code>User-Agent</code> info, else

 * 						<code>preferences</code> to view the Help system preferences.

 * 						Do not specify any value to show the available plugins in

 * 						Help web application.

 * @param sortColumn	- (Optional) specifying the column number over

 * 						which displayed output needs to be sorted. Applicable only if

 * 						<code>show</code> parameter is <code>null</code>. 

 * 

 * @return		Html page having informations about either <code>User-Agent</code>,

 * <code>preferences</code> or the available plug-ins.

 * 

 * @version	$Version$

 * 

 **/

public class AboutService extends AboutServlet {

	private static final long serialVersionUID = 1L;

}

/*******************************************************************************

 * 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.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.search.SearchHit;

import org.eclipse.help.internal.search.SearchProgressMonitor;

import org.eclipse.help.internal.webapp.data.SearchData;

import org.eclipse.help.internal.webapp.data.UrlUtil;

import org.eclipse.help.internal.webapp.parser.SearchParser;

import org.eclipse.help.internal.webapp.utils.Utils;

import org.eclipse.help.internal.webapp.utils.SearchXMLGenerator;

/**

 * Returns the search hits in <code>xml</code> or <code>json</code>

 * form for the query provided in the <code>searchWord</code> parameter.

 * 

 * <p>This servlet is called on infocenters by client workbenches

 * configured for remote help in order to retrieve search hits

 * from the remote help server.

 * 

 * <p>Internally reads {@link org.eclipse.help.internal.webapp.data.SearchData}.

 * 

 * @param searchWord	- specifies the search keyword

 * @param quickSearch	- (optional) specifies if it is a quick search. Scopes

 * 						  is just the selected toc or topic

 * @param quickSearchType	- (optional) specifies <code>QuickSearchTopic</code> for topic

 * 							  quick search

 * @param scope			- (optional) specifies search scope values

 * @param workingSet	- (optional) specifies the working set for scoped search

 * @param maxHits		- (optional) specifies the number of hits to return, default value is 500

 * @param fieldSearch	- (optional) specifies if field only search should be performed;

 * 						  if set to false, default field "contents" and all other fields will be searched

 * @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		The search hits, either as <code>xml</code> (default) or

 * 				<code>json</code>

 * 

 * @version	$Version$

 * 

 **/

public class AdvancedSearchService extends HttpServlet {

	private static final long serialVersionUID = 1L;

	public static final String XID = "xid"; //$NON-NLS-1$

	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$

		ServletContext context = req.getSession().getServletContext();

		SearchData searchData = new SearchData(context, req, resp);

		String noCat = req.getParameter(Utils.NO_CATEGORY);

		boolean boolIsCategory = (noCat == null 

				|| !noCat.equalsIgnoreCase("true")); //$NON-NLS-1$

		String locale = UrlUtil.getLocale(req, resp);

		SearchProgressMonitor pm = SearchProgressMonitor

				.getProgressMonitor(locale);

		while (!pm.isDone()) {

			try {

				Thread.sleep(500); // Sleep for 0.5 sec

			} catch(InterruptedException ex) {}

		}

		// Load search results

		searchData.readSearchResults();

		SearchHit[] hits = searchData.getResults();

		String response = SearchXMLGenerator.serialize(hits, boolIsCategory);

		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 {

		SearchParser searchParser = new SearchParser();

		InputStream is = null;

		try {

			if (response != null) {

				is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$

				searchParser.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 searchParser.toJSON();

	}

}

/*******************************************************************************

 * 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.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.io.OutputStreamWriter;

import java.io.PrintWriter;

import java.net.URL;

import java.net.URLConnection;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.webapp.utils.Utils;

/**

 * Returns an HTML page for the selected topic passed as request path info.

 * 

 * <p>Passes the request to {@link org.eclipse.help.internal.webapp.servlet.ContentServlet}

 * servlet.

 * 

 * @param lang	- (optional) specifies the locale

 * 

 * @return		An html page for the selected topic

 * 

 * @version	$Version$

 * 

 **/

public class ContentService extends HttpServlet {

	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)

			throws ServletException, IOException {

		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$

		String baseURL = req.getRequestURL().toString();

		String contentURL = baseURL.replaceFirst(Utils.SERVICE_CONTEXT, ""); //$NON-NLS-1$

		String query = req.getQueryString();

		if (query != null)

			contentURL += '?' + query;

		URL url = new URL(contentURL);

		URLConnection con = url.openConnection();

		con.setAllowUserInteraction(false);

		con.setDoInput(true);

		con.connect();

		String contentType;

		ServletContext context = getServletContext();

		String pathInfo = req.getPathInfo();

		String mimeType = context.getMimeType(pathInfo);

		if (mimeType != null && !mimeType.equals("application/xhtml+xml")) { //$NON-NLS-1$

			contentType = mimeType;

		} else {

			contentType = con.getContentType();

		}

		resp.setContentType(contentType);

		InputStream is = con.getInputStream();

		OutputStream out = resp.getOutputStream();

		if (!contentType.equals("application/xhtml+xml")  //$NON-NLS-1$

				&& !contentType.equals("text/html")  //$NON-NLS-1$

				&& !con.getContentType().equals("text/html")) { //$NON-NLS-1$

			Utils.transferContent(is, out);

			out.flush();

		} else {

			String response = Utils.convertStreamToString(url.openStream());

			response = Utils.updateResponse(response);

			PrintWriter writer = new PrintWriter(new OutputStreamWriter(out, "UTF-8")); //$NON-NLS-1$

			writer.write(response);

			writer.close();

		}

	}

}

/*******************************************************************************

 * 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.ContextParser;

import org.eclipse.help.internal.webapp.servlet.ContextServlet;

import org.eclipse.help.internal.webapp.utils.Utils;

/**

 * Returns a context help entry with the id specified in the

 * <code>id</code> parameter in <code>xml</code> or <code>json</code> form.

 * 

 * <p>This servlet is called on infocenters by client workbenches

 * configured for remote help in order to retrieve context help

 * stored on the remote help server.

 * 

 * <p>Extends the {@link org.eclipse.help.internal.webapp.servlet.ContextServlet}

 * servlet.

 * 

 * @param id			- A <code>String</code> specifying the context id

 * 						for the context help entry

 * @param lang			- (optional) A <code>String</code> specifying the locale

 * @param returnType	- (Optional) A <code>String</code> specifying the

 * 						return type of the servlet. Accepts either

 * 						<code>xml</code> (default) or <code>json</code>

 * 

 * @return		A context help entry with the id specified, either as

 * 				<code>xml</code> (default) or <code>json</code>

 * 

 * @exception	400 Error - If context <code>id</code> parameter is missing

 * @exception	404 Error - If wrong context <code>id</code> parameter

 * 

 * @version	$Version$

 * 

 **/

public class ContextService extends ContextServlet {

	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$

		String response = processRequest(req, resp);

		if ("400".equals(response)) { //$NON-NLS-1$

			resp.sendError(400); // bad request; missing parameter

			return;

		} else if ("404".equals(response)) { //$NON-NLS-1$

			resp.sendError(404); // Wrong context id; not found

			return;

		}

		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 {

		ContextParser searchParser = new ContextParser();

		InputStream is = null;

		try {

			if (response != null) {

				is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$

				searchParser.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 searchParser.toJSON();

	}

}

/*******************************************************************************

 * 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 org.eclipse.help.internal.webapp.servlet.ControlServlet;

/**

 * Controls Eclipse help application from standalone application. This

 * service do not allow remote clients to control Eclipse help application.

 * 

 * <p>Extends the {@link org.eclipse.help.internal.webapp.servlet.ControlServlet}

 * servlet.

 * 

 * @param command		- specifies the control command. Accepts the following parameters: 

 * 						displayHelp | displayHelpWindow | shutdown

 * 						| install | update | enable | disable | uninstall

 * 						| search | listFeatures | addSite | removeSite

 * 						| apply

 * 

 * @version	$Version$

 * 

 **/

public class ControlService extends ControlServlet {

	private static final long serialVersionUID = 1L;

}

/*******************************************************************************

 * 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.ExtensionParser;

import org.eclipse.help.internal.webapp.servlet.ExtensionServlet;

import org.eclipse.help.internal.webapp.utils.Utils;

/**

 * Returns all topic extensions available on this host in <code>xml</code>

 * or <code>json</code> form.

 * 

 * <p>This servlet is called on infocenters by client workbenches

 * configured for remote help in order to gather all the pieces of

 * a document.

 * 

 * <p>Extends the {@link org.eclipse.help.internal.webapp.servlet.ExtensionServlet}

 * servlet.

 * 

 * @param lang			- (optional) specifying the locale

 * @param returnType	- (Optional) specifying the return type of the servlet.

 * 						Accepts either <code>xml</code> (default) or

 * 						<code>json</code>

 * 

 * @return		All topic extensions available on this host, either as

 * 				<code>xml</code> (default) or <code>json</code>

 * 

 * @version	$Version$

 * 

 **/

public class ExtensionService extends ExtensionServlet {

	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 {

		ExtensionParser searchParser = new ExtensionParser();

		InputStream is = null;

		try {

			if (response != null) {

				is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$

				searchParser.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 searchParser.toJSON();

	}

}

/*******************************************************************************

 * 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();

	}

}

/*******************************************************************************

 * 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.IndexParser;

import org.eclipse.help.internal.webapp.servlet.IndexServlet;

import org.eclipse.help.internal.webapp.utils.Utils;

/**

 * Returns all available keyword index data in <code>xml</code>

 * or <code>json</code> form. The data is sent as one large index

 * contribution that includes all merged contributions from the system.

 * 

 * <p>This servlet is called on infocenters by client workbenches

 * configured for remote help in order to gather all the index keywords

 * and assemble them into a complete index.

 * 

 * <p>Extends the {@link org.eclipse.help.internal.webapp.servlet.IndexServlet}

 * servlet.

 * 

 * @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		All available keyword index data, either as <code>xml</code>

 * 				(default) or <code>json</code>

 * 

 * @version	$Version$

 * 

 **/

public class IndexService extends IndexServlet {

	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 {

		IndexParser indexParser = new IndexParser();

		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();

	}

}

/*******************************************************************************

 * 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 org.eclipse.help.internal.webapp.servlet.LiveHelpServlet;

/**

 * Handles the live help action requests with the specified 

 * <code>pluginID</code>, <code>class</code> and respective <code>args</code>.

 * 

 * <p>Extends the {@link org.eclipse.help.internal.webapp.servlet.LiveHelpServlet}

 * servlet.

 * 

 * @param pluginID		- specifying the plugin id

 * @param class			- specifying the class

 * @param arg			- (Optional) specifying the arguments for the

 * 						  live help extension

 * 

 * @version	$Version$

 * 

 **/

public class LiveHelpService extends LiveHelpServlet {

	private static final long serialVersionUID = 1L;

}

/*******************************************************************************

 * 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

 *