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.tools.pamanager;
18  
19  import org.apache.jetspeed.components.portletregistry.RegistryException;
20  import org.apache.jetspeed.util.FileSystemHelper;
21  
22  
23  /***
24   * PortletApplicationManagement
25   *
26   * @author <a href="mailto:ate@douma.nu">Ate Douma</a>
27   * @version $Id: PortletApplicationManagement.java 593180 2007-11-08 15:00:35Z weaver $
28   */
29  public interface PortletApplicationManagement
30  {
31    public static final String LOCAL_PA_PREFIX = "jetspeed-";
32    
33    public boolean isStarted();
34    /***
35     * Allows deployment to override the default of using the <code>contextName</code> as the
36     * context path.
37     * 
38     * @param contextName
39     * @param contextPath
40     * @param warStruct
41     * @param paClassLoader
42     * @throws RegistryException
43     */
44    void startPortletApplication(String contextName, String contextPath, FileSystemHelper warStruct, ClassLoader paClassLoader) throws RegistryException;
45    void startPortletApplication(String contextName, FileSystemHelper warStruct, ClassLoader paClassLoader) throws RegistryException;
46    void stopPortletApplication(String contextName) throws RegistryException;
47    void startLocalPortletApplication(String contextName, FileSystemHelper warStruct, ClassLoader paClassLoader) throws RegistryException;
48    void startInternalApplication(String contextName) throws RegistryException;
49    void stopLocalPortletApplication(String contextName) throws RegistryException;
50    public void unregisterPortletApplication(String paName) throws RegistryException;
51  }