EE4J Core API 10.0.0 · jakarta.ws.rs.core.Application

Defines the components of a JAX-RS application and supplies additional meta-data. A JAX-RS application or implementation supplies a concrete subclass of this abstract class.

The implementation-created instance of an Application subclass may be injected into resource classes and providers using jakarta.ws.rs.core.Context.

In case any of the Application subclass methods or it's constructor throws a RuntimeException, the deployment of the application SHOULD be aborted with a failure.

Constructor Summary

Access	Constructor and Description
public	Application()

Method Summary

Modifier and Type	Method and Description
public Set<Class<?>>	Returns: a set of root resource and provider classes. Returning `null` is equivalent to returning an empty set. getClasses() Get a set of root resource, provider and `feature` classes.
public Map<String, Object>	Returns: a map of custom application-wide properties. Returning `null` is equivalent to returning an empty set. getProperties() Get a map of custom application-wide properties.
public Set<Object>	Returns: a set of root resource and provider instances. Returning `null` is equivalent to returning an empty set. getSingletons() Deprecated Automatic discovery of resources and providers or the `getClasses` method is preferred over `getSingletons`. Get a set of root resource, provider and `feature` instances.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Application	back to summary
public Application()

Method Detail

getClasses back to summary

getClasses	back to summary
public Set<Class<?>> getClasses() Get a set of root resource, provider and `feature` classes. The default life-cycle for resource class instances is per-request. The default life-cycle for providers (registered directly or via a feature) is singleton. Implementations should warn about and ignore classes that do not conform to the requirements of root resource or provider/feature classes. Implementations should warn about and ignore classes for which `getSingletons()` returns an instance. Implementations MUST NOT modify the returned set. The default implementation returns an empty set. Returns:Set<Class<?>> a set of root resource and provider classes. Returning `null` is equivalent to returning an empty set.

public Set<Class<?>> getClasses()

Get a set of root resource, provider and feature classes. The default life-cycle for resource class instances is per-request. The default life-cycle for providers (registered directly or via a feature) is singleton.

Implementations should warn about and ignore classes that do not conform to the requirements of root resource or provider/feature classes. Implementations should warn about and ignore classes for which getSingletons() returns an instance. Implementations MUST NOT modify the returned set.

The default implementation returns an empty set.

Returns:Set<Class<?>>: a set of root resource and provider classes. Returning null is equivalent to returning an empty set.

getProperties back to summary

getProperties	back to summary
public Map<String, Object> getProperties() Get a map of custom application-wide properties. The returned properties are reflected in the application `configuration` passed to the server-side features or injected into server-side JAX-RS components. The set of returned properties may be further extended or customized at deployment time using container-specific features and deployment descriptors. For example, in a Servlet-based deployment scenario, web application's `<context-param>` and Servlet `<init-param>` values may be used to extend or override values of the properties programmatically returned by this method. The default implementation returns an empty set. Returns:Map<String, Object> a map of custom application-wide properties. Returning `null` is equivalent to returning an empty set. Since 2.0

public Map<String, Object> getProperties()

Get a map of custom application-wide properties.

The returned properties are reflected in the application configuration passed to the server-side features or injected into server-side JAX-RS components.

The set of returned properties may be further extended or customized at deployment time using container-specific features and deployment descriptors. For example, in a Servlet-based deployment scenario, web application's <context-param> and Servlet <init-param> values may be used to extend or override values of the properties programmatically returned by this method.

The default implementation returns an empty set.

Returns:Map<String, Object>: a map of custom application-wide properties. Returning null is equivalent to returning an empty set.
Since: 2.0

getSingletons back to summary

getSingletons	back to summary
public Set<Object> getSingletons() Deprecated Automatic discovery of resources and providers or the `getClasses` method is preferred over `getSingletons`. Get a set of root resource, provider and `feature` instances. Fields and properties of returned instances are injected with their declared dependencies (see `Context`) by the runtime prior to use. Implementations should warn about and ignore classes that do not conform to the requirements of root resource or provider classes. Implementations should flag an error if the returned set includes more than one instance of the same class. Implementations MUST NOT modify the returned set. The default implementation returns an empty set. Returns:Set<Object> a set of root resource and provider instances. Returning `null` is equivalent to returning an empty set. Annotations @Deprecated

public Set<Object> getSingletons()

Deprecated

Automatic discovery of resources and providers or the getClasses method is preferred over getSingletons.

Get a set of root resource, provider and feature instances. Fields and properties of returned instances are injected with their declared dependencies (see Context) by the runtime prior to use.

Implementations should warn about and ignore classes that do not conform to the requirements of root resource or provider classes. Implementations should flag an error if the returned set includes more than one instance of the same class. Implementations MUST NOT modify the returned set.

The default implementation returns an empty set.

Returns:Set<Object>

a set of root resource and provider instances. Returning null is equivalent to returning an empty set.

Annotations

@Deprecated

public Class Application

Constructor Summary

Method Summary

Constructor Detail

Method Detail