Return-Path: 
 <docs-return-6121-apmail-cocoon-docs-archive=cocoon.apache.org@cocoon.apache.org>
Delivered-To: apmail-cocoon-docs-archive@www.apache.org
Received: (qmail 3221 invoked from network); 28 Jan 2005 10:36:05 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
  by minotaur-2.apache.org with SMTP; 28 Jan 2005 10:36:05 -0000
Received: (qmail 99725 invoked by uid 500); 28 Jan 2005 10:36:03 -0000
Delivered-To: apmail-cocoon-docs-archive@cocoon.apache.org
Received: (qmail 99682 invoked by uid 500); 28 Jan 2005 10:36:03 -0000
Mailing-List: contact docs-help@cocoon.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:docs-help@cocoon.apache.org>
list-unsubscribe: <mailto:docs-unsubscribe@cocoon.apache.org>
list-post: <mailto:docs@cocoon.apache.org>
Reply-To: docs@cocoon.apache.org
Delivered-To: mailing list docs@cocoon.apache.org
Received: (qmail 99657 invoked by uid 99); 28 Jan 2005 10:36:03 -0000
X-ASF-Spam-Status: No, hits=-9.8 required=10.0
	tests=ALL_TRUSTED,NO_REAL_NAME
X-Spam-Check-By: apache.org
Received: from minotaur.apache.org (HELO minotaur.apache.org)
 (209.237.227.194)
  by apache.org (qpsmtpd/0.28) with SMTP; Fri, 28 Jan 2005 02:36:03 -0800
Received: (qmail 3059 invoked from network); 28 Jan 2005 10:36:01 -0000
Received: from localhost.hyperreal.org (HELO minotaur.apache.org) (127.0.0.1)
  by localhost.hyperreal.org with SMTP; 28 Jan 2005 10:36:01 -0000
Content-Type: text/plain; charset="iso-8859-1"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
From: docs@cocoon.apache.org
To: docs@cocoon.apache.org
Subject: =?iso-8859-1?q?=5BCocoon_Wiki=5D_New=3A__PortalToolManager?=
Date: Fri, 28 Jan 2005 10:36:01 -0000
Message-ID: <20050128103601.3021.94123@minotaur.apache.org>
X-Spam-Rating: localhost.hyperreal.org 1.6.2 0/1000/N
X-Virus-Checked: Checked
X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N

   Date: 2005-01-28T02:36:01
   Editor: JensMaukisch
   Wiki: Cocoon Wiki
   Page: PortalToolManager
   URL: http://wiki.apache.org/cocoon/PortalToolManager

   no comment

New Page:

=3D PortalToolManager =3D

The PortalToolManager is the main component of the PortalTools. It holds in=
formation about all plugins an possilby about their configurations. Further=
more it gives you easy access to all required PortalObjects. Most of the fu=
nctions are not used by the tool-developer, inside a plugin it normally jus=
t used to access the PortalObjects (via Flow).

=3D=3D Configuration =3D=3D

The PortalToolManager is a cocoon component and must be configured in the c=
ocoon.xconf. It's almost the only configuration you have to do if you add t=
he PortalTools to an existing portal.

{{{cocoon.xconf}}}:
{{{
  <component class=3D"org.apache.cocoon.portal.tools.PortalToolManager" rol=
e=3D"org.apache.cocoon.portal.tools.PortalToolManager">
   <parameter name=3D"root" value=3D"context://samples/blocks/portal/tools/=
"/>
   <parameter name=3D"conf" value=3D"conf.xml"/>
   <parameter name=3D"auth" value=3D"auth.xml"/>
 </component>
}}}

Parameters:
{{{root}}}: root directory of the PortalTools[[BR]]
{{{conf}}}: name of the configuration file[[BR]]
{{{auth}}}: name of the authentication file

=3D=3D Important Methods =3D=3D

''getConfiguration(String path)'': returns a configuration object for the s=
pecified path[[BR]]
''saveConfiguration()'': saves the configuration[[BR]]
''sGet(String path)'': Gets the value of the specified path from the authen=
tication-context.[[BR]]
''sSet(String path, String value)'': Stores the specified value under the p=
ath in the authentication-context.[[BR]]
''getPortalObjects()'': returns a PortalObjects object which provides easy =
access to the important portal objects[[BR]]
''releasePortalObjects(PortalObjects)'': releases a PortalObjects object[[B=
R]]

For more information have a look at the source.

=3D=3D Sample =3D=3D
How to use the PortalToolManager in Flow:

{{{
  function editCoplet() {
    var toolManager =3D getPTM();
    var portalObjects =3D toolManager.getPortalObjects();
    var portalLayout =3D portalObjects.getPortalLayout();
    // Do something
    toolManager.releasePortalObjects(portalObjects);
    relPTM(toolManager);
  }
}}}