|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.portlet.GenericPortlet
org.apache.portals.bridges.common.GenericServletPortlet
org.apache.portals.bridges.jsf.FacesPortlet
FacesPortlet utilizes Java Server Faces to create the user interface in a portlet environment.
Field Summary | |
static String |
ACTION_REQUEST
Action request. |
private javax.faces.application.Application |
application
The Application instance for this web application. |
static String |
CUSTOM_REQUEST
Custom request. |
private String |
defaultActionPage
Default URL for the action page. |
private String |
defaultCustomPage
Default URL for the custom page. |
private String |
defaultEditPage
Default URL for the edit page. |
private String |
defaultHelpPage
Default URL for the help page. |
private String |
defaultViewPage
Default URL for the view page. |
static String |
EDIT_REQUEST
Edit request. |
static String |
FACES_MESSAGES
FacesMessage objects on portlet session |
private javax.faces.context.FacesContextFactory |
facesContextFactory
Factory for FacesContext instances. |
static String |
HELP_REQUEST
Help request. |
static String |
JSF_CUSTOM_ID
|
static String |
JSF_EDIT_ID
|
static String |
JSF_HELP_ID
|
static String |
JSF_VIEW_ID
The JSF_VIEW_ID used to maintain the state of the view action. |
private javax.faces.lifecycle.Lifecycle |
lifecycle
The Lifecycle instance to use for request processing. |
private static String |
LIFECYCLE_ID_ATTR
Context initialization parameter name for the lifecycle identifier of the Lifecycle instance to be utilized. |
private static org.apache.commons.logging.Log |
log
The Log instance for this class. |
static String |
PARAM_ACTION_PAGE
Name of portlet preference for Action page. |
static String |
PARAM_CUSTOM_PAGE
Name of portlet preference for Custom page. |
static String |
PARAM_EDIT_PAGE
Name of portlet preference for Edit page. |
static String |
PARAM_HELP_PAGE
Name of portlet preference for Edit page |
static String |
PARAM_UNIQUE_IDS
Override default behavior for Unique IDS |
static String |
PARAM_VIEW_PAGE
Name of portlet preference for View page |
private javax.portlet.PortletConfig |
portletConfig
The PortletConfig instance for this portlet. |
static String |
REQUEST_SERVLET_PATH
The REQUEST_SERVLET_PATH used for externalContext.getRequestServletPath(). |
static String |
REQUEST_TYPE
The REQUEST_TYPE request attribute can be used to determine the Portlet request type ( ACTION_REQUEST , VIEW_REQUEST ,
HELP_REQUEST , EDIT_REQUEST or CUSTOM_REQUEST )
of the current request. |
private String |
uniqueIds
|
static String |
VIEW_REQUEST
View request. |
static String |
VIEW_ROOT
The VIEW_ROOT used to keep track of action between the action request and the render request. |
Fields inherited from class org.apache.portals.bridges.common.GenericServletPortlet |
PARAM_ALLOW_PREFERENCES, PARAM_MAX_PAGE |
Fields inherited from class javax.portlet.GenericPortlet |
|
Constructor Summary | |
FacesPortlet()
|
Method Summary | |
protected void |
cleanUpAfterPortal(javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response)
Removes temporary JSF attributes from the request. |
private String |
createViewRootKey(javax.faces.context.FacesContext context,
String defaultView,
String viewId)
|
void |
destroy()
Release all resources acquired at startup time. |
void |
doCustom(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
|
void |
doEdit(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
|
void |
doHelp(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
|
void |
doView(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
|
javax.faces.context.FacesContextFactory |
getFacesContextFactory()
Gets the FacesContextFactory . |
javax.faces.lifecycle.Lifecycle |
getLifecycle()
Get the faces life cycle. |
void |
init(javax.portlet.PortletConfig portletConfig)
Acquire the factory instance we will require. |
protected void |
preProcessFaces(javax.faces.context.FacesContext context)
|
private void |
process(javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response,
String defaultPage,
String requestType,
String viewId)
Processes the request. |
void |
processAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse response)
|
private void |
restoreFacesMessages(javax.faces.context.FacesContext context,
javax.portlet.PortletSession session)
Restore FacesMessage objects from the PortletSession |
private void |
saveFacesMessages(javax.faces.context.FacesContext context,
javax.portlet.PortletSession session)
Save FacesMessage objects on the PortletSession |
private void |
setDefaultView(javax.faces.context.FacesContext facesContext,
String defaultView,
String viewId)
Set the view identifier to the view for the page to be rendered. |
Methods inherited from class org.apache.portals.bridges.common.GenericServletPortlet |
getDefaultActionPage, getDefaultCustomPage, getDefaultEditPage, getDefaultHelpPage, getDefaultViewPage, processPreferencesAction, setDefaultActionPage, setDefaultCustomPage, setDefaultEditPage, setDefaultHelpPage, setDefaultViewPage |
Methods inherited from class javax.portlet.GenericPortlet |
doDispatch, getInitParameter, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init, render |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private static final org.apache.commons.logging.Log log
public static final String VIEW_ROOT
public static final String REQUEST_SERVLET_PATH
public static final String REQUEST_TYPE
ACTION_REQUEST
, VIEW_REQUEST
,
HELP_REQUEST
, EDIT_REQUEST
or CUSTOM_REQUEST
)
of the current request.
public static final String JSF_VIEW_ID
public static final String JSF_EDIT_ID
public static final String JSF_HELP_ID
public static final String JSF_CUSTOM_ID
public static final String PARAM_ACTION_PAGE
public static final String PARAM_CUSTOM_PAGE
public static final String PARAM_EDIT_PAGE
public static final String PARAM_HELP_PAGE
public static final String PARAM_VIEW_PAGE
public static final String ACTION_REQUEST
public static final String VIEW_REQUEST
public static final String CUSTOM_REQUEST
public static final String EDIT_REQUEST
public static final String HELP_REQUEST
public static final String FACES_MESSAGES
public static final String PARAM_UNIQUE_IDS
private String defaultActionPage
private String defaultCustomPage
private String defaultEditPage
private String defaultHelpPage
private String defaultViewPage
private String uniqueIds
private static final String LIFECYCLE_ID_ATTR
Context initialization parameter name for the lifecycle identifier of the
Lifecycle
instance to be utilized.
private javax.faces.application.Application application
The Application
instance for this web application.
private javax.faces.context.FacesContextFactory facesContextFactory
Factory for FacesContext
instances.
private javax.faces.lifecycle.Lifecycle lifecycle
The Lifecycle
instance to use for request processing.
private javax.portlet.PortletConfig portletConfig
The PortletConfig
instance for this portlet.
Constructor Detail |
public FacesPortlet()
Method Detail |
public void destroy()
Release all resources acquired at startup time.
public void init(javax.portlet.PortletConfig portletConfig) throws javax.portlet.PortletException
Acquire the factory instance we will require.
javax.portlet.PortletException
- if, for any reason, the startp of this Faces application
failed. This includes errors in the config file that is
parsed before or during the processing of this
init()
method.public void doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, IOException
javax.portlet.PortletException
IOException
GenericPortlet.doEdit(javax.portlet.RenderRequest,
javax.portlet.RenderResponse)
public void doHelp(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, IOException
javax.portlet.PortletException
IOException
GenericPortlet.doHelp(javax.portlet.RenderRequest,
javax.portlet.RenderResponse)
public void doCustom(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, IOException
request
- The RenderRequest
.response
- The RenderResponse
.
javax.portlet.PortletException
- Throws a PortletException
.
IOException
- Throws a IOException
.public void doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, IOException
javax.portlet.PortletException
IOException
GenericPortlet.doView(javax.portlet.RenderRequest,
javax.portlet.RenderResponse)
public void processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) throws javax.portlet.PortletException, IOException
javax.portlet.PortletException
IOException
Portlet.processAction(javax.portlet.ActionRequest,
javax.portlet.ActionResponse)
public javax.faces.context.FacesContextFactory getFacesContextFactory() throws javax.portlet.PortletException
Gets the FacesContextFactory
.
FacesContextFactory
.
javax.portlet.PortletException
- Throws a PortletException
.public javax.faces.lifecycle.Lifecycle getLifecycle() throws javax.portlet.PortletException
Get the faces life cycle.
Lifecycle
.
javax.portlet.PortletException
- Throws a PortletException
.private void process(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, String defaultPage, String requestType, String viewId) throws javax.portlet.PortletException, IOException
Processes the request.
request
- The PortletRequest
.response
- The PortletResponse
.defaultPage
- The default page.requestType
- The request type.
javax.portlet.PortletException
- Throws a PortletException
.
IOException
- Throws an IOException
.protected void preProcessFaces(javax.faces.context.FacesContext context)
private String createViewRootKey(javax.faces.context.FacesContext context, String defaultView, String viewId)
private void setDefaultView(javax.faces.context.FacesContext facesContext, String defaultView, String viewId)
Set the view identifier to the view for the page to be rendered.
defaultView
- The default view identifier.
private void saveFacesMessages(javax.faces.context.FacesContext context, javax.portlet.PortletSession session)
context
- session
- private void restoreFacesMessages(javax.faces.context.FacesContext context, javax.portlet.PortletSession session)
context
- session
- protected void cleanUpAfterPortal(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
request
- portlet request we are processingresponse
- portlet response we are processing
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |