org.apache.sling.hc.api.execution.HealthCheckExecutor Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The SF 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.apache.sling.hc.api.execution;
import java.util.List;
import org.apache.sling.hc.api.HealthCheck;
import org.osgi.annotation.versioning.ProviderType;
/**
* Executes health checks registered as OSGi services and
* implementing the interface {@link HealthCheck}.
*
*/
@ProviderType
public interface HealthCheckExecutor {
/**
* Executes all health checks matching the supplied filter options.
* If no options are supplied, all health checks are executed.
*
* @param selector filter selector
* @return List of results. The list might be empty.
*/
List execute(HealthCheckSelector selector);
/**
* Executes all health checks with the supplied filter options.
* If no options are supplied, all health checks are executed.
*
* @param selector filter selector
* @param options options for controlling execution behavior
*
* @return List of results. The list might be empty.
*/
List execute(HealthCheckSelector selector, HealthCheckExecutionOptions options);
/**
* Executes all health checks with the supplied list of tags.
* If no tags are supplied, all health checks are executed.
*
* @return List of results. The list might be empty.
* @deprecated use execute(HealthCheckFilter.Options)
*/
@Deprecated
List execute(String... tags);
/**
* Executes all health checks with the supplied list of tags.
* If no tags are supplied, all health checks are executed.
*
* @param options options for controlling execution behavior
* @param tags tags to be executed
*
* @return List of results. The list might be empty.
* @deprecated use execute(HealthCheckFilter.Options, HealthCheckExecutionOptions)
*/
@Deprecated
List execute(HealthCheckExecutionOptions options, String... tags);
}