org.apache.cocoon.webapps.portal.components
Interface PortalManager

All Known Implementing Classes:

PortalManagerImpl

public interface PortalManager

This is the basis portal component

Version:

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

Author:

Carsten Ziegeler

Field Summary

static String	ATTRIBUTE_ADMIN_COPLETS
static String	ATTRIBUTE_ADMIN_ID
static String	ATTRIBUTE_ADMIN_ROLE
static String	ATTRIBUTE_ADMIN_STATE Some states for the admin configuration
static String	ATTRIBUTE_PORTAL_ID
static String	ATTRIBUTE_PORTAL_ROLE This is the current role/id which is set in the context
static String	BUILDTYPE_VALUE_BASIC Values for the buildprofile type element
static String	BUILDTYPE_VALUE_GLOBAL
static String	BUILDTYPE_VALUE_ID
static String	BUILDTYPE_VALUE_ROLE
static String	REQ_CMD_CLOSE
static String	REQ_CMD_CUSTOMIZE
static String	REQ_CMD_DELETE
static String	REQ_CMD_HIDE
static String	REQ_CMD_MAXIMIZE
static String	REQ_CMD_MINIMIZE
static String	REQ_CMD_MOVE
static String	REQ_CMD_MOVEROW
static String	REQ_CMD_NEW
static String	REQ_CMD_OPEN
static String	REQ_CMD_SAVEPROFILE
static String	REQ_CMD_SHOW
static String	REQ_CMD_UPDATE
static String	REQ_PARAMETER_ADMIN_COPLETS
static String	REQ_PARAMETER_CMD The request parameters for customizing coplets The request parameter is REQ_PARAMETER_CMD and the the value is one from REQ_CMD_ followed by '__'.
static String	REQ_PARAMETER_CONF This parameter is used for changing of profile value
static String	REQ_PARAMETER_COPLET
static String	REQ_PARAMETER_ID
static String	REQ_PARAMETER_PROFILE This parameter denotes the profile to be used
static String	REQ_PARAMETER_ROLE These parameter characterize the role and id
static String	REQ_PARAMETER_STATE
static String	ROLE The avalon role

Method Summary

boolean	checkAuthentication(Redirector redirector, String copletID) Check the authentication for the coplet.
void	configurationTest() Configure portal and check if it is allowed to see this coplet (if it is one).
SessionContext	getContext(boolean create) Get the portal context of the current application
String	getMediaType() Get the current media type
String	getProfileID(String type, String role, String id, boolean adminProfile) Builds the key for caching
Element	getStatusProfile() Get the status profile
Map	retrieveProfile(String profileID) Retrieve the profil
void	showAdminConf(XMLConsumer consumer) Show the admin configuration page.
void	showPortal(XMLConsumer consumer, boolean configMode, boolean adminProfile) Show the portal.
void	streamConfiguration(XMLConsumer consumer, String requestURI, String profileID, String media, String contextID) Include Portal URI into stream

Field Detail

ROLE

static final String ROLE

The avalon role

BUILDTYPE_VALUE_BASIC

static final String BUILDTYPE_VALUE_BASIC

Values for the buildprofile type element

See Also:

Constant Field Values

BUILDTYPE_VALUE_GLOBAL

static final String BUILDTYPE_VALUE_GLOBAL

See Also:

Constant Field Values

BUILDTYPE_VALUE_ROLE

static final String BUILDTYPE_VALUE_ROLE

See Also:

Constant Field Values

BUILDTYPE_VALUE_ID

static final String BUILDTYPE_VALUE_ID

See Also:

Constant Field Values

REQ_PARAMETER_CMD

static final String REQ_PARAMETER_CMD

The request parameters for customizing coplets The request parameter is REQ_PARAMETER_CMD and the the value is one from REQ_CMD_ followed by '__'.

See Also:

Constant Field Values

REQ_CMD_MAXIMIZE

static final String REQ_CMD_MAXIMIZE

See Also:

Constant Field Values

REQ_CMD_MINIMIZE

static final String REQ_CMD_MINIMIZE

See Also:

Constant Field Values

REQ_CMD_CLOSE

static final String REQ_CMD_CLOSE

See Also:

Constant Field Values

REQ_CMD_OPEN

static final String REQ_CMD_OPEN

See Also:

Constant Field Values

REQ_CMD_HIDE

static final String REQ_CMD_HIDE

See Also:

Constant Field Values

REQ_CMD_SHOW

static final String REQ_CMD_SHOW

See Also:

Constant Field Values

REQ_CMD_CUSTOMIZE

static final String REQ_CMD_CUSTOMIZE

See Also:

Constant Field Values

REQ_CMD_UPDATE

