com.cognifide.aet.job.common.modifiers.executejavascript.ExecuteJavaScriptModifier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jobs Show documentation
Module containing all AET core jobs implementations: collectors, comparators, data filters and modifiers
The newest version!
/**
 * AET
 *
 * Copyright (C) 2013 Cognifide Limited
 *
 * 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 com.cognifide.aet.job.common.modifiers.executejavascript;

import com.cognifide.aet.communication.api.metadata.CollectorStepResult;
import com.cognifide.aet.job.api.ParametersValidator;
import com.cognifide.aet.job.api.collector.CollectorJob;
import com.cognifide.aet.job.api.exceptions.ParametersException;
import com.cognifide.aet.job.api.exceptions.ProcessingException;
import com.cognifide.aet.job.common.utils.javascript.JavaScriptJobExecutor;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ExecuteJavaScriptModifier implements CollectorJob {

  public static final String NAME = "executejavascript";
  private static final Logger LOG = LoggerFactory.getLogger(ExecuteJavaScriptModifier.class);

  private static final String CMD_PARAM = "cmd";
  private static final String URL_PARAM = "snippetUrl";
  private static final String BASIC_AUTH_USERNAME = "basicAuthUsername";
  private static final String BASIC_AUTH_PASSWORD = "basicAuthPassword";

  private final ExternalSnippetHttpClient httpClient;
  private final JavaScriptJobExecutor jsExecutor;

  private String cmd;
  private String snippetUrl;
  private String basicAuth;

  ExecuteJavaScriptModifier(ExternalSnippetHttpClient httpClient,
      JavaScriptJobExecutor jsExecutor) {
    this.httpClient = httpClient;
    this.jsExecutor = jsExecutor;
  }

  @Override
  public CollectorStepResult collect() throws ProcessingException {
    CollectorStepResult result;
    String jsSnippet = getJsSnippet();
    try {
      LOG.debug("Executing JavaScript Modifier");
      jsExecutor.execute(jsSnippet);
      result = CollectorStepResult.newModifierResult();
    } catch (ProcessingException ex) {
      result = CollectorStepResult.newProcessingErrorResult(ex.getMessage());
    }
    return result;
  }

  private String getJsSnippet() throws ProcessingException {
    final String jsSnippet;
    if (StringUtils.isNotBlank(cmd)) {
      jsSnippet = cmd;
    } else {
      jsSnippet = httpClient.get(snippetUrl, basicAuth);
    }
    return jsSnippet;
  }

  @Override
  public void setParameters(Map params) throws ParametersException {
    cmd = params.get(CMD_PARAM);
    snippetUrl = params.get(URL_PARAM);
    ParametersValidator.checkAtLeastOneNotBlank(
        "Either 'cmd' or 'snippetUrl' parameter must be provided for executejavascript modifier.",
        cmd, snippetUrl);

    if (params.containsKey(BASIC_AUTH_USERNAME) && params.containsKey(BASIC_AUTH_PASSWORD)) {
      String username = params.get(BASIC_AUTH_USERNAME);
      String password = params.get(BASIC_AUTH_PASSWORD);
      String encoded = encodeBasicAuth(username, password);
      LOG.info("Setting basic auth '{}:{}' encoded to: '{}'", username, password, encoded);
      basicAuth = encoded;
    } else {
      // we dont't have both attributes here
      boolean containOnlyOne
          = params.containsKey(BASIC_AUTH_USERNAME) || params.containsKey(BASIC_AUTH_PASSWORD);
      if (containOnlyOne) {
        throw new ParametersException(
            "You have to specify both " + BASIC_AUTH_USERNAME + " and " + BASIC_AUTH_PASSWORD);
      }
    }
  }

  String encodeBasicAuth(String username, String password) {
    String usernameOrEmpty = StringUtils.defaultString(username);
    String passwordOrEmpty = StringUtils.defaultString(password);

    String authString = usernameOrEmpty + ":" + passwordOrEmpty;
    LOG.debug("authentication: '{}'", authString);
    byte[] encoded = Base64.encodeBase64(authString.getBytes(StandardCharsets.UTF_8));
    LOG.debug("encoded bytes: '{}'", encoded);
    return new String(encoded);
  }

}