VersionRequestHandler.java

/**
 * 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.sqoop.handler;

import org.apache.log4j.Logger;
import org.apache.sqoop.audit.AuditLoggerManager;
import org.apache.sqoop.common.SqoopException;
import org.apache.sqoop.common.VersionInfo;
import org.apache.sqoop.json.JsonBean;
import org.apache.sqoop.json.VersionBean;
import org.apache.sqoop.server.RequestContext;
import org.apache.sqoop.server.RequestContext.Method;
import org.apache.sqoop.server.RequestHandler;
import org.apache.sqoop.server.common.ServerError;
/**
 * Version request handler is supporting following resources:
 *
 * GET /version
 * Get server version and supported protocol versions.
 */
public class VersionRequestHandler implements RequestHandler {

  private static final Logger LOG =
      Logger.getLogger(VersionRequestHandler.class);

  /** The latest API version supported by the server */
  public static final String CURRENT_REST_API_VERSION = "v1";

  private final VersionBean versionBean;

  public VersionRequestHandler() {
    // this will hold all the possible API versions supported by sqoop
    String[] apiVersions = { CURRENT_REST_API_VERSION };
    versionBean = new VersionBean(VersionInfo.getBuildVersion(),
        VersionInfo.getSourceRevision(), VersionInfo.getBuildDate(),
        VersionInfo.getUser(), VersionInfo.getSourceUrl(), apiVersions);
    LOG.info("VersionRequestHandler initialized");
  }

  @Override
  public JsonBean handleEvent(RequestContext ctx) {
    // version only support GET requests
    if (ctx.getMethod() != Method.GET) {
      throw new SqoopException(ServerError.SERVER_0002, "Unsupported HTTP method for version:"
          + ctx.getMethod());
    }
    AuditLoggerManager.getInstance()
        .logAuditEvent(ctx.getUserName(), ctx.getRequest().getRemoteAddr(),
        "show", "version", "");
    return versionBean;
  }
}