1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.model;
24  
25  import java.io.Serializable;
26  
27  import java.util.Map;
28  import java.util.Properties;
29  import java.util.Set;
30  
31  /**
32   * <a href="PortletApp.java.html"><b><i>View Source</i></b></a>
33   *
34   * @author Brian Wing Shun Chan
35   *
36   */
37  public interface PortletApp extends Serializable {
38  
39      public String getServletContextName();
40  
41      public Set<String> getServletURLPatterns();
42  
43      public Set<String> getUserAttributes();
44  
45      public Map<String, String> getCustomUserAttributes();
46  
47      public void addPortletFilter(PortletFilter portletFilter);
48  
49      public PortletFilter getPortletFilter(String filterName);
50  
51      public Set<PortletFilter> getPortletFilters();
52  
53      public String getDefaultNamespace();
54  
55      public void setDefaultNamespace(String defaultNamespace);
56  
57      public void addEventDefinition(EventDefinition eventDefinition);
58  
59      public void addPublicRenderParameter(
60          PublicRenderParameter publicRenderParameter);
61  
62      public PublicRenderParameter getPublicRenderParameter(String identifier);
63  
64      public void addPortletURLListener(PortletURLListener portletURLListener);
65  
66      public PortletURLListener getPortletURLListener(String listenerClass);
67  
68      public Set<PortletURLListener> getPortletURLListeners();
69  
70      public Map<String, String[]> getContainerRuntimeOptions();
71  
72      public SpriteImage getSpriteImage(String fileName);
73  
74      public void setSpriteImages(String spriteFileName, Properties properties);
75  
76      public boolean isWARFile();
77  
78  }