Package org.jboss.resteasy.core.se

Class ResteasySeInstance

java.lang.Object

org.jboss.resteasy.core.se.ResteasySeInstance

All Implemented Interfaces:

SeBootstrap.Instance

public class ResteasySeInstance
extends Object
implements SeBootstrap.Instance

An implementation of a SeBootstrap.Instance.

Since:

6.1

Author:

James R. Perkins

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.ws.rs.SeBootstrap.Instance

SeBootstrap.Instance.StopResult

Method Summary

Modifier and Type	Method	Description
SeBootstrap.Configuration	configuration()	Provides access to the configuration actually used by the implementation used to create this instance.
static CompletionStage<SeBootstrap.Instance>	create(Application application, SeBootstrap.Configuration configuration)	Creates a new SeBootstrap.Instance based on the application and configuration passed in.
static CompletionStage<SeBootstrap.Instance>	create(Class<? extends Application> applicationClass, SeBootstrap.Configuration configuration)	Creates a new SeBootstrap.Instance based on the application and configuration passed in.
CompletionStage<SeBootstrap.Instance.StopResult>	stop()	Initiate immediate shutdown of running application instance.
<T> T	unwrap(Class<T> nativeClass)	Provides access to the wrapped native handle of the application instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.ws.rs.SeBootstrap.Instance

stopOnShutdown

Method Detail

create

public static CompletionStage<SeBootstrap.Instance> create(Application application,
                                                           SeBootstrap.Configuration configuration)

Creates a new SeBootstrap.Instance based on the application and configuration passed in.

Note that if your Application does not override the Application.getClasses() or Application.getSingletons() a Jandex index is used to find resources and providers. It's suggested that your application has a META-INF/jandex.idx or you provide an index with the ConfigurationOption.JANDEX_INDEX configuration option. If neither of those exist, the class path itself is indexed which could have significant performance impacts.

Parameters:

application - the application to use for this instance

configuration - the configuration used to configure the instance

Returns:

a CompletionStage which asynchronously produces and SeBootstrap.Instance

create

public static CompletionStage<SeBootstrap.Instance> create(Class<? extends Application> applicationClass,
                                                           SeBootstrap.Configuration configuration)

Creates a new SeBootstrap.Instance based on the application and configuration passed in.

Note that if your Application does not override the Application.getClasses() or Application.getSingletons() a Jandex index is used to find resources and providers. It's suggested that your application has a META-INF/jandex.idx or you provide an index with the ConfigurationOption.JANDEX_INDEX configuration option. If neither of those exist, the class path itself is indexed which could have significant performance impacts.

Parameters:

applicationClass - the application to use for this instance

configuration - the configuration used to configure the instance

Returns:

a CompletionStage which asynchronously produces and SeBootstrap.Instance

configuration

public SeBootstrap.Configuration configuration()

Description copied from interface: SeBootstrap.Instance

Provides access to the configuration actually used by the implementation used to create this instance.

This may, or may not, be the same instance passed to SeBootstrap.start(Application, Configuration), not even an equal instance, as implementations MAY create a new intance and MUST update at least the PORT property with the actually used value. Portable applications should not make any assumptions but always explicitly read the actual values from the configuration returned from this method.

Specified by:

configuration in interface SeBootstrap.Instance

Returns:

The configuration actually used to create this instance.

stop

public CompletionStage<SeBootstrap.Instance.StopResult> stop()

Description copied from interface: SeBootstrap.Instance

Initiate immediate shutdown of running application instance.

Specified by:

stop in interface SeBootstrap.Instance

Returns:

CompletionStage asynchronously shutting down this application instance.

unwrap

public <T> T unwrap(Class<T> nativeClass)

Description copied from interface: SeBootstrap.Instance

Provides access to the wrapped native handle of the application instance.

Implementations may, or may not, have native handles. Portable applications should not invoke this method, as the outcome is undefined.

Specified by:

unwrap in interface SeBootstrap.Instance

Type Parameters:

T - Requested type of the native handle to return.

Parameters:

nativeClass - Requested type of the native handle to return.

Returns:

Native handle of the running application instance or null if the implementation has no native handle.