org.glassfish.webservices

Class WebServicesDeployer

java.lang.Object

org.glassfish.javaee.core.deployment.JavaEEDeployer<WebServicesContainer,WebServicesApplication>

org.glassfish.webservices.WebServicesDeployer

All Implemented Interfaces:

Deployer<WebServicesContainer,WebServicesApplication>

@Service
public class WebServicesDeployer
extends JavaEEDeployer<WebServicesContainer,WebServicesApplication>

Webservices module deployer. This is loaded from WebservicesContainer

Author:

Bhakti Mehta, Rama Pulavarthi

Field Summary

Fields

Modifier and Type	Field and Description
static WebServiceDeploymentNotifier	deploymentNotifier

Fields inherited from class org.glassfish.javaee.core.deployment.JavaEEDeployer

appRegistry, env, habitat, undeploymentVisitor

Constructor Summary

Constructors

Constructor and Description
WebServicesDeployer() Constructor

Method Summary

Modifier and Type	Method and Description
void	clean(DeploymentContext dc) Clean any files and artifacts that were created during the execution of the prepare method.
protected void	cleanArtifacts(DeploymentContext deploymentContext)
void	downloadFile(URL httpUrl, File toFile)
static WebServiceDeploymentNotifier	getDeploymentNotifier()
MetaData	getMetaData() Returns the meta data assocated with this Deployer
WebServicesApplication	load(WebServicesContainer container, DeploymentContext context) Loads a previously prepared application in its execution environment and return a ContractProvider instance that will identify this environment in future communications with the application's container runtime.
Object	loadMetaData(Class type, DeploymentContext dc) Loads the meta date associated with the application.
static void	moveFile(String sourceFile, String destFile)
boolean	prepare(DeploymentContext dc) Prepares the application bits for running in the application server.
URL	resolveCatalog(File catalogFile, String wsdlFile, WebService ws)
protected void	setupJaxWSServiceForDeployment(DeploymentContext dc, WebService ws)
void	unload(WebServicesApplication container, DeploymentContext context) Unload or stop a previously running application identified with the ContractProvider instance.

Methods inherited from class org.glassfish.javaee.core.deployment.JavaEEDeployer

generateArtifacts, getApplicationFromApplicationInfo, getCommonClassPath, getModuleClassPath, getObjectType

Methods inherited from class java.lang.Object

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

Field Detail

deploymentNotifier

public static final WebServiceDeploymentNotifier deploymentNotifier

Constructor Detail

WebServicesDeployer

public WebServicesDeployer()

Constructor

Method Detail

getDeploymentNotifier

public static WebServiceDeploymentNotifier getDeploymentNotifier()

prepare

public boolean prepare(DeploymentContext dc)

Prepares the application bits for running in the application server. For certain cases, this is exploding the jar file to a format the ContractProvider instance is expecting, generating non portable artifacts and other application specific tasks. Failure to prepare should throw an exception which will cause the overall deployment to fail.

Specified by:

prepare in interface Deployer<WebServicesContainer,WebServicesApplication>

Overrides:

prepare in class JavaEEDeployer<WebServicesContainer,WebServicesApplication>

Parameters:

dc - deployment context

Returns:

true if the prepare phase was successful

cleanArtifacts

protected void cleanArtifacts(DeploymentContext deploymentContext)
                       throws DeploymentException

Throws:

DeploymentException

setupJaxWSServiceForDeployment

protected void setupJaxWSServiceForDeployment(DeploymentContext dc,
                                              WebService ws)
                                       throws DeploymentException

Throws:

DeploymentException

loadMetaData

public Object loadMetaData(Class type,
                           DeploymentContext dc)

Loads the meta date associated with the application.

Specified by:

loadMetaData in interface Deployer<WebServicesContainer,WebServicesApplication>

Overrides:

loadMetaData in class JavaEEDeployer<WebServicesContainer,WebServicesApplication>

Parameters:

type - type of metadata that this deployer has declared providing.

dc - deployment context

Returns:

the meta-data of type V

getMetaData

public MetaData getMetaData()

Returns the meta data assocated with this Deployer

Specified by:

getMetaData in interface Deployer<WebServicesContainer,WebServicesApplication>

Overrides:

getMetaData in class JavaEEDeployer<WebServicesContainer,WebServicesApplication>

Returns:

the meta data for this Deployer

resolveCatalog

public URL resolveCatalog(File catalogFile,
                          String wsdlFile,
                          WebService ws)
                   throws DeploymentException

Throws:

DeploymentException

downloadFile

public void downloadFile(URL httpUrl,
                         File toFile)
                  throws Exception

Throws:

Exception

moveFile

public static void moveFile(String sourceFile,
                            String destFile)
                     throws IOException

Throws:

IOException

unload

public void unload(WebServicesApplication container,
                   DeploymentContext context)

Description copied from interface: Deployer

Unload or stop a previously running application identified with the ContractProvider instance. The container will be stop upon return from this method.

Parameters:

container - instance to be stopped

context - of the undeployment

clean

public void clean(DeploymentContext dc)

Description copied from class: JavaEEDeployer

Clean any files and artifacts that were created during the execution of the prepare method.

Specified by:

clean in interface Deployer<WebServicesContainer,WebServicesApplication>

Overrides:

clean in class JavaEEDeployer<WebServicesContainer,WebServicesApplication>

Parameters:

dc - deployment context

load

public WebServicesApplication load(WebServicesContainer container,
                                   DeploymentContext context)

Description copied from class: JavaEEDeployer

Loads a previously prepared application in its execution environment and return a ContractProvider instance that will identify this environment in future communications with the application's container runtime.

Specified by:

load in interface Deployer<WebServicesContainer,WebServicesApplication>

Overrides:

load in class JavaEEDeployer<WebServicesContainer,WebServicesApplication>

Parameters:

container - in which the application will reside

context - of the deployment

Returns:

an ApplicationContainer instance identifying the running application