org.apache.shardingsphere.agent.api.advice.ClassStaticMethodAroundAdvice Maven / Gradle / Ivy

Go to download

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

There is a newer version: 5.5.1

Show newest version

/*
 * 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 ASF 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.shardingsphere.agent.api.advice;

import org.apache.shardingsphere.agent.api.result.MethodInvocationResult;

import java.lang.reflect.Method;

/**
 * Weaving the advice around the static methods of target class.
 */
public interface ClassStaticMethodAroundAdvice {
    
    /**
     * Check if disable the check process when interceptor are trying to call the advice. Then the advice will be called by skipping checks.
     *
     * @return disable or not
     */
    default boolean disableCheck() {
        return false;
    }
    
    /**
     * Intercept the target method and weave the method before origin method. It will invoke before the origin calling.
     *
     * @param clazz the target class
     * @param method the target method
     * @param args all method arguments
     * @param result wrapped class of result to detect whether or not to execute the origin method
     */
    default void beforeMethod(final Class clazz, final Method method, final Object[] args, final MethodInvocationResult result) {
    }
    
    /**
     * Intercept the target method and weave the method after origin method. It will invoke after the origin calling.
     *
     * @param clazz the target class
     * @param method the target method
     * @param args all method arguments
     * @param result wrapped class of result to detect whether or not to execute the origin method
     */
    default void afterMethod(final Class clazz, final Method method, final Object[] args, final MethodInvocationResult result) {
    }
    
    /**
     * Weaving the method after origin method throwing.
     *
     * @param clazz the target class
     * @param method the target method
     * @param args all method arguments
     * @param throwable exception from target method
     */
    default void onThrowing(final Class clazz, final Method method, final Object[] args, final Throwable throwable) {
    }
}