org.apache.cocoon.portal.tools
Class PortalToolManager

java.lang.Object
  extended by org.apache.cocoon.portal.tools.PortalToolManager
All Implemented Interfaces:
Disposable, Component, Parameterizable, Serviceable, ThreadSafe

public class PortalToolManager
extends Object
implements ThreadSafe, Component, Parameterizable, Serviceable, Disposable

Version:
CVS $Id: PortalToolManager.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary
protected  SourceResolver resolver
          The source resolver
static String ROLE
           
 
Constructor Summary
PortalToolManager()
           
 
Method Summary
 void dispose()
           
 Configuration getConfiguration()
          Returns the Configuration for the plugins
 List getI18n()
           
 PortalObjects getPortalObjects()
           
 PortalTool getTool(String id)
          Returns the tool with the id.
 Collection getTools()
          Returns a Collection of all Tools
 Collection getToolsWithFunctions()
          Returns a Collection of tools which offers functions
 UserRightsService getUserRightsService()
           
 void init()
          Initializes the PortalToolManager.
 void parameterize(Parameters para)
           
 void releasePortalObjects(PortalObjects pObj)
           
 void saveConfiguration()
          Saves the configuration
 void service(ServiceManager manager)
           
 String sGet(String key)
          Returns a value from the auth context
 void sSet(String key, String value)
          Sets a value in the auth context
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ROLE

public static final String ROLE

resolver

protected SourceResolver resolver
The source resolver

Constructor Detail

PortalToolManager

public PortalToolManager()
Method Detail

parameterize

public void parameterize(Parameters para)
                  throws ParameterException
Specified by:
parameterize in interface Parameterizable
Throws:
ParameterException

init

public void init()
          throws ProcessingException,
                 IOException
Initializes the PortalToolManager. Reads the configuration of all plugins etc.

Throws:
ProcessingException
IOException

getTools

public Collection getTools()
Returns a Collection of all Tools


getTool

public PortalTool getTool(String id)
Returns the tool with the id.

Parameters:
id - Tool-Id

getToolsWithFunctions

public Collection getToolsWithFunctions()
Returns a Collection of tools which offers functions


getI18n

public List getI18n()

service

public void service(ServiceManager manager)
             throws ServiceException
Specified by:
service in interface Serviceable
Throws:
ServiceException

getConfiguration

public Configuration getConfiguration()
Returns the Configuration for the plugins


saveConfiguration

public void saveConfiguration()
Saves the configuration


getUserRightsService

public UserRightsService getUserRightsService()

sGet

public String sGet(String key)
Returns a value from the auth context

Parameters:
key - Path (e.g. /foo/bar)

sSet

public void sSet(String key,
                 String value)
Sets a value in the auth context

Parameters:
key - Path (e.g. /foo/bar)
value - Value

dispose

public void dispose()
Specified by:
dispose in interface Disposable

getPortalObjects

public PortalObjects getPortalObjects()

releasePortalObjects

public void releasePortalObjects(PortalObjects pObj)


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.