org.apache.jetspeed.services
Class PortalToolkit

java.lang.Object
  org.apache.jetspeed.services.PortalToolkit

public class PortalToolkit

extends java.lang.Object

Commodity static wrapper around the PortalToolit service

Version:

$Id: PortalToolkit.java,v 1.6 2005/03/21 18:21:43 sgala Exp $

Author:

Raphaël Luta

Constructor Summary

PortalToolkit()

Method Summary

static PortletControl	getControl(Control control) Instanciates a PortletControl based on a PSML Control object
static PortletControl	getControl(java.lang.String name) Instanciates a PortletControl based on a Registry entry, if available or directly from a classname.
static PortletController	getController(Controller controller) Instanciates a PortletController based on a PSML Controller object
static PortletController	getController(java.lang.String name) Instanciates a PortletController based on a Registry entry, if available or directly from a classname.
static SecurityReference	getDefaultSecurityRef(Profile profile) Gets default security ref based on the profile type (user|role|group).
static SecurityReference	getDefaultSecurityRef(java.lang.String type) Gets default security ref based on the profile type (user|role|group).
static Portlets	getReference(java.lang.String locatorPath) Given a locator String path, returns a Portlets collecton
static PortletSet	getSet(Portlets portlets) Creates a PortletSet from a PSML portlets description
static PortletSkin	getSkin(Skin skin) Create a PortletSkin object based on PSML skin description
static PortletSkin	getSkin(java.lang.String name) Create a PortletSkin object based on a Registry entry if available

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortalToolkit

public PortalToolkit()

Method Detail

getControl

public static 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 static 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 static 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 static PortletController getController(Controller controller)

Instanciates a PortletController based on a PSML Controller object

Returns:

the created PortletController

getSkin

public static 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 static 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 static 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 static 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 static 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 static 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