org.openqa.selenium.grid.component.HealthCheck Maven / Gradle / Ivy

Go to download
// 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.grid.component;

import java.util.Objects;

@FunctionalInterface
public interface HealthCheck {

  Result check();

  class Result {
    private final boolean isAlive;
    private final String message;
    private final String registrationSecret;

    public Result(boolean isAlive, String message) {
      this.isAlive = isAlive;
      this.message = Objects.requireNonNull(message, "Message must be set");
      this.registrationSecret = null;
    }

    public Result(boolean isAlive, String message, String registrationSecret) {
      this.isAlive = isAlive;
      this.message = Objects.requireNonNull(message, "Message must be set");
      this.registrationSecret = registrationSecret;
    }

    public boolean isAlive() {
      return isAlive;
    }

    public String getMessage() {
      return message;
    }
  }
}