com.cognifide.aet.job.common.modifiers.click.ClickModifier 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.click;

import com.cognifide.aet.communication.api.metadata.CollectorStepResult;
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.SeleniumWaitHelper;
import com.cognifide.aet.job.common.modifiers.WebElementsLocatorParams;
import java.util.Map;
import org.openqa.selenium.TimeoutException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.WebElement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ClickModifier extends WebElementsLocatorParams implements CollectorJob {

  private static final Logger LOG = LoggerFactory.getLogger(ClickModifier.class);

  public static final String NAME = "click";

  private final WebDriver webDriver;

  ClickModifier(final WebDriver webDriver) {
    this.webDriver = webDriver;
  }

  @Override
  public CollectorStepResult collect() throws ProcessingException {
    CollectorStepResult result;
    try {
      SeleniumWaitHelper
          .waitForElementToBeClickable(webDriver, getLocator(), getTimeoutInSeconds());
      WebElement elementToClick = webDriver.findElement(getLocator());

      elementToClick.click();
      result = CollectorStepResult.newModifierResult();
    } catch (TimeoutException e) {
      final String message =
          String.format("Element not found before timeout (%s seconds): '%s'",
              getTimeoutInSeconds(), getLocator().toString());
      result = CollectorStepResult.newProcessingErrorResult(message);
      LOG.info(message);
    } catch (WebDriverException e) {
      final String message =
          String.format("Error while clicking element %s. Error: %s",
              getLocator().toString(), e.getMessage());
      result = CollectorStepResult.newProcessingErrorResult(message);
      LOG.warn(message, e);
    }
    return result;
  }

  @Override
  public void setParameters(final Map params) throws ParametersException {
    setElementParams(params);
  }

}