001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.security.permission;
016    
017    import com.liferay.portal.NoSuchResourceActionException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.Group;
020    import com.liferay.portal.model.Permission;
021    import com.liferay.portal.model.Portlet;
022    import com.liferay.portal.model.Role;
023    import com.liferay.portlet.social.model.SocialEquityActionMapping;
024    
025    import java.io.InputStream;
026    
027    import java.util.List;
028    import java.util.Locale;
029    
030    import javax.servlet.jsp.PageContext;
031    
032    /**
033     * @author Brian Wing Shun Chan
034     * @author Daeyoung Song
035     */
036    public interface ResourceActions {
037    
038            public void checkAction(String name, String actionId)
039                    throws NoSuchResourceActionException;
040    
041            public String getAction(Locale locale, String action);
042    
043            public String getAction(PageContext pageContext, String action);
044    
045            public String getActionNamePrefix();
046    
047            public List<String> getActions(List<Permission> permissions);
048    
049            public List<String> getActionsNames(
050                    PageContext pageContext, List<String> actions);
051    
052            public List<String> getActionsNames(
053                    PageContext pageContext, String name, long actionIds);
054    
055            public List<String> getModelNames();
056    
057            public List<String> getModelPortletResources(String name);
058    
059            public String getModelResource(Locale locale, String name);
060    
061            public String getModelResource(PageContext pageContext, String name);
062    
063            public List<String> getModelResourceActions(String name);
064    
065            public List<String> getModelResourceGroupDefaultActions(String name);
066    
067            public List<String> getModelResourceGuestDefaultActions(String name);
068    
069            public List<String> getModelResourceGuestUnsupportedActions(String name);
070    
071            public String getModelResourceNamePrefix();
072    
073            public List<String> getModelResourceOwnerDefaultActions(String name);
074    
075            public String[] getOrganizationModelResources();
076    
077            public String[] getPortalModelResources();
078    
079            public String getPortletBaseResource(String portletName);
080    
081            public List<String> getPortletModelResources(String portletName);
082    
083            public List<String> getPortletNames();
084    
085            public List<String> getPortletResourceActions(Portlet portlet);
086    
087            public List<String> getPortletResourceActions(String name);
088    
089            public List<String> getPortletResourceGroupDefaultActions(String name);
090    
091            public List<String> getPortletResourceGuestDefaultActions(String name);
092    
093            public List<String> getPortletResourceGuestUnsupportedActions(String name);
094    
095            public List<String> getPortletResourceLayoutManagerActions(String name);
096    
097            public List<String> getResourceActions(String name);
098    
099            public List<String> getResourceActions(
100                    String portletResource, String modelResource);
101    
102            public List<String> getResourceGroupDefaultActions(String name);
103    
104            public List<String> getResourceGuestUnsupportedActions(
105                    String portletResource, String modelResource);
106    
107            /**
108             * @deprecated {@link #getRoles(long, Group, String, int[])}
109             */
110            public List<Role> getRoles(
111                            long companyId, Group group, String modelResource)
112                            throws SystemException;
113    
114            public List<Role> getRoles(
115                            long companyId, Group group, String modelResource, int[] roleTypes)
116                    throws SystemException;
117    
118            public SocialEquityActionMapping getSocialEquityActionMapping(
119                    String name, String actionId);
120    
121            public List<SocialEquityActionMapping> getSocialEquityActionMappings(
122                    String name);
123    
124            public String[] getSocialEquityClassNames();
125    
126            public boolean hasModelResourceActions(String name);
127    
128            public boolean isOrganizationModelResource(String modelResource);
129    
130            public boolean isPortalModelResource(String modelResource);
131    
132            public void read(
133                            String servletContextName, ClassLoader classLoader, String source)
134                    throws Exception;
135    
136            public void read(String servletContextName, InputStream inputStream)
137                    throws Exception;
138    
139    }