1 /*
2 * Copyright 2006-2008 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.osgi.web.deployer;
18
19
20 /**
21 * An OSGi war deployment.
22 *
23 * <p/>Provides access to its context and control over its lifecycle.
24 *
25 * @see WarDeployer
26 *
27 * @author Costin Leau
28 *
29 */
30 public interface WarDeployment {
31
32 /**
33 * Returns the context associated with this deployer. Clients should use
34 * this interface for interacting with a war deployment as it gives access
35 * to its context without jeopardizing its lifecycle.
36 *
37 * @return context associated with this deployer.
38 */
39 WarDeploymentContext getDeploymentContext();
40
41 /**
42 * Indicates if the current deployment is active (still deployed) or not.
43 *
44 * @return false if the deployment has been undeployed, true otherwise.
45 */
46 boolean isActive();
47
48 /**
49 * Undeploys the current deployment. If the deployment has been already
50 * undeployed, this method simply returns.
51 *
52 * @throws OsgiWarDeploymentException if something went wrong during
53 * undeployment
54 */
55 void undeploy() throws OsgiWarDeploymentException;
56
57 }