org.apache.jetspeed.services.portaltoolkit
Interface PortalToolkitService

All Superinterfaces:
org.apache.turbine.services.Initable, org.apache.turbine.services.Service
All Known Implementing Classes:
JetspeedPortalToolkitService

public interface PortalToolkitService
extends org.apache.turbine.services.Service

This service is a Factory for creating new Portal objects from named Registry entries or PSML configuration entries. It handles all the portal specific objects except Portlet which are handled by a separate PortletFactory service

Version:
$Id: PortalToolkitService.java,v 1.6 2005/03/21 18:21:43 sgala Exp $
Author:
RaphaŽl Luta

Field Summary
static java.lang.String SERVICE_NAME
          The default control to use when none is specified
 
Method Summary
 PortletControl getControl(Control control)
          Instanciates a PortletControl based on a PSML Control object
 PortletControl getControl(java.lang.String name)
          Instanciates a PortletControl based on a Registry entry, if available or directly from a classname.
 PortletController getController(Controller controller)
          Instanciates a PortletController based on a PSML Controller object
 PortletController getController(java.lang.String name)
          Instanciates a PortletController based on a Registry entry, if available or directly from a classname.
 SecurityReference getDefaultSecurityRef(Profile profile)
          Gets default security ref based on the profile type (user|role|group).
 SecurityReference getDefaultSecurityRef(java.lang.String type)
          Gets default security ref based on the profile type (user|role|group).
 Portlets getReference(java.lang.String locatorPath)
          Given a locator String path, returns a Portlets collecton
 PortletSet getSet(Portlets portlets)
          Creates a PortletSet from a PSML portlets description
 PortletSkin getSkin(Skin skin)
          Create a PortletSkin object based on PSML skin description
 PortletSkin getSkin(java.lang.String name)
          Create a PortletSkin object based on a Registry entry if available
 
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getName, getProperties, setName, setServiceBroker
 
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, init, setInitableBroker, shutdown
 

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME
The default control to use when none is specified

See Also:
Constant Field Values
Method Detail

getControl

public PortletControl getControl(java.lang.String name)
Instanciates a PortletControl based on a Registry entry, if available or directly from a classname.

Parameters:
name - a PortletControl name available in the registry or a classname
Returns:
the created PortletControl

getControl

public PortletControl getControl(Control control)
Instanciates a PortletControl based on a PSML Control object

Parameters:
control - the PSML control object
Returns:
the created PortletControl

getController

public PortletController getController(java.lang.String name)
Instanciates a PortletController based on a Registry entry, if available or directly from a classname.

Parameters:
name - a PortletController name available in the registry or a classname
Returns:
the created PortletController

getController

public PortletController getController(Controller controller)
Instanciates a PortletController based on a PSML Controller object

Returns:
the created PortletController

getSkin

public PortletSkin getSkin(java.lang.String name)
Create a PortletSkin object based on a Registry entry if available

Parameters:
name - the skin name in the Registry
Returns:
the new PortletSkin object

getSkin

public PortletSkin getSkin(Skin skin)
Create a PortletSkin object based on PSML skin description

Parameters:
skin - the PSML Skin object
Returns:
the new PortletSkin object

getSet

public PortletSet getSet(Portlets portlets)
Creates a PortletSet from a PSML portlets description

Parameters:
portlets - the PSML portlet set description
Returns:
a new instance of PortletSet

getReference

public Portlets getReference(java.lang.String locatorPath)
Given a locator String path, returns a Portlets collecton

Parameters:
locatorPath - ProfileLocator resource path identifier
Returns:
a portlets collection from the PSML resource

getDefaultSecurityRef

public SecurityReference getDefaultSecurityRef(Profile profile)
Gets default security ref based on the profile type (user|role|group). Returns null if no default is defined.

Parameters:
profile -
Returns:
default security reference

getDefaultSecurityRef

public SecurityReference getDefaultSecurityRef(java.lang.String type)
Gets default security ref based on the profile type (user|role|group). Returns null if no default is defined.

Parameters:
type - of entity to return default security ref for
Returns:
default security reference


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.