org.gradle.internal.agents.AgentStatus Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation

Gradle 6.9.1 API redistribution.

There is a newer version: 8.11.1

/*
 * Copyright 2022 the original author or authors.
 *
 * 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 org.gradle.internal.agents;

import org.gradle.internal.service.scopes.Scope;
import org.gradle.internal.service.scopes.ServiceScope;

/**
 * A build service to query the status of the Gradle's Java agents. Prefer using this service to accessing the {@link AgentControl} directly.
 */
@ServiceScope(Scope.Global.class)
public interface AgentStatus {
    /**
     * Checks if the agent-based bytecode instrumentation is enabled for the current JVM process.
     *
     * @return {@code true} if the agent instrumentation should be used
     */
    boolean isAgentInstrumentationEnabled();

    /**
     * Returns an AgentStatus instance that enables instrumentation if the agent is available.
     */
    static AgentStatus allowed() {
        return new DefaultAgentStatus();
    }

    /**
     * Returns an AgentStatus instance that disables instrumentation regardless of the agent's availability.
     */
    static AgentStatus disabled() {
        return new DisabledAgentStatus();
    }

    /**
     * Returns {@link #allowed()} or {@link #disabled()} AgentStatus according to the value of the flag.
     *
     * @param agentInstrumentationAllowed if {@code true} then the returned status allows instrumentation
     */
    static AgentStatus of(boolean agentInstrumentationAllowed) {
        return agentInstrumentationAllowed ? allowed() : disabled();
    }
}