com.liferay.portal.security.permission.ResourceActions Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
There is a newer version: 7.0.0-nightly
Show newest version
/**
 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.security.permission;

import com.liferay.portal.NoSuchResourceActionException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.model.Group;
import com.liferay.portal.model.Organization;
import com.liferay.portal.model.PasswordPolicy;
import com.liferay.portal.model.Portlet;
import com.liferay.portal.model.Role;
import com.liferay.portal.model.User;
import com.liferay.portal.model.UserGroup;
import com.liferay.portlet.expando.model.ExpandoColumn;

import java.io.InputStream;

import java.util.List;
import java.util.Locale;

import javax.servlet.jsp.PageContext;

/**
 * @author Brian Wing Shun Chan
 * @author Daeyoung Song
 */
public interface ResourceActions {

	/**
	 * @deprecated As of 6.2.0, replaced by {@link #getActionNamePrefix}
	 */
	public static final String ACTION_NAME_PREFIX = "action.";

	/**
	 * @deprecated As of 6.2.0, replaced by {@link #getModelResourceNamePrefix}
	 */
	public static final String MODEL_RESOURCE_NAME_PREFIX = "model.resource.";

	/**
	 * @deprecated As of 6.2.0, replaced by {@link
	 *             #getOrganizationModelResources}
	 */
	public static final String[] ORGANIZATION_MODEL_RESOURCES = {
		Organization.class.getName(), PasswordPolicy.class.getName(),
		User.class.getName()
	};

	/**
	 * @deprecated As of 6.2.0, replaced by {@link #getPortalModelResources}
	 */
	public static final String[] PORTAL_MODEL_RESOURCES = {
		ExpandoColumn.class.getName(), Organization.class.getName(),
		PasswordPolicy.class.getName(), Role.class.getName(),
		User.class.getName(), UserGroup.class.getName()
	};

	public void checkAction(String name, String actionId)
		throws NoSuchResourceActionException;

	public String getAction(Locale locale, String action);

	public String getAction(PageContext pageContext, String action);

	public String getActionNamePrefix();

	public List getActionsNames(
		PageContext pageContext, List actions);

	public List getActionsNames(
		PageContext pageContext, String name, long actionIds);

	public List getModelNames();

	public List getModelPortletResources(String name);

	public String getModelResource(Locale locale, String name);

	public String getModelResource(PageContext pageContext, String name);

	public List getModelResourceActions(String name);

	public List getModelResourceGroupDefaultActions(String name);

	public List getModelResourceGuestDefaultActions(String name);

	public List getModelResourceGuestUnsupportedActions(String name);

	public String getModelResourceNamePrefix();

	public List getModelResourceOwnerDefaultActions(String name);

	public Double getModelResourceWeight(String name);

	public String[] getOrganizationModelResources();

	public String[] getPortalModelResources();

	public String getPortletBaseResource(String portletName);

	public List getPortletModelResources(String portletName);

	public List getPortletNames();

	public List getPortletResourceActions(Portlet portlet);

	public List getPortletResourceActions(String name);

	public List getPortletResourceGroupDefaultActions(String name);

	public List getPortletResourceGuestDefaultActions(String name);

	public List getPortletResourceGuestUnsupportedActions(String name);

	public List getPortletResourceLayoutManagerActions(String name);

	public String getPortletRootModelResource(String portletName);

	public List getResourceActions(String name);

	public List getResourceActions(
		String portletResource, String modelResource);

	public List getResourceGroupDefaultActions(String name);

	public List getResourceGuestUnsupportedActions(
		String portletResource, String modelResource);

	/**
	 * @deprecated As of 6.1.0, replaced by {@link #getRoles(long, Group,
	 *             String, int[])}
	 */
	public List getRoles(
			long companyId, Group group, String modelResource)
		throws SystemException;

	public List getRoles(
			long companyId, Group group, String modelResource, int[] roleTypes)
		throws SystemException;

	public boolean hasModelResourceActions(String name);

	public boolean isOrganizationModelResource(String modelResource);

	public boolean isPortalModelResource(String modelResource);

	public void read(
			String servletContextName, ClassLoader classLoader, String source)
		throws Exception;

	public void read(String servletContextName, InputStream inputStream)
		throws Exception;

}