de.innovationgate.webgate.api

Class WGTransientPortletRegistry

java.lang.Object

de.innovationgate.webgate.api.WGPortletRegistry

de.innovationgate.webgate.api.WGTransientPortletRegistry

All Implemented Interfaces:

de.innovationgate.wga.common.ImmutableObject

public class WGTransientPortletRegistry
extends WGPortletRegistry
implements de.innovationgate.wga.common.ImmutableObject

A transient portlet registry which is able to store portlet items on the given profiles portlet item storage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WGTransientPortletRegistry.RootPortletInformation

Constructor Summary

Constructors

Constructor and Description
WGTransientPortletRegistry(WGDatabase parent, WGUserProfile profile)

Method Summary

Methods

Modifier and Type	Method and Description
WGPortlet	createPortlet(java.lang.String appDb, WGPortlet parent) Creates a new portlet object that is not yet registered.
java.lang.String	getApplicationId(WGDatabase db) Returns the string ID that should be passed to the methods of this portlet registry to identify the given database
java.util.List<WGPortlet>	getChildPortlets(WGPortlet portlet) Returns the child portlets for the given parent portlet
java.util.List<java.lang.String>	getItemNames(WGPortlet portlet) Returns the names of all portlet items for the given portlet
java.lang.Object	getItemValue(WGPortlet portlet, java.lang.String name) Returns the value of a portlet item
WGPortlet	getOrCreateRootPortlet(java.lang.String appDb) Returns the root portlet for the database of the given dbkey.
WGPortlet	getPortlet(java.lang.String appDb, java.lang.String key) Returns the portlet for the given key.
WGPortlet	getPortletByName(java.lang.String appDb, WGPortlet parentPortlet, java.lang.String name) Returns the portlet for the given name under the given parent portlet.
boolean	hasItem(WGPortlet portlet, java.lang.String name) Tests if the given portlet has a portlet item of the given name
void	insertPortlet(WGPortlet portlet) Inserts a new portlet to the registry
boolean	isTransient() Returns if the registry is transient, and it is not to expect that a new request will reproduce once registered portlets
void	prepareNewProfile(WGUserProfile profile) Takes a newly created user profile to do some eventually neccessary initialisations on it This is called on each new user profile so the registry has a chance to initialise it if neccessary.
void	preSaveProfile(WGUserProfile profile) Called immediately before a user profile is saved, so that the portlet registry may do some work necessary before saving
void	removeItem(WGPortlet portlet, java.lang.String name) Removes a portlet item
void	removePortlet(WGPortlet portlet) Removes the portlet of the given key from registry This method should: Remove all items registered for this portlet Remove the registration of the portlet from portlet registry Remove all child portlets the same way that this portlet was removed (including items and their child portlets)
void	setItemValue(WGPortlet portlet, java.lang.String name, java.lang.Object value) Sets the value of a portlet item, eventually creating it
void	updatePortlet(WGPortlet portlet) Updates an already registered portlet with the information given in the parameter portlet object

Methods inherited from class de.innovationgate.webgate.api.WGPortletRegistry

clearItems

Methods inherited from class java.lang.Object

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

Constructor Detail

WGTransientPortletRegistry

public WGTransientPortletRegistry(WGDatabase parent,
                          WGUserProfile profile)

Method Detail

insertPortlet

public void insertPortlet(WGPortlet portlet)
                   throws WGAPIException

Description copied from class: WGPortletRegistry

Inserts a new portlet to the registry

Specified by:

insertPortlet in class WGPortletRegistry

Parameters:

portlet - The portlet to insert. Must have been created via WGPortletRegistry.createPortlet(String, WGPortlet)

Throws:

WGAPIException

getPortlet

public WGPortlet getPortlet(java.lang.String appDb,
                   java.lang.String key)
                     throws WGAPIException

Description copied from class: WGPortletRegistry

Returns the portlet for the given key. Should also be able to retrieve root portlets by their key.

Specified by:

getPortlet in class WGPortletRegistry

Parameters:

appDb - Dbkey of the current application database

key - The portlet key

Throws:

WGAPIException

getPortletByName

public WGPortlet getPortletByName(java.lang.String appDb,
                         WGPortlet parentPortlet,
                         java.lang.String name)
                           throws WGAPIException

Description copied from class: WGPortletRegistry

Returns the portlet for the given name under the given parent portlet.

Specified by:

getPortletByName in class WGPortletRegistry

Parameters:

appDb - current application database

parentPortlet - The parent portlet of the portlet to retrieve

name - The name of the portlet

Throws:

WGAPIException

updatePortlet

public void updatePortlet(WGPortlet portlet)
                   throws WGAPIException

Description copied from class: WGPortletRegistry

Updates an already registered portlet with the information given in the parameter portlet object

Specified by:

updatePortlet in class WGPortletRegistry

Parameters:

portlet - The portlet object whose data is used to update the registration

Throws:

WGAPIException

