Author: bdaw
Date: 2007-05-02 03:45:43 -0400 (Wed, 02 May 2007)
New Revision: 7170
Modified:
trunk/core/src/resources/portal-core-sar/dtd/portal-object_2_6.dtd
trunk/core/src/resources/portal-core-sar/dtd/portlet-instances_2_6.dtd
Log:
- update XML comments in dtd files
Modified: trunk/core/src/resources/portal-core-sar/dtd/portal-object_2_6.dtd
===================================================================
--- trunk/core/src/resources/portal-core-sar/dtd/portal-object_2_6.dtd 2007-05-02 05:43:03
UTC (rev 7169)
+++ trunk/core/src/resources/portal-core-sar/dtd/portal-object_2_6.dtd 2007-05-02 07:45:43
UTC (rev 7170)
@@ -259,21 +259,46 @@
<!ELEMENT value (#PCDATA)>
<!--
+The security-constraint element is a container for policy-permission elements
+
+Examples:
+
+<security-constraint>
+ <policy-permission>
+ <role-name>User</role-name>
+ <action-name>view</action-name>
+ </policy-permission>
+</security-constraint>
+
+<security-constraint>
+ <policy-permission>
+ <unchecked/>
+ <action-name>view</action-name>
+ </policy-permission>
+</security-constraint>
-->
<!ELEMENT security-constraint (policy-permission*)>
<!--
+The policy-permission element is used to secure a specific portal page based on a
user's role.
-->
<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>
<!--
+The role-name element is used to define a role that this security constraint will apply
to
+
+ * <role-name>SOMEROLE</role-name> Access to this portal page is limited
to the defined role.
-->
<!ELEMENT action-name (#PCDATA)>
<!--
+The unchecked element is used to define (if present) that anyone can view this portal
page
-->
<!ELEMENT unchecked EMPTY>
<!--
+The action-name element is used to define the access rights given to the role defined.
Possible values are:
+
+ * view - Users can view the page.
-->
<!ELEMENT role-name (#PCDATA)>
Modified: trunk/core/src/resources/portal-core-sar/dtd/portlet-instances_2_6.dtd
===================================================================
--- trunk/core/src/resources/portal-core-sar/dtd/portlet-instances_2_6.dtd 2007-05-02
05:43:03 UTC (rev 7169)
+++ trunk/core/src/resources/portal-core-sar/dtd/portlet-instances_2_6.dtd 2007-05-02
07:45:43 UTC (rev 7170)
@@ -40,6 +40,10 @@
<!ELEMENT deployment (if-exists?,instance)>
<!--
+The if-exists element is used to define action to take if instance with such name is
already present.
+Possible values are overwrite or keep . Overwrite will destroy the existing object in
the database
+and create a new one, based on the content of the deployment. Keep will maintain the
existing object
+deployment or create a new one if it does not yet exist.
-->
<!ELEMENT if-exists (#PCDATA)>
@@ -102,26 +106,49 @@
<!ELEMENT value (#PCDATA)>
<!--
-todo
+The security-constraint element is a container for policy-permission elements
+
+Examples:
+
+<security-constraint>
+ <policy-permission>
+ <role-name>User</role-name>
+ <action-name>view</action-name>
+ </policy-permission>
+</security-constraint>
+
+<security-constraint>
+ <policy-permission>
+ <unchecked/>
+ <action-name>view</action-name>
+ </policy-permission>
+</security-constraint>
-->
<!ELEMENT security-constraint (policy-permission*)>
<!--
-todo
+The policy-permission element is used to secure a specific portlet instance based on a
user's role.
-->
<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>
<!--
-todo
+The action-name element is used to define the access rights given to the role defined.
Possible values are:
+
+ * view - Users can view the page.
+ * viewrecursive - Users can view the page and child pages.
+ * personalize - Users are able to view AND personalize the page.
+ * personalizerecursive - Users are able to view AND personalize the page AND its
child pages.
-->
<!ELEMENT action-name (#PCDATA)>
<!--
-todo
+The unchecked element is used to define (if present) that anyone can view this instance
-->
<!ELEMENT unchecked EMPTY>
<!--
-todo
+The role-name element is used to define a role that this security constraint will apply
to
+
+ * <role-name>SOMEROLE</role-name> Access to this instance is limited to
the defined role.
-->
<!ELEMENT role-name (#PCDATA)>
Show replies by date