org.openqa.selenium.server.CommandResultHolder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of selenium-server

Selenium automates browsers. That's it! What you do with that power is entirely up to you.

There is a newer version: 3.9.1

// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you 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.openqa.selenium.server;

import java.util.logging.Logger;

/**
 * 
 * Holds the command to be next run in the browser
 * 
 *
 * @author Jennifer Bevan
 * @version $Revision: 734 $
 */
public class CommandResultHolder {

  private static final Logger log = Logger.getLogger(CommandResultHolder.class.getName());
  private static final String poisonResult = "CommandResultHolder.POISON";
  protected static final String CMD_TIMED_OUT_MSG = "ERROR: Command timed out";
  protected static final String CMD_NULL_RESULT_MSG = "ERROR: Got a null result";

  private final String queueId;
  private final SingleEntryAsyncQueue holder;

  public CommandResultHolder(String queueId, long timeoutInSeconds) {
    holder = new SingleEntryAsyncQueue<>(timeoutInSeconds);
    holder.setPoison(poisonResult);
    this.queueId = queueId;
  }

  /**
   * Get a result out of the result holder (from the browser), waiting no longer than the timeout.
   *
   * @return the result from the result holder
   */
  public String getResult() {
    String result;
    log.fine(hdr() + "called");

    // wait until data arrives before the timeout
    result = holder.pollToGetContentUntilTimeout();

    if (null == result) {
      // if there is no result, then it timed out.
      result = CMD_TIMED_OUT_MSG;
    } else if (holder.isPoison(result)) {
      // if queue was poisoned, then just return indicator of a null result.
      result = CMD_NULL_RESULT_MSG;
    }

    StringBuilder msg = new StringBuilder(hdr() + "-> " + result);
    if (CMD_TIMED_OUT_MSG.equals(result)) {
      msg.append(" after ").append(holder.getTimeoutInSeconds()).append(" seconds.");
    }
    log.fine(msg.toString());

    return result;
  }

  public boolean putResult(String res) {
    return holder.putContent(res);
  }

  public boolean isEmpty() {
    return holder.isEmpty();
  }

  public String peek() {
    return holder.peek();
  }

  public void poisonPollers() {
    holder.poisonPollers();
  }

  private String hdr() {
    return "\t" + CommandQueue.getIdentification("commandResultHolder", queueId) + " getResult() ";
  }

}