View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.deployment;
18  
19  
20  /***
21   * <p>
22   * DeploymentEvent
23   * </p>
24   * <p>
25   * A <code>DeploymentEvent</code> is fired when a DeploymentEventDispatcher is notified that
26   * a deployment event has occurred, for example, a JAR file being drop into a specific directory.
27   * </p>
28   * @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
29   * @version $Id: DeploymentEvent.java 516448 2007-03-09 16:25:47Z ate $
30   *
31   */
32  public interface DeploymentEvent extends DeploymentStatus 
33  {
34      /***
35  	 * 
36  	 * <p>
37  	 * getDeploymentObject
38  	 * </p>
39  	 * @see org.apache.jetspeed.deployment.DeploymentObject
40  	 *
41  	 * @return An instance of <code>org.apache.jetspeed.deployment.DeploymentObject</code>
42  	 */
43  	DeploymentObject getDeploymentObject();
44  	
45  	/***
46  	 * 
47  	 * <p>
48  	 * setStatus
49  	 * </p>
50  	 *
51  	 * Sets the status of this event. @see getEvent()
52  	 * @param status
53  	 */
54  	void setStatus(int status);
55  	
56  	String getName();
57  	
58  	String getPath();
59  }