Skip to content

Commit

Permalink
Import formatted code
Browse files Browse the repository at this point in the history
  • Loading branch information
@zhicwu
zhicwu committed Jan 11, 2017
1 parent 62a835e commit d4ae669
Show file tree
Hide file tree
Showing 2 changed files with 576 additions and 0 deletions.
272 changes: 272 additions & 0 deletions pentaho-kettle/src/main/java/org/pentaho/di/www/StartExecutionTransServlet.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,272 @@
/*! ******************************************************************************
*
* Pentaho Data Integration
*
* Copyright (C) 2002-2013 by Pentaho : 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 org.owasp.esapi.ESAPI;
import org.owasp.esapi.Encoder;
import org.pentaho.di.core.Const;
import org.pentaho.di.core.exception.KettleException;
import org.pentaho.di.core.xml.XMLHandler;
import org.pentaho.di.i18n.BaseMessages;
import org.pentaho.di.trans.Trans;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URLEncoder;

public class StartExecutionTransServlet extends BaseHttpServlet implements CartePluginInterface {
private static Class<?> PKG = StartExecutionTransServlet.class; // for i18n purposes, needed by Translator2!!

private static final long serialVersionUID = 3634806745372015720L;
public static final String CONTEXT_PATH = "/kettle/startExec";

public StartExecutionTransServlet() {
}

public StartExecutionTransServlet(TransformationMap transformationMap) {
super(transformationMap);
}

/**
* <div id="mindtouch">
* <h1>/kettle/startExec</h1>
* <a name="GET"></a>
* <h2>GET</h2>
* <p>Starts transformation. If the transformation is not ready, an error is returned.</p>
* <p>
* <p><b>Example Request:</b><br />
* <pre function="syntax.xml">
* GET /kettle/startExec/?name=dummy-trans&xml=Y
* </pre>
* <p>
* </p>
* <h3>Parameters</h3>
* <table class="pentaho-table">
* <tbody>
* <tr>
* <th>name</th>
* <th>description</th>
* <th>type</th>
* </tr>
* <tr>
* <td>name</td>
* <td>Name of the transformation to be executed.</td>
* <td>query</td>
* </tr>
* <tr>
* <td>xml</td>
* <td>Boolean flag which sets the output format required. Use <code>Y</code> to receive XML response.</td>
* <td>boolean, optional</td>
* </tr>
* <tr>
* <td>id</td>
* <td>Carte transformation ID of the transformation to be executed. This parameter is optional when xml=Y is used.</td>
* <td>query, optional</td>
* </tr>
* </tbody>
* </table>
* <p>
* <h3>Response Body</h3>
* <p>
* <table class="pentaho-table">
* <tbody>
* <tr>
* <td align="right">text:</td>
* <td>HTML</td>
* </tr>
* <tr>
* <td align="right">media types:</td>
* <td>text/xml, text/html</td>
* </tr>
* </tbody>
* </table>
* <p>Response XML or HTML containing operation result. When using xml=Y <code>result</code> field indicates whether
* operation was successful (<code>OK</code>) or not (<code>ERROR</code>).</p>
* <p>
* <p><b>Example Response:</b></p>
* <pre function="syntax.xml">
* <?xml version="1.0" encoding="UTF-8"?>
* <webresult>
* <result>OK</result>
* <message/>
* <id/>
* </webresult>
* </pre>
* <p>
* <h3>Status Codes</h3>
* <table class="pentaho-table">
* <tbody>
* <tr>
* <th>code</th>
* <th>description</th>
* </tr>
* <tr>
* <td>200</td>
* <td>Request was processed.</td>
* </tr>
* <tr>
* <td>500</td>
* <td>Internal server error occurs during request processing.</td>
* </tr>
* </tbody>
* </table>
* </div>
*/
public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException,
IOException {
if (isJettyMode() && !request.getContextPath().startsWith(CONTEXT_PATH)) {
return;
}

if (log.isDebug()) {
logDebug("Start execution of transformation requested");
}
response.setStatus(HttpServletResponse.SC_OK);

String transName = request.getParameter("name");
String id = request.getParameter("id");
boolean useXML = "Y".equalsIgnoreCase(request.getParameter("xml"));

Encoder encoder = ESAPI.encoder();

PrintWriter out = response.getWriter();
if (useXML) {
response.setContentType("text/xml");
out.print(XMLHandler.getXMLHeader(Const.XML_ENCODING));
} else {
response.setContentType("text/html;charset=UTF-8");
out.println("<HTML>");
out.println("<HEAD>");
out.println("<TITLE>"
+ BaseMessages.getString(PKG, "PrepareExecutionTransServlet.TransPrepareExecution") + "</TITLE>");
out.println("<META http-equiv=\"Refresh\" content=\"2;url="
+ convertContextPath(GetStatusServlet.CONTEXT_PATH) + "?name="
+ URLEncoder.encode(transName, "UTF-8") + "\">");
out.println("<META http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">");
out.println("</HEAD>");
out.println("<BODY>");
}

try {
// ID is optional...
//
Trans trans;
CarteObjectEntry entry;
if (Const.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) {
if (trans.isReadyToStart()) {
startThreads(trans);

if (useXML) {
out.println(WebResult.OK.getXML());
} else {
out
.println("<H1>Transformation '"
+ encoder.encodeForHTML(transName) + "' has been executed.</H1>");
out.println("<a href=\""
+ convertContextPath(GetTransStatusServlet.CONTEXT_PATH) + "?name="
+ URLEncoder.encode(transName, "UTF-8") + "&id=" + URLEncoder.encode(id, "UTF-8")
+ "\">Back to the transformation status page</a><p>");
}
} else {
String message =
"The specified transformation ["
+ transName + "] is not ready to be started. (Was not prepared for execution)";
if (useXML) {
out.println(new WebResult(WebResult.STRING_ERROR, message));
} else {
out.println("<H1>" + encoder.encodeForHTML(message) + "</H1>");
out.println("<a href=\""
+ convertContextPath(GetStatusServlet.CONTEXT_PATH) + "\">"
+ BaseMessages.getString(PKG, "TransStatusServlet.BackToStatusPage") + "</a><p>");
}
}
} else {
if (useXML) {
out.println(new WebResult(WebResult.STRING_ERROR, BaseMessages.getString(
PKG, "TransStatusServlet.Log.CoundNotFindSpecTrans", transName)));
} else {
out.println("<H1>"
+ encoder.encodeForHTML(BaseMessages.getString(
PKG, "TransStatusServlet.Log.CoundNotFindTrans", transName)) + "</H1>");
out.println("<a href=\""
+ convertContextPath(GetStatusServlet.CONTEXT_PATH) + "\">"
+ BaseMessages.getString(PKG, "TransStatusServlet.BackToStatusPage") + "</a><p>");
}
}
} catch (Exception ex) {
if (useXML) {
out.println(new WebResult(
WebResult.STRING_ERROR, "Unexpected error during transformation execution preparation:"
+ Const.CR + Const.getStackTracker(ex)));
} else {
out.println("<p>");
out.println("<pre>");
out.println(encoder.encodeForHTML(Const.getStackTracker(ex)));
out.println("</pre>");
}
}

if (!useXML) {
out.println("<p>");
out.println("</BODY>");
out.println("</HTML>");
}
}

public String toString() {
return "Start transformation";
}

public String getService() {
return CONTEXT_PATH + " (" + toString() + ")";
}

protected void startThreads(Trans trans) throws KettleException {
trans.startThreads();
}

public String getContextPath() {
return CONTEXT_PATH;
}

}
Loading

0 comments on commit d4ae669

Please sign in to comment.