removePortlet

public void removePortlet(WGPortlet portlet)
                   throws WGAPIException

Description copied from class: WGPortletRegistry

Removes the portlet of the given key from registry This method should:

• Remove all items registered for this portlet
• Remove the registration of the portlet from portlet registry
• Remove all child portlets the same way that this portlet was removed (including items and their child portlets)

Specified by:

removePortlet in class WGPortletRegistry

Parameters:

portlet - The portlet to be removed

Throws:

WGAPIException

getOrCreateRootPortlet

public WGPortlet getOrCreateRootPortlet(java.lang.String appDb)
                                 throws WGAPIException

Description copied from class: WGPortletRegistry

Returns the root portlet for the database of the given dbkey. May creates it if an id is given and the portlet does not yet exist. However that is a decision up to the registry.

Specified by:

getOrCreateRootPortlet in class WGPortletRegistry

Parameters:

appDb - The database whose root portlet is to be retrieved

Throws:

WGAPIException

prepareNewProfile

public void prepareNewProfile(WGUserProfile profile)
                       throws WGAPIException

Description copied from class: WGPortletRegistry

Takes a newly created user profile to do some eventually neccessary initialisations on it This is called on each new user profile so the registry has a chance to initialise it if neccessary. Registries who have no need for this may implement this method empty.

Specified by:

prepareNewProfile in class WGPortletRegistry

Parameters:

profile - The new profile

Throws:

WGAPIException

getChildPortlets

public java.util.List<WGPortlet> getChildPortlets(WGPortlet portlet)
                                           throws WGAPIException

Description copied from class: WGPortletRegistry

Returns the child portlets for the given parent portlet

Specified by:

getChildPortlets in class WGPortletRegistry

Parameters:

portlet - The parent portlet

Throws:

WGAPIException

createPortlet

public WGPortlet createPortlet(java.lang.String appDb,
                      WGPortlet parent)

Description copied from class: WGPortletRegistry

Creates a new portlet object that is not yet registered. To register portlets created by this method call WGPortletRegistry.insertPortlet(WGPortlet) giving it as parameter.

Specified by:

createPortlet in class WGPortletRegistry

Parameters:

appDb - The application database of the portlet

parent - The parent of the portlet to be created

isTransient

public boolean isTransient()
                    throws WGAPIException

Description copied from class: WGPortletRegistry

Returns if the registry is transient, and it is not to expect that a new request will reproduce once registered portlets

Specified by:

isTransient in class WGPortletRegistry

Throws:

WGAPIException

preSaveProfile

public void preSaveProfile(WGUserProfile profile)
                    throws WGAPIException

Description copied from class: WGPortletRegistry

Called immediately before a user profile is saved, so that the portlet registry may do some work necessary before saving

Specified by:

preSaveProfile in class WGPortletRegistry

Throws:

WGAPIException

getItemNames

public java.util.List<java.lang.String> getItemNames(WGPortlet portlet)
                                              throws WGAPIException

Description copied from class: WGPortletRegistry

Returns the names of all portlet items for the given portlet

Specified by:

getItemNames in class WGPortletRegistry

Parameters:

portlet - The portlet

Throws:

WGAPIException

hasItem

public boolean hasItem(WGPortlet portlet,
              java.lang.String name)
                throws WGAPIException

Description copied from class: WGPortletRegistry

Tests if the given portlet has a portlet item of the given name

Specified by:

hasItem in class WGPortletRegistry

Parameters:

portlet - The portlet

Throws:

WGAPIException

getItemValue

public java.lang.Object getItemValue(WGPortlet portlet,
                            java.lang.String name)
                              throws WGAPIException

Description copied from class: WGPortletRegistry

Returns the value of a portlet item

Specified by:

getItemValue in class WGPortletRegistry

Parameters:

portlet - The portlet whose item is to be retrieved

name - The name of the item

Returns:

The item value

Throws:

WGAPIException

setItemValue

public void setItemValue(WGPortlet portlet,
                java.lang.String name,
                java.lang.Object value)
                  throws WGAPIException

Description copied from class: WGPortletRegistry

Sets the value of a portlet item, eventually creating it

Specified by:

setItemValue in class WGPortletRegistry

Parameters:

portlet - The portlet whose item is to be set

name - The name of the item

value - The value of the item

Throws:

WGAPIException

removeItem

public void removeItem(WGPortlet portlet,
              java.lang.String name)
                throws WGAPIException

Description copied from class: WGPortletRegistry

Removes a portlet item

Specified by:

removeItem in class WGPortletRegistry

Parameters:

portlet - The portlet whose item is to be removed

name - The name of the item

Throws:

WGAPIException

getApplicationId

public java.lang.String getApplicationId(WGDatabase db)

Description copied from class: WGPortletRegistry

Returns the string ID that should be passed to the methods of this portlet registry to identify the given database

Specified by:

getApplicationId in class WGPortletRegistry

Parameters:

db - The application database