GetConnectorStatus.java

// Copyright 2006 Google Inc.
//
// Licensed 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 com.google.enterprise.connector.servlet;

import com.google.common.collect.ImmutableMap;
import com.google.enterprise.connector.manager.ConnectorStatus;
import com.google.enterprise.connector.manager.Manager;
import com.google.enterprise.connector.persist.ConnectorNotFoundException;
import com.google.enterprise.connector.scheduler.Schedule;

import java.io.PrintWriter;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Admin servlet to get the connector status for a given connector.
 *
 */
public class GetConnectorStatus extends ConnectorManagerGetServlet {
  private static final Logger LOGGER =
      Logger.getLogger(GetConnectorStatus.class.getName());

  /*
   * (non-Javadoc)
   *
   * @see com.google.enterprise.connector.servlet.ConnectorManagerGetServlet#
   *      processDoGet(java.lang.String, java.lang.String,
   *      com.google.enterprise.connector.manager.Manager,
   *      java.io.PrintWriter)
   */
  @Override
  protected void processDoGet(String connectorName, String lang,
      Manager manager, PrintWriter out) {
    handleDoGet(connectorName, manager, out);
  }

  /**
   * Handler for doGet in order to do unit tests. Returns the connector
   * status.
   *
   * @param connectorName
   * @param manager
   * @param out PrintWriter where the response is written
   */
  public static void handleDoGet(String connectorName, Manager manager,
      PrintWriter out) {
    ConnectorMessageCode status = new ConnectorMessageCode();
    ConnectorStatus connectorStatus;
    try {
      connectorStatus = manager.getConnectorStatus(connectorName);
      if (connectorStatus == null) {
        status = new ConnectorMessageCode(
            ConnectorMessageCode.RESPONSE_NULL_CONNECTOR_STATUS, connectorName);
        LOGGER.warning("Connector manager returns no status for "
                       + connectorName);
      }
    } catch (ConnectorNotFoundException e) {
      connectorStatus = null;
      status = new ConnectorMessageCode(
        ConnectorMessageCode.EXCEPTION_CONNECTOR_NOT_FOUND, connectorName);
      LOGGER.log(Level.WARNING, ServletUtil.LOG_EXCEPTION_CONNECTOR_NOT_FOUND,
                 e);
    }

    ServletUtil.writeRootTag(out, false);
    ServletUtil.writeMessageCode(out, status);
    if (connectorStatus != null) {
      ServletUtil.writeXMLTag(out, 1, ServletUtil.XMLTAG_CONNECTOR_STATUS,
          false);
      ServletUtil.writeXMLElement(out, 2, ServletUtil.XMLTAG_CONNECTOR_NAME,
          connectorStatus.getName());
      ServletUtil.writeXMLElement(out, 2, ServletUtil.XMLTAG_CONNECTOR_TYPE,
          connectorStatus.getType());
      ServletUtil.writeXMLElement(out, 2, ServletUtil.XMLTAG_STATUS,
          Integer.toString(connectorStatus.getStatus()));

      String schedule = connectorStatus.getSchedule();
      if (schedule == null) {
        ServletUtil.writeEmptyXMLElement(out, 2,
            ServletUtil.XMLTAG_CONNECTOR_SCHEDULES);
      } else {
        StringBuilder buffer = new StringBuilder();
        ServletUtil.writeXMLTagWithAttrs(buffer, 2,
            ServletUtil.XMLTAG_CONNECTOR_SCHEDULES,
            ImmutableMap.of(
                ServletUtil.ATTRIBUTE_VERSION, Schedule.CURRENT_VERSION),
            false);
        buffer.append(schedule);
        ServletUtil.writeXMLTag(buffer, 0,
            ServletUtil.XMLTAG_CONNECTOR_SCHEDULES, true);
        out.println(buffer.toString());
      }
      ServletUtil.writeXMLTag(out, 1, ServletUtil.XMLTAG_CONNECTOR_STATUS,
          true);
    }
    ServletUtil.writeRootTag(out, true);
  }
}