DatabaseDialectService.java

/**
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright (c) 2002-2013 Pentaho Corporation..  All rights reserved.
 */

package org.pentaho.platform.dataaccess.datasource.wizard.service.impl;

import static javax.ws.rs.core.MediaType.APPLICATION_JSON;

import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Response;

import org.codehaus.enunciate.Facet;
import org.pentaho.database.IDatabaseDialect;
import org.pentaho.database.model.IDatabaseConnection;
import org.pentaho.database.model.IDatabaseType;
import org.pentaho.ui.database.event.DefaultDatabaseDialectList;
import org.pentaho.ui.database.event.DefaultDatabaseTypesList;
import org.pentaho.ui.database.event.IDatabaseDialectList;
import org.pentaho.ui.database.event.IDatabaseTypesList;

@Path( "/data-access/api/dialect" )
public class DatabaseDialectService extends org.pentaho.database.service.DatabaseDialectService {

  public DatabaseDialectService() {
    this( true );
  }

  public DatabaseDialectService( boolean validateClasses ) {
    super( validateClasses );
  }

  /**
   * Register a dialect, if the register fails it will return a server error.
   *
   * @param databaseDialect IDatabaseDialect object to register
   *
   * @return Response determines if the dialect was registered or not.
   */
  @POST
  @Path( "/registerDatabaseDialect" )
  @Consumes( { APPLICATION_JSON } )
  @Facet ( name = "Unsupported" )
  public Response registerDatabaseDialectWS( IDatabaseDialect databaseDialect ) {
    return this.registerDatabaseDialectWS( databaseDialect, true );
  }

  /**
   * Register a dialect, if the register fails it will return a server error.
   *
   * @param databaseDialect IDatabaseDialect object to register
   * @param validateClassExists
   *
   * @return Response determines if the dialect was registered or not.
   */
  @POST
  @Path( "/registerDatabaseDialectWithValidation/{validateClassExists}" )
  @Consumes( { APPLICATION_JSON } )
  @Facet ( name = "Unsupported" )
  public Response registerDatabaseDialectWS( IDatabaseDialect databaseDialect,
      @PathParam( "validateClassExists" ) Boolean validateClassExists ) {
    try {
      super.registerDatabaseDialect( databaseDialect );
    } catch ( Throwable e ) {
      Response.serverError().entity( e ).build();
    }
    return Response.ok().build();
  }

  /**
   * Attempt to load the JDBC Driver class. If it's not available, return false.
   * 
   * @param classname
   *          validate that this classname exists in the classpath
   * 
   * @return true if the class exists
   */
  @POST
  @Path( "/validateJdbcDriverClassExists" )
  @Consumes( { APPLICATION_JSON } )
  @Produces( { APPLICATION_JSON } )
  @Facet ( name = "Unsupported" )
  public Boolean validateJdbcDriverClassExistsWS( String classname ) {
    return super.validateJdbcDriverClassExists( classname );
  }

  /**
   * Get a list of the database types
   *
   * @return IDatabaseTypesList containing the database types
   */
  @GET
  @Path( "/getDatabaseTypes" )
  @Facet ( name = "Unsupported" )
  @Produces( { APPLICATION_JSON } )
  public IDatabaseTypesList getDatabaseTypesWS() {
    DefaultDatabaseTypesList value = new DefaultDatabaseTypesList();
    value.setDbTypes( super.getDatabaseTypes() );
    return value;
  }

  /**
   * Get the dialect of the given IDatabaseType
   *
   * @param databaseType IDatabaseType object to get the dialect of
   * @return IDatabaseDialect containing the dialect of databaseType
   */
  @POST
  @Path( "/getDialectByType" )
  @Consumes( { APPLICATION_JSON } )
  @Produces( { APPLICATION_JSON } )
  @Facet ( name = "Unsupported" )
  public IDatabaseDialect getDialectWS( IDatabaseType databaseType ) {
    return super.getDialect( databaseType );
  }

  /**
   * Get the dialect of a given IDatabaseConnection
   *
   * @param connection IDatabaseConnection object to get the dialect of
   *
   * @return IDatabaseDialect of the given connection
   */
  @POST
  @Path( "/getDialectByConnection" )
  @Consumes( { APPLICATION_JSON } )
  @Produces( { APPLICATION_JSON } )
  @Facet ( name = "Unsupported" )
  public IDatabaseDialect getDialect( IDatabaseConnection connection ) {
    return super.getDialect( connection );
  }

  /**
   * Get a list of the database dialects
   *
   * @return IDatabaseDialectList containing the database dialects
   */
  @GET
  @Path( "/getDatabaseDialects" )
  @Produces( { APPLICATION_JSON } )
  @Facet ( name = "Unsupported" )
  public IDatabaseDialectList getDatabaseDialectsWS() {
    IDatabaseDialectList value = new DefaultDatabaseDialectList();
    value.setDialects( super.getDatabaseDialects() );
    return value;
  }
}