net.bytebuddy.agent.builder.ResettableClassFileTransformer Maven / Gradle / Ivy
Show all versions of byte-buddy-dep Show documentation
/*
* Copyright 2014 - 2019 Rafael Winterhalter
*
* 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 net.bytebuddy.agent.builder;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.Instrumentation;
/**
* A class file transformer that can reset its transformation.
*/
public interface ResettableClassFileTransformer extends ClassFileTransformer {
/**
*
* Deregisters this class file transformer and redefines any transformed class to its state without this
* class file transformer applied, if the supplied redefinition strategy is enabled. If it is not enabled,
* only the {@link net.bytebuddy.agent.builder.AgentBuilder.InstallationListener} is informed about the
* resetting without undoing any code changes.
*
*
* Note: A reset class file transformer should not be reinstalled. Instead, the {@link AgentBuilder}
* which built the transformer should be asked to install a new transformer.
*
*
* Important: Most JVMs do not support changes of a class's structure after a class was already
* loaded. Therefore, it is typically required that this class file transformer was built while enabling
* {@link AgentBuilder#disableClassFormatChanges()}.
*
*
* @param instrumentation The instrumentation instance from which to deregister the transformer.
* @param redefinitionStrategy The redefinition to apply.
* @return {@code true} if a reset was applied and this transformer was not previously removed.
*/
boolean reset(Instrumentation instrumentation, AgentBuilder.RedefinitionStrategy redefinitionStrategy);
/**
*
* Deregisters this class file transformer and redefines any transformed class to its state without this
* class file transformer applied, if the supplied redefinition strategy is enabled. If it is not enabled,
* only the {@link net.bytebuddy.agent.builder.AgentBuilder.InstallationListener} is informed about the
* resetting without undoing any code changes.
*
*
* Note: A reset class file transformer should not be reinstalled. Instead, the {@link AgentBuilder}
* which built the transformer should be asked to install a new transformer.
*
*
* Important: Most JVMs do not support changes of a class's structure after a class was already
* loaded. Therefore, it is typically required that this class file transformer was built while enabling
* {@link AgentBuilder#disableClassFormatChanges()}.
*
*
* @param instrumentation The instrumentation instance from which to deregister the transformer.
* @param redefinitionStrategy The redefinition to apply.
* @param redefinitionBatchAllocator The batch allocator to use.
* @return {@code true} if a reset was applied and this transformer was not previously removed.
*/
boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.BatchAllocator redefinitionBatchAllocator);
/**
*
* Deregisters this class file transformer and redefines any transformed class to its state without this
* class file transformer applied, if the supplied redefinition strategy is enabled. If it is not enabled,
* only the {@link net.bytebuddy.agent.builder.AgentBuilder.InstallationListener} is informed about the
* resetting without undoing any code changes.
*
*
* Note: A reset class file transformer should not be reinstalled. Instead, the {@link AgentBuilder}
* which built the transformer should be asked to install a new transformer.
*
*
* Important: Most JVMs do not support changes of a class's structure after a class was already
* loaded. Therefore, it is typically required that this class file transformer was built while enabling
* {@link AgentBuilder#disableClassFormatChanges()}.
*
*
* @param instrumentation The instrumentation instance from which to deregister the transformer.
* @param redefinitionStrategy The redefinition to apply.
* @param redefinitionDiscoveryStrategy The discovery strategy for the types to reset.
* @return {@code true} if a reset was applied and this transformer was not previously removed.
*/
boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.DiscoveryStrategy redefinitionDiscoveryStrategy);
/**
*
* Deregisters this class file transformer and redefines any transformed class to its state without this
* class file transformer applied, if the supplied redefinition strategy is enabled. If it is not enabled,
* only the {@link net.bytebuddy.agent.builder.AgentBuilder.InstallationListener} is informed about the
* resetting without undoing any code changes.
*
*
* Note: A reset class file transformer should not be reinstalled. Instead, the {@link AgentBuilder}
* which built the transformer should be asked to install a new transformer.
*
*
* Important: Most JVMs do not support changes of a class's structure after a class was already
* loaded. Therefore, it is typically required that this class file transformer was built while enabling
* {@link AgentBuilder#disableClassFormatChanges()}.
*
*
* @param instrumentation The instrumentation instance from which to deregister the transformer.
* @param redefinitionStrategy The redefinition to apply.
* @param redefinitionDiscoveryStrategy The discovery strategy for the types to reset.
* @param redefinitionBatchAllocator The batch allocator to use.
* @return {@code true} if a reset was applied and this transformer was not previously removed.
*/
boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.BatchAllocator redefinitionBatchAllocator,
AgentBuilder.RedefinitionStrategy.DiscoveryStrategy redefinitionDiscoveryStrategy);
/**
*
* Deregisters this class file transformer and redefines any transformed class to its state without this
* class file transformer applied, if the supplied redefinition strategy is enabled. If it is not enabled,
* only the {@link net.bytebuddy.agent.builder.AgentBuilder.InstallationListener} is informed about the
* resetting without undoing any code changes.
*
*
* Note: A reset class file transformer should not be reinstalled. Instead, the {@link AgentBuilder}
* which built the transformer should be asked to install a new transformer.
*
*
* Important: Most JVMs do not support changes of a class's structure after a class was already
* loaded. Therefore, it is typically required that this class file transformer was built while enabling
* {@link AgentBuilder#disableClassFormatChanges()}.
*
*
* @param instrumentation The instrumentation instance from which to deregister the transformer.
* @param redefinitionStrategy The redefinition to apply.
* @param redefinitionDiscoveryStrategy The discovery strategy for the types to reset.
* @param redefinitionListener The redefinition listener to apply.
* @return {@code true} if a reset was applied and this transformer was not previously removed.
*/
boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.DiscoveryStrategy redefinitionDiscoveryStrategy,
AgentBuilder.RedefinitionStrategy.Listener redefinitionListener);
/**
*
* Deregisters this class file transformer and redefines any transformed class to its state without this
* class file transformer applied, if the supplied redefinition strategy is enabled. If it is not enabled,
* only the {@link net.bytebuddy.agent.builder.AgentBuilder.InstallationListener} is informed about the
* resetting without undoing any code changes.
*
*
* Note: A reset class file transformer should not be reinstalled. Instead, the {@link AgentBuilder}
* which built the transformer should be asked to install a new transformer.
*
*
* Important: Most JVMs do not support changes of a class's structure after a class was already
* loaded. Therefore, it is typically required that this class file transformer was built while enabling
* {@link AgentBuilder#disableClassFormatChanges()}.
*
*
* @param instrumentation The instrumentation instance from which to deregister the transformer.
* @param redefinitionStrategy The redefinition to apply.
* @param redefinitionBatchAllocator The batch allocator to use.
* @param redefinitionListener The redefinition listener to apply.
* @return {@code true} if a reset was applied and this transformer was not previously removed.
*/
boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.BatchAllocator redefinitionBatchAllocator,
AgentBuilder.RedefinitionStrategy.Listener redefinitionListener);
/**
*
* Deregisters this class file transformer and redefines any transformed class to its state without this
* class file transformer applied, if the supplied redefinition strategy is enabled. If it is not enabled,
* only the {@link net.bytebuddy.agent.builder.AgentBuilder.InstallationListener} is informed about the
* resetting without undoing any code changes.
*
*
* Note: A reset class file transformer should not be reinstalled. Instead, the {@link AgentBuilder}
* which built the transformer should be asked to install a new transformer.
*
*
* Important: Most JVMs do not support changes of a class's structure after a class was already
* loaded. Therefore, it is typically required that this class file transformer was built while enabling
* {@link AgentBuilder#disableClassFormatChanges()}.
*
*
* @param instrumentation The instrumentation instance from which to deregister the transformer.
* @param redefinitionStrategy The redefinition to apply.
* @param redefinitionDiscoveryStrategy The discovery strategy for the types to reset.
* @param redefinitionBatchAllocator The batch allocator to use.
* @param redefinitionListener The redefinition listener to apply.
* @return {@code true} if a reset was applied and this transformer was not previously removed.
*/
boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.DiscoveryStrategy redefinitionDiscoveryStrategy,
AgentBuilder.RedefinitionStrategy.BatchAllocator redefinitionBatchAllocator,
AgentBuilder.RedefinitionStrategy.Listener redefinitionListener);
/**
* An abstract base implementation of a {@link ResettableClassFileTransformer}.
*/
abstract class AbstractBase implements ResettableClassFileTransformer {
/**
* {@inheritDoc}
*/
public boolean reset(Instrumentation instrumentation, AgentBuilder.RedefinitionStrategy redefinitionStrategy) {
return reset(instrumentation,
redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.BatchAllocator.ForTotal.INSTANCE);
}
/**
* {@inheritDoc}
*/
public boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.BatchAllocator redefinitionBatchAllocator) {
return reset(instrumentation,
redefinitionStrategy,
redefinitionBatchAllocator,
AgentBuilder.RedefinitionStrategy.Listener.NoOp.INSTANCE);
}
/**
* {@inheritDoc}
*/
public boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.DiscoveryStrategy redefinitionDiscoveryStrategy) {
return reset(instrumentation,
redefinitionStrategy,
redefinitionDiscoveryStrategy,
AgentBuilder.RedefinitionStrategy.Listener.NoOp.INSTANCE);
}
/**
* {@inheritDoc}
*/
public boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.BatchAllocator redefinitionBatchAllocator,
AgentBuilder.RedefinitionStrategy.DiscoveryStrategy redefinitionDiscoveryStrategy) {
return reset(instrumentation,
redefinitionStrategy,
redefinitionDiscoveryStrategy,
redefinitionBatchAllocator,
AgentBuilder.RedefinitionStrategy.Listener.NoOp.INSTANCE);
}
/**
* {@inheritDoc}
*/
public boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.DiscoveryStrategy redefinitionDiscoveryStrategy,
AgentBuilder.RedefinitionStrategy.Listener redefinitionListener) {
return reset(instrumentation,
redefinitionStrategy,
redefinitionDiscoveryStrategy,
AgentBuilder.RedefinitionStrategy.BatchAllocator.ForTotal.INSTANCE,
redefinitionListener);
}
/**
* {@inheritDoc}
*/
public boolean reset(Instrumentation instrumentation,
AgentBuilder.RedefinitionStrategy redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.BatchAllocator redefinitionBatchAllocator,
AgentBuilder.RedefinitionStrategy.Listener redefinitionListener) {
return reset(instrumentation,
redefinitionStrategy,
AgentBuilder.RedefinitionStrategy.DiscoveryStrategy.SinglePass.INSTANCE,
redefinitionBatchAllocator,
redefinitionListener);
}
}
}