org.glassfish.tyrus.core

Class ComponentProviderService

java.lang.Object

org.glassfish.tyrus.core.ComponentProviderService

public class ComponentProviderService
extends Object

Provides an instance of component. Searches for registered ComponentProviders which are used to provide instances.

Author:

Martin Matula (martin.matula at oracle.com), Stepan Kopriva (stepan.kopriva at oracle.com), Pavel Bucek (pavel.bucek at oracle.com)

Constructor Summary

Constructors

Constructor and Description
ComponentProviderService(ComponentProviderService componentProviderService) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static ComponentProviderService	create() Create new instance of ComponentProviderService.
<T> T	getCoderInstance(Class<T> c, javax.websocket.Session session, javax.websocket.EndpointConfig endpointConfig, ErrorCollector collector) Provide an instance of Encoder or Decoder descendant which is coupled to Session.
<T> T	getEndpointInstance(Class<T> endpointClass) This method is called by the container each time a new client connects to the logical endpoint this configurator configures.
<T> T	getInstance(Class<T> c, javax.websocket.Session session, ErrorCollector collector) Provide an instance of class which is coupled to Session.
void	removeSession(javax.websocket.Session session) Remove Session from cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentProviderService

public ComponentProviderService(ComponentProviderService componentProviderService)

Copy constructor.

Parameters:

componentProviderService - original instance.

Method Detail

create

public static ComponentProviderService create()

Create new instance of ComponentProviderService.

Searches for registered ComponentProviders and registers them with this service.

DefaultComponentProvider is always added to found providers.

Returns:

initialized ComponentProviderService.

getInstance

public <T> T getInstance(Class<T> c,
                javax.websocket.Session session,
                ErrorCollector collector)

Provide an instance of class which is coupled to Session.

The first time the method is called the provider creates an instance and caches it. Next time the method is called the cached instance is returned.

Type Parameters:

T - type of the provided instance.

Parameters:

c - Class whose instance will be provided.

collector - error collector.

Returns:

instance

getCoderInstance

public <T> T getCoderInstance(Class<T> c,
                     javax.websocket.Session session,
                     javax.websocket.EndpointConfig endpointConfig,
                     ErrorCollector collector)

Provide an instance of Encoder or Decoder descendant which is coupled to Session.

The first time the method is called the provider creates an instance, calls Encoder.init(javax.websocket.EndpointConfig) or Decoder.init(javax.websocket.EndpointConfig) and caches it. Next time the method is called the cached instance is returned.

Type Parameters:

T - type of the provided instance.

Parameters:

c - Class whose instance will be provided.

collector - error collector.

endpointConfig - configuration corresponding to current context. Used for Encoder.init(javax.websocket.EndpointConfig) and Decoder.init(javax.websocket.EndpointConfig)

Returns:

instance

removeSession

public void removeSession(javax.websocket.Session session)

Remove Session from cache.

Parameters:

session - to be removed.

getEndpointInstance

public <T> T getEndpointInstance(Class<T> endpointClass)
                      throws InstantiationException

This method is called by the container each time a new client connects to the logical endpoint this configurator configures. Developers may override this method to control instantiation of endpoint instances in order to customize the initialization of the endpoint instance, or manage them in some other way. If the developer overrides this method, services like dependency injection that are otherwise supported, for example, when the implementation is part of the Java EE platform may not be available. The platform default implementation of this method returns a new endpoint instance per call, thereby ensuring that there is one endpoint instance per client, the default deployment cardinality.

Type Parameters:

T - the type of the endpoint.

Parameters:

endpointClass - the class of the endpoint.

Returns:

an instance of the endpoint that will handle all interactions from a new client.

Throws:

InstantiationException - if there was an error producing the endpoint instance.

See Also:

ServerEndpointConfig.Configurator.getEndpointInstance(Class)