hk2 4.0.1 · org.glassfish.hk2.api · APIdia, the JavaDoc alternative

Interface Summary

Modifier and Type	Interface and Description
public interface	ActiveDescriptor< This is the type produced by the cache and consumed by the cache T> An ActiveDescriptor contains information about a Descriptor after it has been reified.
public interface	AOPProxyCtl This interface is implemented by all services that use the AOP Alliance Interceptor feature of HK2.
public interface	ClassAnalyzer When HK2 automatically analyzes a class to find the constructor, fields, initializer methods and postConstruct and preDestroy methods it uses this service to analyze the class.
public interface	Context< This must be the type for which this is a context. For example, if your scope is SecureScope, then your context must implement Context<SecureScope> T> An implementation of this must be put into the system in order to create contextual instances of services.
public interface	Descriptor A Descriptor is a bean-like structure that describes a service declaration in HK2.
public interface	DescriptorFileFinder Implementations of this interface allow the customization of how hk2 inhabitant files are found.
public interface	DescriptorFileFinderInformation Returns information about the `java.io.InputStream` returned by `DescriptorFileFinder#findDescriptorFiles()` that can be used to give better information when one of the streams fails.
public interface	DynamicConfiguration This class is used to add `Descriptor`s to a `ServiceLocator` instance.
public interface	DynamicConfigurationListener A service that listens for dynamic configuration changes.
public interface	DynamicConfigurationService The dynamic configuration service is the source of `DynamicConfiguration` instances, which can be used to bind and unbind entities into the system
public interface	ErrorInformation This class has information in it about the error that has occurred
public interface	ErrorService This interface should be implemented by those who wish to be notified of error conditions that occur within HK2.
public interface	Factory< This must be the type of entity for which this is a factory. For example, if this were a factory for Foo, then your factory must implement Factory<Foo>. T> This interface should be implemented in order to provide a factory for another type.
public interface	FactoryDescriptors This is a convenience class that links together the factory descriptor as a factory for another type and the factory as a service itself.
public interface	Filter This object is used to search for items in the service registry
public interface	HK2Invocation This is an interface that is also implemented by the `org.aopalliance.intercept.MethodInvocation` object passed to the invoke method of `org.aopalliance.intercept.MethodInterceptor` and the `org.aopalliance.intercept.ConstructorInvocation` object passed to the invoke method of `org.aopalliance.intercept.ConstructorInterceptor`.
public interface	HK2Loader This class is responsible for loading classes, and different implementations can be used for different descriptors.
public interface	ImmediateController This service is advertised when the Immediate service is put into the registry.
public interface	IndexedFilter This filter can be used to limit the set of Descriptors passed to the matches method.
public interface	Injectee An Injectee represents the point of injection.
public interface	InjectionResolver< This must be the class of the injection annotation that this resolver will handle T> This class allows users to provide a custom injection target for any annotation (including @Inject).
public interface	InstanceLifecycleEvent This object contains information about a lifecycle event.
public interface	InstanceLifecycleListener This processor is called for certain events in the lifecycle of instances of services.
public interface	InstantiationData Contains information about the caller of a `Factory#provide()` method
public interface	InstantiationService This service is used to get information about the creation of a service from an implementation of `Factory`.
public interface	InterceptionService This service is implemented in order to configure interceptors on methods or constructors provided by hk2 services.
public interface	IterableProvider< The type of this IterableProvider T> This object can be injected rather than `Provider` when it is desired to iterate over more than one returned instance of the type.
public interface	JustInTimeInjectionResolver The JustInTimeInjectionResolver is called when an injection point cannot find anything to inject.
public interface	MethodParameter This is used to describe the values to be given to the method in the `ServiceLocator#assistedInject(Object, java.lang.reflect.Method, MethodParameter...)` method
public interface	Populator Implementations of this interface are used to populate HK2 service locators from inhabitants files
public interface	PopulatorPostProcessor This interface allows the customization of services read in from an external source.
public interface	PostConstruct Classes implementing this interface register an interest in being notified when the instance has been created and the component is about to be place into commission.
public interface	PreDestroy Components implementing this interface registers an interest in being notified when they are about to be decommissioned.
public interface	ProxyCtl Every proxy generated by HK2 will implement this interface, which can be used to have finer control on the behavior of the proxy Compare this to the `AOPProxyCtl` interface, which is implemented by proxies used for the AOPAlliance method or constructor interceptor feature
public interface	ServiceHandle< The type of the service that can be returned T> This service handle can be used to get a specific instance of a service, and can be used to destroy that service as well
public interface	ServiceLocator ServiceLocator is the registry for HK2 services This service is the most fundamental service in an HK2 system.
public interface	ServiceLocatorListener This is added to the `ServiceLocatorFactory` in order to listen on service locators coming and going.
public interface	SingleCache< The type of service stored and returned from this cache T> This cache can be used in some circumstances when there can be only one of a service.
public interface	TwoPhaseResource Implementations of this interface can be added to a `DynamicConfiguration` in order to atomically participate in the changes being made to the `ServiceLocator`.
public interface	TwoPhaseTransactionData
public interface	ValidationInformation This object contains information about the validation point.
public interface	ValidationService This service can be used to add validation points to Descriptors.
public interface	Validator This method is called when it determined that a type that is annotated with a Validating annotation is to be injected into any other class.

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	ContractIndicator This annotation is put on annotations that are used to mark things as hk2 contracts.
public @interface	Customize Indicates that a method should be customized.
public @interface	Customizer Gives the type (and optional name) of a customizer service to use when an unknown method on a bean interface is encountered.
public @interface	Immediate Immediate is a scope that operates like `jakarta.inject.Singleton` scope, except that instances are created as soon as their corresponding `Descriptor`s are added.
public @interface	InheritableThread InheritableThread is a scope that operates like `org.glassfish.hk2.api.PerThread` scope, except with the caveat that InheritableThread scoped services provide inheritance of values from parent thread to child thread.
public @interface	InjectionPointIndicator This annotation is placed on another annotation to indicate that the annotation may be used to indicate an injection point
public @interface	Metadata This annotation marks a method of an annotation as providing a value that should be placed into the metadata of a `Descriptor`.
public @interface	PerLookup PerLookup is the scope for objects that are created every time they are looked up.
public @interface	PerThread PerThread is a scope that operates like `jakarta.inject.Singleton` scope, except on a per-thread basis.
public @interface	Proxiable Scope annotations that are also marked with this annotation are proxiable.
public @interface	ProxyForSameScope This annotation is used when automatically analyzing a class or a {link `Factory#provide()` method to indicate that the descriptor either should or should use a proxy when being injected into a service from the same scope.
public @interface	Rank This annotation is used to provide the initial rank of a service marked with `org.jvnet.hk2.annotations.Service`.
public @interface	Self This annotation is placed on an injection point that is to be injected with the `ActiveDescriptor` that was used to create the instance.
public @interface	Unproxiable This annotation must go on a scope annotation in order to indicate that no services from this scope may be proxied.
public @interface	Unqualified An injection point can be annotated with @Unqualified if it should only be injected with services that have no qualifiers at all
public @interface	UseProxy This annotation is used when automatically analyzing a class or a {link `Factory#provide()` method to indicate that the descriptor either should or should not use a proxy.
public @interface	Visibility This annotation is used when automatically analyzing a class or a {link `Factory#provide()` method to indicate that the descriptor either should or should not have LOCAL visibility.

Modifier and Type	Class and Description
public abstract class	AnnotationLiteral< the annotation type T extends Annotation> Supports inline instantiation of annotation type instances.
public class	DuplicateServiceException This exception is thrown when an idempotent filter of a DynamicConfiguration object matches an existing descriptor in the ServiceLocator
public class	HK2Exception Base class for HK2 defined checked exceptions
public class	HK2RuntimeException Base class for HK2 defined runtime exceptions
public class	MultiException This exception can contain multiple other exceptions.
public abstract class	ServiceLocatorFactory This factory can be used to create new named ServiceLocators
public abstract class	TypeLiteral<T> Supports inline instantiation of objects that represent parameterized types with actual type parameters.
public class	UnsatisfiedDependencyException This exception will be found in a `MultiException` when a class has a dependency that should be satisfied but cannot be.

Modifier and Type	Enum and Description
public enum	DescriptorType This describes the type of descriptor
public enum	DescriptorVisibility This enumeration determines how visibility of a descriptor
public enum	ErrorType This enumeration describes the types of errors that might occur
public enum	InstanceLifecycleEventType This describes the type of lifecycle events that can happen in the system
public enum	Operation This defines the operations that may be validated
public enum	ServiceLocatorState The possible states in which a service locator can be in. Portable code should assume that future states will be added

Package org.glassfish.hk2.api

Interface Summary

Annotation Summary

Class Summary

Enum Summary