org.apache.cocoon.portal.profile
Interface ProfileManager

All Superinterfaces:

Component

All Known Implementing Classes:

AbstractProfileManager, AbstractUserProfileManager, AuthenticationProfileManager, GroupBasedProfileManager, SiteProfileManager, StaticProfileManager

public interface ProfileManager
extends Component

The profile manager. Via this component you can get the profile (or parts of it) of the current 'user'.

Version:

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

Author:

Carsten Ziegeler, Volker Schmitt

Field Summary

static String

ROLE

Method Summary

CopletData	getCopletData(String copletDataId) Return the coplet data object
Collection	getCopletDatas() Get all coplets
List	getCopletInstanceData(CopletData data)
CopletInstanceData	getCopletInstanceData(String copletID)
Collection	getCopletInstanceDatas() Get all instances
Layout	getPortalLayout(String layoutKey, String layoutID) Get the portal layout defined by the layout key.
PortalUser	getUser() Get current user information
void	login() This method is invoked when the user logs into the portal.
void	logout() This method is invoked when the user logs out of the portal
void	register(CopletInstanceData coplet) New coplet instance datas have to be registered using this method.
void	register(Layout layout) New layouts have to be registered using this method.
void	saveUserCopletInstanceDatas(String layoutKey) Save the coplet instance data
void	saveUserLayout(String layoutKey) Save the layout
void	saveUserProfiles(String layoutKey) Save the profile.
void	storeProfile(Layout rootLayout, String layoutKey) Store the provided profile under the layoutKey.
void	unregister(CopletInstanceData coplet) Removed coplet instance datas have to be unregistered using this method.
void	unregister(Layout layout) New layouts have to be unregistered using this method.

Field Detail

ROLE

static final String ROLE

Method Detail

getPortalLayout

Layout getPortalLayout(String layoutKey,
                       String layoutID)

Get the portal layout defined by the layout key. This usually addresses the layout profile. With the optional subKey it's possible to retrieve a specific layout object in the profile defined by the layout key.

Parameters:

layoutKey - A key describing the layout or null for the default

layoutID - The id of a layout object or null for the root object

Returns:

The layout

getCopletInstanceData

CopletInstanceData getCopletInstanceData(String copletID)

getCopletInstanceData

List getCopletInstanceData(CopletData data)

getCopletData

CopletData getCopletData(String copletDataId)

Return the coplet data object

login

void login()

This method is invoked when the user logs into the portal.

logout

void logout()

This method is invoked when the user logs out of the portal

register

void register(CopletInstanceData coplet)

New coplet instance datas have to be registered using this method.

unregister

void unregister(CopletInstanceData coplet)

Removed coplet instance datas have to be unregistered using this method.

register

void register(Layout layout)

New layouts have to be registered using this method.

unregister

void unregister(Layout layout)

New layouts have to be unregistered using this method.

saveUserProfiles

void saveUserProfiles(String layoutKey)

Save the profile. Usually this just calls saveUserCopletInstanceDatas(String) and saveUserLayout(String), but implementations are free to implement this method in a different way.

Parameters:

layoutKey -

saveUserLayout

void saveUserLayout(String layoutKey)

Save the layout

Parameters:

layoutKey -

saveUserCopletInstanceDatas

void saveUserCopletInstanceDatas(String layoutKey)

Save the coplet instance data

Parameters:

layoutKey -

getCopletInstanceDatas

Collection getCopletInstanceDatas()

Get all instances

getCopletDatas

Collection getCopletDatas()

Get all coplets

storeProfile

void storeProfile(Layout rootLayout,
                  String layoutKey)

Store the provided profile under the layoutKey. This method can be used to overwrite a profile with another one.

getUser

PortalUser getUser()

Get current user information