org.duracloud.services.webapputil

Interface WebAppUtil

All Superinterfaces:

ComputeService

All Known Implementing Classes:

WebAppUtilImpl

public interface WebAppUtil
extends ComputeService

This interface abstracts the ability to (un)deploy a webapp to/from an application server.

Author:

Andrew Woods Date: Dec 7, 2009

Nested Class Summary

Nested classes/interfaces inherited from interface org.duracloud.services.ComputeService

ComputeService.ServiceStatus

Field Summary

Fields inherited from interface org.duracloud.services.ComputeService

DELIM, ERROR_KEY, ERROR_REPORT_KEY, FAILURE_COUNT_KEY, ITEMS_PROCESS_COUNT, PASS_COUNT_KEY, REPORT_KEY, STARTTIME_KEY, STATUS_KEY, STOPTIME_KEY, SVC_LAUNCHING_USER, SYSTEM_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
URL	deploy(String context, String portIndex, InputStream war) This method deploys the arg war to a new application server under the arg context.
URL	deploy(String context, String portIndex, InputStream war, Map<String,String> env)
URL	filteredDeploy(String serviceId, String portIndex, InputStream war, Map<String,String> env, NamedFilterList filters) This method deploys the arg war to a newly created appserver under the arg serviceId context.
void	unDeploy(URL url) This method undeploys the webapp currently running at the arg url and destroys the application server that was hosting it.

Methods inherited from interface org.duracloud.services.ComputeService

describe, getServiceId, getServiceProps, getServiceStatus, getServiceWorkDir, setServiceWorkDir, start, stop

Method Detail

deploy

URL deploy(String context,
         String portIndex,
         InputStream war)

This method deploys the arg war to a new application server under the arg context. The arg war inputstream is closed by this method.

Parameters:

context - of webapp

portIndex - offset from configured base port

war - to deploy

Returns:

URL of running webapp

deploy

URL deploy(String context,
         String portIndex,
         InputStream war,
         Map<String,String> env)

filteredDeploy

URL filteredDeploy(String serviceId,
                 String portIndex,
                 InputStream war,
                 Map<String,String> env,
                 NamedFilterList filters)

This method deploys the arg war to a newly created appserver under the arg serviceId context.

Parameters:

serviceId - is the name of the context of deployed webapp

portIndex - offset from configured base port

war - to be deployed

env - of tomcat that will be installed/started

filters - are names of files in the arg war to be filtered with provided filters. Any filters that contain the strings $DURA_HOST$ or $DURA_PORT$ will be swapped with the host and port of the compute instance.

Returns:

URL of deployed webapp

unDeploy

void unDeploy(URL url)

This method undeploys the webapp currently running at the arg url and destroys the application server that was hosting it.

Parameters:

url - of webapp to undeploy