org.pentaho.di.www.PauseTransServlet 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 javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.owasp.encoder.Encode;
import org.pentaho.di.core.Const;
import org.pentaho.di.core.util.Utils;
import org.pentaho.di.core.xml.XMLHandler;
import org.pentaho.di.i18n.BaseMessages;
import org.pentaho.di.trans.Trans;
public class PauseTransServlet extends BaseHttpServlet implements CartePluginInterface {
private static Class PKG = PauseTransServlet.class; // for i18n purposes, needed by Translator2!!
private static final long serialVersionUID = -2598233582435767691L;
public static final String CONTEXT_PATH = "/kettle/pauseTrans";
public PauseTransServlet() {
}
public PauseTransServlet( TransformationMap transformationMap ) {
super( transformationMap );
}
/**
/kettle/pauseTrans
GET
Pauses transformation to be executed.
Method is used for pausing running transformation by its name.
Example Request:
GET /kettle/pauseTrans/?name=dummy-trans&xml=Y
Parameters
name
description
type
name
Name of the transformation to be paused.
query
xml
Boolean flag which sets the output format required. Use Y to receive XML response.
boolean, optional
id
Carte transformation ID of the transformation to be paused. 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
Transformation [dummy-trans (master)] : pause requested.
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, "PauseTransServlet.PauseOfTransRequested" ) );
}
String transName = request.getParameter( "name" );
String id = request.getParameter( "id" );
boolean useXML = "Y".equalsIgnoreCase( request.getParameter( "xml" ) );
response.setStatus( HttpServletResponse.SC_OK );
response.setCharacterEncoding( "UTF-8" );
PrintWriter out = response.getWriter();
try {
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( "" + BaseMessages.getString( PKG, "PauseTransServlet.PauseTrans" ) + " " );
out.println( "" );
out.println( "" );
out.println( "" );
out.println( "" );
}
// ID is optional...
//
Trans trans;
CarteObjectEntry entry;
if ( Utils.isEmpty( id ) ) {
// get the first transformation that matches...
//
entry = getTransformationMap().getFirstCarteObjectEntry( transName );
if ( entry == null ) {
trans = null;
} else {
id = entry.getId();
trans = getTransformationMap().getTransformation( entry );
}
} else {
// Take the ID into account!
//
entry = new CarteObjectEntry( transName, id );
trans = getTransformationMap().getTransformation( entry );
}
if ( trans != null ) {
String message;
if ( trans.isPaused() ) {
trans.resumeRunning();
message = BaseMessages.getString( PKG, "PauseTransServlet.TransResumeRequested", transName );
} else {
trans.pauseRunning();
message = BaseMessages.getString( PKG, "PauseTransServlet.TransPauseRequested", transName );
}
if ( useXML ) {
out.println( new WebResult( WebResult.STRING_OK, message ).getXML() );
} else {
out.println( "" + Encode.forHtml( message ) + "
" );
out.println( ""
+ BaseMessages.getString( PKG, "TransStatusServlet.BackToTransStatusPage" ) + "" );
}
} else {
String message = BaseMessages.getString( PKG, "PauseTransServlet.CanNotFindTrans", transName );
if ( useXML ) {
out.println( new WebResult( WebResult.STRING_ERROR, message ).getXML() );
} 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, Const.getStackTracker( ex ) ).getXML() );
} else {
out.println( "
" );
out.println( "
" );
out.println( Const.getStackTracker( ex ) );
out.println( "" );
response.setStatus( HttpServletResponse.SC_BAD_REQUEST );
}
}
if ( !useXML ) {
out.println( "" );
out.println( "" );
out.println( "" );
}
}
public String toString() {
return "Pause transformation";
}
public String getService() {
return CONTEXT_PATH + " (" + toString() + ")";
}
public String getContextPath() {
return CONTEXT_PATH;
}
}