liferay-resource-action-mapping_7_3_0.dtd: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES

liferay-resource-action-mapping_7_3_0.dtd

<!DOCTYPE resource-action-mapping PUBLIC "-//Liferay//DTD Resource Action Mapping 7.3.0//EN" "http://www.liferay.com/dtd/liferay-resource-action-mapping_7.3.0.dtd">



<resource-action-mapping> Root element

The resource-action-mapping is the root of the deployment descriptor for a resource action descriptor that is used to define actions that are supported on portal resources such as portlets and models.

<resource-action-mapping>'s children
NameCardinality
model-resourceAny number
portlet-resourceAny number
resourceAny number
Element's model:

(portlet-resource*, model-resource*, resource*)


<portlet-resource> Child of resource-action-mapping

The portlet-resource element defines the permissions of the portlet.

<portlet-resource>'s children
NameCardinality
permissionsOne or none
portlet-nameOnly one
Element's model:

(portlet-name, permissions?)


<portlet-name> Child of portlet-resource, portlet-ref

The portlet-name element is the name of the portlet.


<permissions> Child of portlet-resource, model-resource

The permissions element defines the default permissions granted and unsupported to community members, guests users, and layout managers.

<permissions>'s children
NameCardinality
community-defaultsOne or none
guest-defaultsOne or none
guest-unsupportedOne or none
layout-managerOne or none
owner-defaultsOne or none
site-member-defaultsOne or none
supportsOnly one
Element's model:

(supports, (community-defaults | site-member-defaults)?, guest-defaults?, guest-unsupported?, layout-manager?, owner-defaults?)


<supports> Child of permissions

The supports element defines the actions supported by this resource.

<supports>'s children
NameCardinality
action-keyAny number
Element's model:

(action-key*)


<action-key> Child of site-member-defaults, supports, guest-defaults, layout-manager, community-defaults, owner-defaults, guest-unsupported

The action-key element defines the name of the action. The name will be translated as specified in Language.properties. For example, if the action key is "VIEW", then the key in Language.properties will be "action.VIEW".


<community-defaults> Child of permissions

The community-defaults element specifies the actions that community members are permitted to perform by default. This element is deprecated and will be deleted in future versions. Use the site-member-defaults element instead.

<community-defaults>'s children
NameCardinality
action-keyAny number
Element's model:

(action-key*)


<site-member-defaults> Child of permissions

The site-defaults element specifies the actions that site members are permitted to perform by default.

<site-member-defaults>'s children
NameCardinality
action-keyAny number
Element's model:

(action-key*)


<guest-defaults> Child of permissions

The guest-defaults element specifies the actions that guest users are permitted to perform by default.

<guest-defaults>'s children
NameCardinality
action-keyAny number
Element's model:

(action-key*)


<guest-unsupported> Child of permissions

The guest-unsupported element specifies the actions that guests are never permitted to perform. This disables the ability to assign permissions for these actions. Only define actions here if you wish to prevent anyone from granting permissions to perform these actions.

<guest-unsupported>'s children
NameCardinality
action-keyAny number
Element's model:

(action-key*)


<layout-manager> Child of permissions

The layout-manager element specifies the actions that layout managers are permitted to perform. If omitted, then layout-managers are granted permissions on all supported actions. If included, then layout managers can only perform actions specified in this element.

<layout-manager>'s children
NameCardinality
action-keyAny number
Element's model:

(action-key*)


<owner-defaults> Child of permissions

The owner-defaults element specifies the actions that the creator of the resource is permitted to perform. If omitted, then owners are granted permissions on all supported actions.

<owner-defaults>'s children
NameCardinality
action-keyAny number
Element's model:

(action-key*)


<model-resource> Child of resource-action-mapping

The model-resource element defines the permissions of the model.

<model-resource>'s children
NameCardinality
composite-model-nameOne or none
model-nameOne or none
permissionsOne or none
portlet-refOnly one
rootOne or none
weightOne or none
<model-resource>'s attributes
NameValuesDefault
organization
portal
Element's model:

((composite-model-name | model-name), portlet-ref, root?, weight?, permissions?)


@organization Attribute of model-resource

The organization value specifies if the model resource is an organization model resource. The default value is false.


@portal Attribute of model-resource

The portal value specifies if the model resource is a portal model resource. The default value is false.


<composite-model-name> Child of model-resource

The composite-model-name element groups multiple model names together, which generates a dash separated list of model names.

<composite-model-name>'s children
NameCardinality
model-nameAt least one
Element's model:

(model-name+)


<model-name> Child of composite-model-name, model-resource

The model-name element is the name of the model.


<portlet-ref> Child of model-resource

The portlet-ref element is the name of the portlet that the model belongs to.

<portlet-ref>'s children
NameCardinality
portlet-nameAny number
Element's model:

(portlet-name*)


<root> Child of model-resource

The root element is a boolean value that specifies whether the resource is a root model resource. A root resource is the one that contains all other resources within a portlet.


<weight> Child of model-resource

The weight element is a double number to control the position of the resource in the permission GUIs. Higher values mean that the resource will appear lower.


<resource/> Child of resource-action-mapping

The resource element specifies an external file that contains resource-action-mappings.

<resource>'s attributes
NameValuesDefault
file

This element is always empty.


@file Attribute of resource

The file value specifies the external file that should be loaded to define resource actions.

Required