| org.sakaiproject.portal.api.PortalService
All known Subclasses: org.sakaiproject.portal.service.PortalServiceImpl,
| PortalService | | public interface PortalService (Code) | | Portal Service acts as a focus for all Portal based activities, the service implementation
should act as a holder to enable the varous webapps to communicate with one annother.
author:
ieb
since:
Sakai 2.4
version:
$Rev: 29143 $ |
| Method Summary | |
| void | addHandler(Portal portal, PortalHandler handler)
Add a PortalHandler to the portal Handler map for the named context. | | void | addPortal(Portal portal)
| | void | addRenderEngine(String context, PortalRenderEngine vengine)
add a render engine to the available render engines.
Parameters:
context - -the context to rengister the render engine in, as there may bemore than one portal in a sakai instance, you need to register therender engine against a context. | | String | decodeToolState(Map<String, String[]> params, String placementId)
Inverts the operation of encodeToolState, and returns the URL stub which
was supplied for the supplied placementId. | | Map<String, String[]> | encodeToolState(String placementId, String URLstub)
Returns a parameter map suitable for appending to a portal URL,
representing that the URL state of a tool being shown with the specified
placementId will be equal to the URLstub. | | Map<String, PortalHandler> | getHandlerMap(Portal portal)
Get the PortalHandler map for the portal Context. | | Iterator<PortletApplicationDescriptor> | getRegisteredApplications()
| | PortalRenderEngine | getRenderEngine(String context, HttpServletRequest request)
| | String | getResetState()
| | String | getResetStateParam()
| | StoredState | getStoredState()
get the StoredState object that is used to hold initial request state on
direct access to a portlet state or on GET or POST that requires other
initial actions. | | StyleAbleProvider | getStylableService()
| | boolean | isEnableDirect()
Is the direct URL mechnism enabled in the configation file. | | boolean | isResetRequested(HttpServletRequest req)
| | StoredState | newStoredState(String marker, String replacement)
| | void | removeHandler(Portal portal, String urlFragment)
| | void | removePortal(Portal portal)
| | void | removeRenderEngine(String context, PortalRenderEngine vengine)
remove a render engine from the avaialble render engines
Parameters:
context - -the context to deregister the render engine from, as there may bemore than one portal in a sakai instance, you need to deregisterthe render engine from a context. | | void | setResetState(String state)
ste the state of the portal reset flag. | | void | setStoredState(StoredState storedstate)
|
| PLACEMENT_ATTRIBUTE | | final public static String PLACEMENT_ATTRIBUTE(Code) | | A portal request scope attribute that reprenset the placement id of the
current request. It should be a string, and should be implimented where
the request is portlet dispatched.
|
| TOOL_PORTLET_APP_NAME | | final public static String TOOL_PORTLET_APP_NAME(Code) | | this is the property in the tool config that defines the name of the
portlet application
|
| TOOL_PORTLET_CONTEXT_PATH | | final public static String TOOL_PORTLET_CONTEXT_PATH(Code) | | this is the property in the tool config that defines the portlet context
of tool. At the moment we assume that this is in the read-only properties
of the tool, but there could be a generic tool placement that enabled any
portlet to be mounted
|
| TOOL_PORTLET_NAME | | final public static String TOOL_PORTLET_NAME(Code) | | this is the property in the tool config that defines the name of the
portlet
|
| addHandler | | void addHandler(Portal portal, PortalHandler handler)(Code) | | Add a PortalHandler to the portal Handler map for the named context.
Parameters:
portal -
Parameters:
handler - |
| addPortal | | void addPortal(Portal portal)(Code) | | Remove a portal from the portal service this should perform all the
necessary cleanup
Parameters:
portal - |
| addRenderEngine | | void addRenderEngine(String context, PortalRenderEngine vengine)(Code) | | add a render engine to the available render engines.
Parameters:
context - -the context to rengister the render engine in, as there may bemore than one portal in a sakai instance, you need to register therender engine against a context. The context should match thecontext used by the portal to retrieve its render engine. This isdependant on the Portal implementation details.
Parameters:
vengine - the render engine implementation to register with the portalservice |
| decodeToolState | | String decodeToolState(Map<String, String[]> params, String placementId)(Code) | | Inverts the operation of encodeToolState, and returns the URL stub which
was supplied for the supplied placementId. Will return null
if there was no special state registered.
|
| encodeToolState | | Map<String, String[]> encodeToolState(String placementId, String URLstub)(Code) | | Returns a parameter map suitable for appending to a portal URL,
representing that the URL state of a tool being shown with the specified
placementId will be equal to the URLstub. URLstub may contain anchor
state, which the portal implementation may honour if it is capable. The
Map may also include the encoded state of other placements if they are
being shown in the current render state.
|
| getRenderEngine | | PortalRenderEngine getRenderEngine(String context, HttpServletRequest request)(Code) | | get a render engine possibly based on the request
Parameters:
context - -the context from whcih to take the render engine.
Parameters:
request - |
| getResetState | | String getResetState()(Code) | | get the state of the state of the portal reset flag
|
| getResetStateParam | | String getResetStateParam()(Code) | | Get the parameter used to communicate reset state operations on the URL
|
| getStoredState | | StoredState getStoredState()(Code) | | get the StoredState object that is used to hold initial request state on
direct access to a portlet state or on GET or POST that requires other
initial actions.
|
| getStylableService | | StyleAbleProvider getStylableService()(Code) | | Get the implimentation of the StylableService from the portal impl
|
| isEnableDirect | | boolean isEnableDirect()(Code) | | Is the direct URL mechnism enabled in the configation file.
|
| newStoredState | | StoredState newStoredState(String marker, String replacement)(Code) | | Create a new Stored State
Parameters:
marker - the mark within the URL
Parameters:
replacement - and the replacement text on restoration |
| removeHandler | | void removeHandler(Portal portal, String urlFragment)(Code) | | Remove the Portal Handler identitied by the URL fragment associated with
the portal Context
Parameters:
portal -
Parameters:
urlFragment - |
| removePortal | | void removePortal(Portal portal)(Code) | | Add a portal to the portal service
Parameters:
portal - |
| removeRenderEngine | | void removeRenderEngine(String context, PortalRenderEngine vengine)(Code) | | remove a render engine from the avaialble render engines
Parameters:
context - -the context to deregister the render engine from, as there may bemore than one portal in a sakai instance, you need to deregisterthe render engine from a context. The context should match thecontext used by the portal to retrieve its render engine. This isdependant on the Portal implementation details.
Parameters:
vengine - |
| setResetState | | void setResetState(String state)(Code) | | ste the state of the portal reset flag.
Parameters:
state - |
| setStoredState | | void setStoredState(StoredState storedstate)(Code) | | set the StoredState of the request for later retrieval
Parameters:
storedstate - |
|
|