org.pentaho.di.www.RunJobServlet 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-2017 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.util.Enumeration;
import java.util.UUID;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.pentaho.di.core.Const;
import org.pentaho.di.core.exception.KettleException;
import org.pentaho.di.core.logging.KettleLogStore;
import org.pentaho.di.core.logging.LogLevel;
import org.pentaho.di.core.logging.LoggingObjectType;
import org.pentaho.di.core.logging.SimpleLoggingObject;
import org.pentaho.di.i18n.BaseMessages;
import org.pentaho.di.job.Job;
import org.pentaho.di.job.JobAdapter;
import org.pentaho.di.job.JobConfiguration;
import org.pentaho.di.job.JobExecutionConfiguration;
import org.pentaho.di.job.JobMeta;
import org.pentaho.di.repository.ObjectId;
import org.pentaho.di.repository.Repository;
import org.pentaho.di.repository.RepositoryDirectory;
import org.pentaho.di.repository.RepositoryDirectoryInterface;
public class RunJobServlet extends BaseHttpServlet implements CartePluginInterface {
private static final long serialVersionUID = 1192413943669836775L;
private static Class PKG = RunJobServlet.class; // i18n
public static final String CONTEXT_PATH = "/kettle/runJob";
public RunJobServlet() {
}
public RunJobServlet( JobMap jobMap ) {
super( jobMap );
}
/**
/kettle/runJob
GET
Execute job from enterprise repository. Repository should be configured in Carte xml file.
Response contains ERROR result if error happened during job execution.
Example Request:
GET /kettle/runJob?job=home%2Fadmin%2Fdummy_job&level=Debug
Parameters
name
description
type
job
Full path to the job in repository.
query
level
Logging level to be used for job execution (i.e. Debug).
query
Response Body
element:
(custom)
media types:
text/xml
Response contains result of the operation. It is either OK or ERROR.
If an error occurred during job execution, response also contains information about the error.
Example Response:
OK
Job started
05d919b0-74a3-48d6-84d8-afce359d0449
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, "RunJobServlet.Log.RunJobRequested" ) );
}
// Options taken from PAN
//
String[] knownOptions = new String[] { "job", "level", };
String transOption = request.getParameter( "job" );
String levelOption = request.getParameter( "level" );
response.setStatus( HttpServletResponse.SC_OK );
PrintWriter out = response.getWriter();
try {
SlaveServerConfig serverConfig = transformationMap.getSlaveServerConfig();
Repository slaveServerRepository = serverConfig.getRepository();
if ( slaveServerRepository == null ) {
throw new KettleException( "Unable to connect to repository in Slave Server Config: " + serverConfig.getRepositoryId() );
}
final JobMeta jobMeta = loadJob( slaveServerRepository, transOption );
// Set the servlet parameters as variables in the transformation
//
String[] parameters = jobMeta.listParameters();
Enumeration parameterNames = request.getParameterNames();
while ( parameterNames.hasMoreElements() ) {
String parameter = (String) parameterNames.nextElement();
String[] values = request.getParameterValues( parameter );
// Ignore the known options. set the rest as variables
//
if ( Const.indexOfString( parameter, knownOptions ) < 0 ) {
// If it's a trans parameter, set it, otherwise simply set the
// variable
//
if ( Const.indexOfString( parameter, parameters ) < 0 ) {
jobMeta.setVariable( parameter, values[0] );
} else {
jobMeta.setParameterValue( parameter, values[0] );
}
}
}
JobExecutionConfiguration jobExecutionConfiguration = new JobExecutionConfiguration();
LogLevel logLevel = LogLevel.getLogLevelForCode( levelOption );
jobExecutionConfiguration.setLogLevel( logLevel );
// Create new repository connection for this job
//
final Repository repository = jobExecutionConfiguration.connectRepository(
serverConfig.getRepositoryId(), serverConfig.getRepositoryUsername(), serverConfig.getRepositoryPassword() );
JobConfiguration jobConfiguration = new JobConfiguration( jobMeta, jobExecutionConfiguration );
String carteObjectId = UUID.randomUUID().toString();
SimpleLoggingObject servletLoggingObject =
new SimpleLoggingObject( CONTEXT_PATH, LoggingObjectType.CARTE, null );
servletLoggingObject.setContainerObjectId( carteObjectId );
servletLoggingObject.setLogLevel( logLevel );
// Create the transformation and store in the list...
//
final Job job = new Job( repository, jobMeta, servletLoggingObject );
// Setting variables
//
job.initializeVariablesFrom( null );
job.getJobMeta().setInternalKettleVariables( job );
job.injectVariables( jobConfiguration.getJobExecutionConfiguration().getVariables() );
// Also copy the parameters over...
//
job.copyParametersFrom( jobMeta );
job.clearParameters();
/*
* String[] parameterNames = job.listParameters(); for (int idx = 0; idx < parameterNames.length; idx++) { // Grab
* the parameter value set in the job entry // String thisValue =
* jobExecutionConfiguration.getParams().get(parameterNames[idx]); if (!Utils.isEmpty(thisValue)) { // Set the
* value as specified by the user in the job entry // jobMeta.setParameterValue(parameterNames[idx], thisValue); }
* }
*/
jobMeta.activateParameters();
job.setSocketRepository( getSocketRepository() );
JobMap jobMap = getJobMap();
jobMap.addJob( job.getJobname(), carteObjectId, job, jobConfiguration );
// Disconnect from the job's repository when the job finishes.
//
job.addJobListener( new JobAdapter() {
public void jobFinished( Job job ) {
repository.disconnect();
}
} );
String message = "Job '" + job.getJobname() + "' was added to the list with id " + carteObjectId;
logBasic( message );
try {
runJob( job );
WebResult webResult = new WebResult( WebResult.STRING_OK, "Job started", carteObjectId );
out.println( webResult.getXML() );
out.flush();
} catch ( Exception executionException ) {
String logging = KettleLogStore.getAppender().getBuffer( job.getLogChannelId(), false ).toString();
throw new KettleException( "Error executing Job: " + logging, executionException );
}
} catch ( Exception ex ) {
out.println( new WebResult( WebResult.STRING_ERROR, BaseMessages.getString(
PKG, "RunJobServlet.Error.UnexpectedError", Const.CR + Const.getStackTracker( ex ) ) ) );
}
}
protected void runJob( Job job ) {
// Execute the transformation...
//
job.start();
}
private JobMeta loadJob( Repository repository, String job ) throws KettleException {
if ( repository == null ) {
throw new KettleException( "Repository required." );
} else {
synchronized ( repository ) {
// With a repository we need to load it from /foo/bar/Transformation
// We need to extract the folder name from the path in front of the
// name...
//
String directoryPath;
String name;
int lastSlash = job.lastIndexOf( RepositoryDirectory.DIRECTORY_SEPARATOR );
if ( lastSlash < 0 ) {
directoryPath = "/";
name = job;
} else {
directoryPath = job.substring( 0, lastSlash );
name = job.substring( lastSlash + 1 );
}
RepositoryDirectoryInterface directory =
repository.loadRepositoryDirectoryTree().findDirectory( directoryPath );
ObjectId jobID = repository.getJobId( name, directory );
JobMeta transJob = repository.loadJob( jobID, null );
return transJob;
}
}
}
public String toString() {
return "Run Job";
}
public String getService() {
return CONTEXT_PATH + " (" + toString() + ")";
}
@Override
public String getContextPath() {
return CONTEXT_PATH;
}
}