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  import java.io.File;
20  
21  
22  /***
23   * @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
24   * 
25   * Interface that provides for firing and dispatching deployment realted events.
26   *
27   */
28  public interface DeploymentManager
29  {
30      DeploymentStatus deploy(File aFile) throws DeploymentException;
31      /***
32       * 
33       * <p>
34       * fireDeploymentEvent
35       * </p>
36       * Fires all deployment events registered to this DeploymentManager.
37       *
38       */
39      void fireDeploymentEvent();
40      
41      /***
42       * 
43       * <p>
44       * dispatch
45       * </p>
46       * 
47       * dispatches the DeploymentEvent to all registered deployment event listeners.
48       *
49       * @param event {@link DeploymentEvent} to dispatch.
50       */
51      void dispatch( DeploymentEvent event );
52  }