static final String REQ_CMD_UPDATE

See Also:

Constant Field Values

REQ_CMD_DELETE

static final String REQ_CMD_DELETE

See Also:

Constant Field Values

REQ_CMD_MOVE

static final String REQ_CMD_MOVE

See Also:

Constant Field Values

REQ_CMD_NEW

static final String REQ_CMD_NEW

See Also:

Constant Field Values

REQ_CMD_MOVEROW

static final String REQ_CMD_MOVEROW

See Also:

Constant Field Values

REQ_CMD_SAVEPROFILE

static final String REQ_CMD_SAVEPROFILE

See Also:

Constant Field Values

REQ_PARAMETER_CONF

static final String REQ_PARAMETER_CONF

This parameter is used for changing of profile value

See Also:

Constant Field Values

REQ_PARAMETER_PROFILE

static final String REQ_PARAMETER_PROFILE

This parameter denotes the profile to be used

See Also:

Constant Field Values

REQ_PARAMETER_ROLE

static final String REQ_PARAMETER_ROLE

These parameter characterize the role and id

See Also:

Constant Field Values

REQ_PARAMETER_ID

static final String REQ_PARAMETER_ID

See Also:

Constant Field Values

REQ_PARAMETER_STATE

static final String REQ_PARAMETER_STATE

See Also:

Constant Field Values

REQ_PARAMETER_COPLET

static final String REQ_PARAMETER_COPLET

See Also:

Constant Field Values

REQ_PARAMETER_ADMIN_COPLETS

static final String REQ_PARAMETER_ADMIN_COPLETS

See Also:

Constant Field Values

ATTRIBUTE_PORTAL_ROLE

static final String ATTRIBUTE_PORTAL_ROLE

This is the current role/id which is set in the context

See Also:

Constant Field Values

ATTRIBUTE_PORTAL_ID

static final String ATTRIBUTE_PORTAL_ID

See Also:

Constant Field Values

ATTRIBUTE_ADMIN_STATE

static final String ATTRIBUTE_ADMIN_STATE

Some states for the admin configuration

See Also:

Constant Field Values

ATTRIBUTE_ADMIN_ROLE

static final String ATTRIBUTE_ADMIN_ROLE

See Also:

Constant Field Values

ATTRIBUTE_ADMIN_ID

static final String ATTRIBUTE_ADMIN_ID

See Also:

Constant Field Values

ATTRIBUTE_ADMIN_COPLETS

static final String ATTRIBUTE_ADMIN_COPLETS

See Also:

Constant Field Values

Method Detail

configurationTest

void configurationTest()
                       throws ProcessingException,
                              IOException,
                              SAXException

Configure portal and check if it is allowed to see this coplet (if it is one). This is only a public wrapper for the getConfiguration method.

Throws:

ProcessingException

IOException

SAXException

streamConfiguration

void streamConfiguration(XMLConsumer consumer,
                         String requestURI,
                         String profileID,
                         String media,
                         String contextID)
                         throws IOException,
                                SAXException,
                                ProcessingException

Include Portal URI into stream

Throws:

IOException

SAXException

ProcessingException

showAdminConf

void showAdminConf(XMLConsumer consumer)
                   throws SAXException,
                          ProcessingException,
                          IOException

Show the admin configuration page.

Throws:

SAXException

ProcessingException

IOException

getStatusProfile

Element getStatusProfile()
                         throws SAXException,
                                IOException,
                                ProcessingException

Get the status profile

Throws:

SAXException

IOException

ProcessingException

showPortal

void showPortal(XMLConsumer consumer,
                boolean configMode,
                boolean adminProfile)
                throws SAXException,
                       ProcessingException,
                       IOException

Show the portal. The portal is included in the current stream.

Throws:

SAXException

ProcessingException

IOException

checkAuthentication

boolean checkAuthentication(Redirector redirector,
                            String copletID)
                            throws SAXException,
                                   IOException,
                                   ProcessingException

Check the authentication for the coplet. If it is not available do a redirect

Throws:

SAXException

IOException

ProcessingException

getMediaType

String getMediaType()
                    throws ProcessingException

Get the current media type

Throws:

ProcessingException

getContext

SessionContext getContext(boolean create)
                          throws ProcessingException,
                                 IOException,
                                 SAXException

Get the portal context of the current application

Throws:

ProcessingException

IOException

SAXException

getProfileID

String getProfileID(String type,
                    String role,
                    String id,
                    boolean adminProfile)
                    throws ProcessingException

Builds the key for caching

Throws:

ProcessingException

retrieveProfile

Map retrieveProfile(String profileID)
                    throws ProcessingException

Retrieve the profil

Throws:

ProcessingException