org.glassfish.resourcebase.resources.api

Interface ResourceDeployer

All Known Implementing Classes:

AbstractConnectorResourceDeployer, AdministeredObjectDefinitionDeployer, AdminObjectResourceDeployer, ConnectionFactoryDefinitionDeployer, ConnectorConnectionPoolDeployer, ConnectorResourceDeployer, ConnectorWorkSecurityMapDeployer, ContextServiceDeployer, CustomResourceDeployer, DataSourceDefinitionDeployer, ExternalJndiResourceDeployer, JdbcConnectionPoolDeployer, JdbcResourceDeployer, JMSConnectionFactoryDefinitionDeployer, JMSDestinationDefinitionDeployer, MailResourceDeployer, MailSessionDeployer, ManagedExecutorServiceDeployer, ManagedScheduledExecutorServiceDeployer, ManagedThreadFactoryDeployer, ResourceAdapterConfigDeployer

@Contract
public interface ResourceDeployer

Interface to be implemented by different resource types (eg. jms-resource) to deploy/undeploy a resource to the server's runtime naming context.

The methods can potentially be called concurrently, therefore implementation need to do synchronization if necessary.

Method Summary

Modifier and Type	Method and Description
boolean	canDeploy(boolean postApplicationDeployment, Collection<Resource> allResources, Resource resource) A deployer can indicate whether a particular resource can be deployed before application deployment Used in case of application-scoped-resources eg: Embedded RAR resources are created after application (that has embedded .rar) deployment.
void	deployResource(Object resource) Deploy the resource into the server's runtime naming context
void	deployResource(Object resource, String applicationName, String moduleName) Deploy the resource into the server's runtime naming context This API is used in cases where the "config" bean is not yet persisted in domain.xml and is part of the "config" transaction.
void	disableResource(Object resource) Disable the resource in the server's runtime naming context
void	enableResource(Object resource) Enable the resource in the server's runtime naming context
Class[]	getProxyClassesForDynamicReconfiguration() List of classes which need to be proxied for dynamic-reconfiguration
boolean	handles(Object resource) Indicates whether a particular resource deployer can handle the resource in question
void	redeployResource(Object resource) Redeploy the resource into the server's runtime naming context
boolean	supportsDynamicReconfiguration() Indicates whether the resource deployer can handle transparent-dynamic-reconfiguration of resource
void	undeployResource(Object resource) Undeploy the resource from the server's runtime naming context
void	undeployResource(Object resource, String applicationName, String moduleName) Undeploy the resource from the server's runtime naming context
void	validatePreservedResource(Application oldApp, Application newApp, Resource resource, Resources allResources)

Method Detail

deployResource

void deployResource(Object resource,
                    String applicationName,
                    String moduleName)
             throws Exception

Deploy the resource into the server's runtime naming context This API is used in cases where the "config" bean is not yet persisted in domain.xml and is part of the "config" transaction.

Parameters:

resource - a resource object (eg. JmsResource)

applicationName - application-name

moduleName - module-name

Throws:

Exception - thrown if fail

deployResource

void deployResource(Object resource)
             throws Exception

Deploy the resource into the server's runtime naming context

Parameters:

resource - a resource object (eg. JmsResource)

Throws:

Exception - thrown if fail

undeployResource

void undeployResource(Object resource)
               throws Exception

Undeploy the resource from the server's runtime naming context

Parameters:

resource - a resource object (eg. JmsResource)

Throws:

Exception - thrown if fail

undeployResource

void undeployResource(Object resource,
                      String applicationName,
                      String moduleName)
               throws Exception

Undeploy the resource from the server's runtime naming context

Parameters:

resource - a resource object (eg. JmsResource)

applicationName - application-name

moduleName - module-name

Throws:

Exception - thrown if fail

redeployResource

void redeployResource(Object resource)
               throws Exception

Redeploy the resource into the server's runtime naming context

Parameters:

resource - a resource object

Throws:

Exception - thrown if fail

enableResource

void enableResource(Object resource)
             throws Exception

Enable the resource in the server's runtime naming context

Parameters:

resource - a resource object (eg. JmsResource)

Throws:

Exception - thrown if fail

disableResource

void disableResource(Object resource)
              throws Exception

Disable the resource in the server's runtime naming context

Parameters:

resource - a resource object (eg. JmsResource)

Throws:

Exception - thrown if fail

handles

boolean handles(Object resource)

Indicates whether a particular resource deployer can handle the resource in question

Parameters:

resource - resource that need to be handled

Returns:

boolean

supportsDynamicReconfiguration

boolean supportsDynamicReconfiguration()

Indicates whether the resource deployer can handle transparent-dynamic-reconfiguration of resource

Returns:

boolean indicating whether transparent-dynamic-reconfiguration is supported.

getProxyClassesForDynamicReconfiguration

Class[] getProxyClassesForDynamicReconfiguration()

List of classes which need to be proxied for dynamic-reconfiguration

Returns:

list of classes

canDeploy

boolean canDeploy(boolean postApplicationDeployment,
                  Collection<Resource> allResources,
                  Resource resource)

A deployer can indicate whether a particular resource can be deployed before application deployment
Used in case of application-scoped-resources
eg: Embedded RAR resources are created after application (that has embedded .rar) deployment.

Parameters:

postApplicationDeployment - post-application-deployment

allResources - resources collection in which the resource being validated is present.

resource - resource to be validated

Returns:

boolean

validatePreservedResource

void validatePreservedResource(Application oldApp,
                               Application newApp,
                               Resource resource,
                               Resources allResources)
                        throws ResourceConflictException

Throws:

ResourceConflictException