Author: julien(a)jboss.com Date: 2007-02-12 17:43:14 -0500 (Mon, 12 Feb 2007) New Revision: 6236 Modified: docs/trunk/referenceGuide/en/modules/security.xml Log: added DTD whenever possible in security section + monkey cosmetic Modified: docs/trunk/referenceGuide/en/modules/security.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/security.xml 2007-02-12 22:39:38 UTC (rev 6235) +++ docs/trunk/referenceGuide/en/modules/security.xml 2007-02-12 22:43:14 UTC (rev 6236) @@ -30,10 +30,13 @@ <emphasis>&lt;security-constraint&gt;</emphasis> tag: <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE deployments PUBLIC + "-//JBoss Portal//DTD Portal Object 2.6//EN" + "http://www.jboss.org/portal/dtd/portal-object_2_6.dtd"> <deployments> <deployment> + <parent-ref>default</parent-ref> <if-exists>overwrite</if-exists> - <parent-ref>default</parent-ref> <properties/> <page> <page-name>MyPage</page-name> @@ -45,14 +48,13 @@ </window> <security-constraint> <policy-permission> + <action-name>viewrecursive</action-name> <unchecked/> - <action-name>viewrecursive</action-name> </policy-permission> </security-constraint> </page> </deployment> -</deployments>]]> - </programlisting> +</deployments>]]></programlisting> </para> <para> A security constraint on an object (our example above, secures a specific portal page), is explained as: @@ -194,13 +196,13 @@ <para> The <emphasis>org.jboss.portal.security.spi.provider.AuthorizationDomain</emphasis> is an interface which provides access to several services. <programlisting> - public interface AuthorizationDomain - { - String getType(); - DomainConfigurator getConfigurator(); - PermissionRepository getPermissionRepository(); - PermissionFactory getPermissionFactory(); - } +public interface AuthorizationDomain +{ + String getType(); + DomainConfigurator getConfigurator(); + PermissionRepository getPermissionRepository(); + PermissionFactory getPermissionFactory(); +} </programlisting> <itemizedlist> <listitem><emphasis>org.jboss.portal.security.spi.provider.DomainConfigurator</emphasis> provides configuration access @@ -235,10 +237,12 @@ ... </mbean> ... -</server>]]> - </programlisting> +</server>]]></programlisting> <para>It be injected in the servlet context of a war file in the file <emphasis>WEB-INF/jboss-portlet.xml</emphasis></para> <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE portlet-app PUBLIC + "-//JBoss Portal//DTD JBoss Portlet 2.6//EN" + "http://www.jboss.org/portal/dtd/jboss-portlet_2_6.dtd"> <portlet-app> ... <service> @@ -247,8 +251,7 @@ <service-ref>:service=PortalAuthorizationManagerFactory</service-ref> </service> ... -</portlet-app>]]> - </programlisting> +</portlet-app>]]></programlisting> <para>Here is an example of how a security check is made for a specific page</para> <programlisting> PortalAuthorizationManager pam = factory.getManager(); @@ -257,20 +260,18 @@ if (pam.checkPermission(perm) == false) { System.out.println("Current is not authorization to view page " + id); -} - </programlisting> +}</programlisting> </sect2> <sect2> <title>Configuring an authorization domain</title> <para>Configuring a domain can be done through the <emphasis>DomainConfigurator</emphasis> interface</para> <programlisting> - public interface DomainConfigurator - { - Set getSecurityBindings(String uri); - void setSecurityBindings(String uri, Set securityBindings) throws SecurityConfigurationException; - void removeSecurityBindings(String uri) throws SecurityConfigurationException; - } - </programlisting> +public interface DomainConfigurator +{ + Set getSecurityBindings(String uri); + void setSecurityBindings(String uri, Set securityBindings) throws SecurityConfigurationException; + void removeSecurityBindings(String uri) throws SecurityConfigurationException; +}</programlisting> <para>The various methods of that interface allows to configure security bindings for a given resource where a resource is naturally identified by an URI. The <emphasis>org.jboss.portal.security.RoleSecurityBinding</emphasis> object is an object which encapsulate a role name and a set of actions bound to this role. @@ -281,8 +282,7 @@ Set bindings = new HashSet(); bindings.add(binding1); bindings.add(binding2); -configurator.setSecurityBinding(pageURI, bindings); - </programlisting> +configurator.setSecurityBinding(pageURI, bindings); </programlisting> </sect2> </sect1> </chapter> \ No newline at end of file