org.pentaho.di.www.StartJobServlet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kettle-engine Show documentation
Show all versions of kettle-engine Show documentation
Container pom for Pentaho Data Integration modules
The newest version!
/*! ******************************************************************************
*
* Pentaho Data Integration
*
* Copyright (C) 2002-2018 by Hitachi Vantara : http://www.pentaho.com
*
*******************************************************************************
*
* 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 org.pentaho.di.www;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URLEncoder;
import java.util.UUID;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import com.google.common.annotations.VisibleForTesting;
import org.owasp.encoder.Encode;
import org.pentaho.di.core.Const;
import org.pentaho.di.core.util.Utils;
import org.pentaho.di.core.exception.KettleException;
import org.pentaho.di.core.logging.KettleLogStore;
import org.pentaho.di.core.logging.LoggingObjectType;
import org.pentaho.di.core.logging.SimpleLoggingObject;
import org.pentaho.di.core.xml.XMLHandler;
import org.pentaho.di.i18n.BaseMessages;
import org.pentaho.di.job.Job;
import org.pentaho.di.job.JobConfiguration;
import org.pentaho.di.www.cache.CarteStatusCache;
public class StartJobServlet extends BaseHttpServlet implements CartePluginInterface {
private static Class PKG = StartJobServlet.class; // for i18n purposes,
// needed by
// Translator2!!
private static final long serialVersionUID = -8487225953910464032L;
public static final String CONTEXT_PATH = "/kettle/startJob";
@VisibleForTesting
CarteStatusCache cache = CarteStatusCache.getInstance();
public StartJobServlet() {
}
public StartJobServlet( JobMap jobMap ) {
super( jobMap );
}
/**
/kettle/startJob
GET
Starts the job. If the job cannot be started, an error is returned.
Example Request:
GET /kettle/startJob/?name=dummy_job&xml=Y
Parameters
name
description
type
name
Name of the job to be executed.
query
xml
Boolean flag which sets the output format required. Use Y to receive XML response.
boolean, optional
id
Carte job ID of the job to be executed. This parameter is optional when xml=Y is used.
query, optional
Response Body
text:
HTML
media types:
text/xml, text/html
Response XML or HTML containing operation result. When using xml=Y result field indicates whether
operation was successful (OK) or not (ERROR).
Example Response:
OK
Job [dummy_job] was started.
abd61143-8174-4f27-9037-6b22fbd3e229
Status Codes
code
description
200
Request was processed.
500
Internal server error occurs during request processing.
*/
public void doGet( HttpServletRequest request, HttpServletResponse response ) throws ServletException,
IOException {
if ( isJettyMode() && !request.getContextPath().startsWith( CONTEXT_PATH ) ) {
return;
}
if ( log.isDebug() ) {
logDebug( BaseMessages.getString( PKG, "StartJobServlet.Log.StartJobRequested" ) );
}
String jobName = request.getParameter( "name" );
String id = request.getParameter( "id" );
boolean useXML = "Y".equalsIgnoreCase( request.getParameter( "xml" ) );
response.setStatus( HttpServletResponse.SC_OK );
PrintWriter out = response.getWriter();
if ( useXML ) {
response.setContentType( "text/xml" );
response.setCharacterEncoding( Const.XML_ENCODING );
out.print( XMLHandler.getXMLHeader( Const.XML_ENCODING ) );
} else {
response.setContentType( "text/html;charset=UTF-8" );
out.println( "" );
out.println( "" );
out.println( "Start job " );
out.println( "" );
out.println( "" );
out.println( "" );
out.println( "" );
}
try {
// ID is optional...
//
Job job;
CarteObjectEntry entry;
if ( Utils.isEmpty( id ) ) {
// get the first job that matches...
//
entry = getJobMap().getFirstCarteObjectEntry( jobName );
if ( entry == null ) {
job = null;
} else {
id = entry.getId();
job = getJobMap().getJob( entry );
}
} else {
// Take the ID into account!
//
entry = new CarteObjectEntry( jobName, id );
job = getJobMap().getJob( entry );
}
if ( job != null ) {
// First see if this job already ran to completion.
// If so, we get an exception is we try to start() the job thread
//
if ( job.isInitialized() && !job.isActive() ) {
// Re-create the job from the jobMeta
//
// We might need to re-connect to the repository
//
if ( job.getRep() != null && !job.getRep().isConnected() ) {
if ( job.getRep().getUserInfo() != null ) {
job.getRep().connect(
job.getRep().getUserInfo().getLogin(), job.getRep().getUserInfo().getPassword() );
} else {
job.getRep().connect( null, null );
}
}
cache.remove( job.getLogChannelId() );
// Create a new job object to start from a sane state. Then replace
// the new job in the job map
//
synchronized ( this ) {
JobConfiguration jobConfiguration = getJobMap().getConfiguration( jobName );
String carteObjectId = UUID.randomUUID().toString();
SimpleLoggingObject servletLoggingObject =
new SimpleLoggingObject( CONTEXT_PATH, LoggingObjectType.CARTE, null );
servletLoggingObject.setContainerObjectId( carteObjectId );
Job newJob = new Job( job.getRep(), job.getJobMeta(), servletLoggingObject );
newJob.setLogLevel( job.getLogLevel() );
// Discard old log lines from the old job
//
KettleLogStore.discardLines( job.getLogChannelId(), true );
getJobMap().replaceJob( entry, newJob, jobConfiguration );
job = newJob;
}
}
runJob( job );
String message = BaseMessages.getString( PKG, "StartJobServlet.Log.JobStarted", jobName );
if ( useXML ) {
out.println( new WebResult( WebResult.STRING_OK, message, id ).getXML() );
} else {
out.println( "" + Encode.forHtml( message ) + "
" );
out.println( ""
+ BaseMessages.getString( PKG, "JobStatusServlet.BackToJobStatusPage" ) + "" );
}
} else {
String message = BaseMessages.getString( PKG, "StartJobServlet.Log.SpecifiedJobNotFound", jobName );
if ( useXML ) {
out.println( new WebResult( WebResult.STRING_ERROR, message ) );
} else {
out.println( "
" + Encode.forHtml( message ) + "
" );
out.println( ""
+ BaseMessages.getString( PKG, "TransStatusServlet.BackToStatusPage" ) + "" );
response.setStatus( HttpServletResponse.SC_BAD_REQUEST );
}
}
} catch ( Exception ex ) {
if ( useXML ) {
out.println( new WebResult( WebResult.STRING_ERROR, BaseMessages.getString(
PKG, "StartJobServlet.Error.UnexpectedError", Const.CR + Const.getStackTracker( ex ) ) ) );
} else {
out.println( "
" );
out.println( "
" );
out.println( Encode.forHtml( Const.getStackTracker( ex ) ) );
out.println( "" );
response.setStatus( HttpServletResponse.SC_BAD_REQUEST );
}
}
if ( !useXML ) {
out.println( "" );
out.println( "" );
out.println( "" );
}
}
public String toString() {
return "Start job";
}
public String getService() {
return CONTEXT_PATH + " (" + toString() + ")";
}
protected void runJob( Job job ) throws KettleException {
job.start(); // runs the thread in the background...
}
public String getContextPath() {
return CONTEXT_PATH;
}
}