当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

CMSPortlet - JBOSS Portal 2.6 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jboss.portal.core.portlet.cms
Class CMSPortlet

java.lang.Object
  javax.portlet.GenericPortlet
      org.jboss.portal.core.portlet.cms.CMSPortlet

All Implemented Interfaces:

Portlet

---

public class CMSPortlet

extends GenericPortlet

Displays content from the CMS.

Version:

$Revision: 5448 $

TODO: use portlet preferences for default homepage, and allow for preference modification in doEdit()

Author:

Roy Russo, Julien Viet

---

Field Summary
(package private) static java.lang.String	CMS_JSP_PATH           Our path to jsp pages
private  CMS	CMSService
(package private) static java.lang.String	DEFAULT_IMAGES_PATH           Where we can find the default images in the resource bundle.
(package private) static java.lang.String	DEFAULT_PAGES_PATH           Where we can find the default data in the resource bundle.
private static java.lang.String	HTMLStripperRegex           Removes header content, and leaves content between body tags
private  java.lang.String	indexpage
private static org.apache.log4j.Logger	log
private static java.lang.String	regex
private static java.util.regex.Pattern	RELATIVE_URI_PATTERN
private static java.util.regex.Pattern	STRIP_TAGS_PATTERN
private static java.lang.String	URI_ignoreRegex           For our purposes, ignore URIs that start with a scheme idicator, a slash (indicating an absolute path), or a hash sign (# = ASCII hex 23).
private static java.lang.String	URI_schemeRegex           It's easier and more robust to follow the standards.

 

Fields inherited from class javax.portlet.GenericPortlet

 

Constructor Summary

CMSPortlet()

 

Method Summary
java.lang.String	buildURL(RenderResponse resp, java.lang.String path)           Rewrites urls.
void	doEdit(RenderRequest req, RenderResponse resp)           Helper method to serve up the edit mode.
void	doHelp(RenderRequest req, RenderResponse resp)           Helper method to serve up the help mode.
void	doView(RenderRequest req, RenderResponse resp)           Helper method to serve up the mandatory view mode.
void	init()           A convenience method which can be overridden so that there's no need to call super.init(config).

 

Methods inherited from class javax.portlet.GenericPortlet

destroy, doDispatch, getInitParameter, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init, processAction, render

 

Methods inherited from class java.lang.Object

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

 

Field Detail

log

private static org.apache.log4j.Logger log

---

CMSService

private CMS CMSService

---

indexpage

private java.lang.String indexpage

---

URI_schemeRegex

private static final java.lang.String URI_schemeRegex

It's easier and more robust to follow the standards. See http://www.ietf.org/rfc/rfc2396.txt of which, Section 3.1 on the "Scheme Component" is partially excerpted here:

Just as there are many different methods of access to resources, there are a variety of schemes for identifying such resources...

Scheme names consist of a sequence of characters beginning with a lower case letter and followed by any combination of lower case letters, digits, plus ("+"), period ("."), or hyphen ("-"). For resiliency, programs interpreting URI should treat upper case letters as equivalent to lower case in scheme names (e.g., allow "HTTP" as well as "http").

scheme = alpha *( alpha | digit | "+" | "-" | "." )

See Also:

Constant Field Values

---

URI_ignoreRegex

private static final java.lang.String URI_ignoreRegex

For our purposes, ignore URIs that start with a scheme idicator, a slash (indicating an absolute path), or a hash sign (# = ASCII hex 23).

See Also:

Constant Field Values

---

regex

private static final java.lang.String regex

See Also:

Constant Field Values

---

HTMLStripperRegex

private static final java.lang.String HTMLStripperRegex

Removes header content, and leaves content between body tags

See Also:

Constant Field Values

---

RELATIVE_URI_PATTERN

private static final java.util.regex.Pattern RELATIVE_URI_PATTERN

---

STRIP_TAGS_PATTERN

private static final java.util.regex.Pattern STRIP_TAGS_PATTERN

---

CMS_JSP_PATH

static final java.lang.String CMS_JSP_PATH

Our path to jsp pages

See Also:

Constant Field Values

---

DEFAULT_PAGES_PATH

static final java.lang.String DEFAULT_PAGES_PATH

Where we can find the default data in the resource bundle.

See Also:

Constant Field Values

---

DEFAULT_IMAGES_PATH

static final java.lang.String DEFAULT_IMAGES_PATH

Where we can find the default images in the resource bundle.

See Also:

Constant Field Values

Constructor Detail

CMSPortlet

public CMSPortlet()

Method Detail

init

public void init()
          throws PortletException

Description copied from class: GenericPortlet

A convenience method which can be overridden so that there's no need to call super.init(config).

Instead of overriding GenericPortlet.init(PortletConfig), simply override this method and it will be called by GenericPortlet.init(PortletConfig config). The PortletConfig object can still be retrieved via GenericPortlet.getPortletConfig().

Overrides:

init in class GenericPortlet

Throws:

PortletException - if an exception has occurred that interferes with the portlet normal operation.

---

doView

public void doView(RenderRequest req,
                   RenderResponse resp)
            throws PortletException,
                   PortletSecurityException,
                   java.io.IOException

Description copied from class: GenericPortlet

Helper method to serve up the mandatory view mode.

The default implementation throws an exception.

Overrides:

doView in class GenericPortlet

Parameters:

req - the portlet request

resp - the render response

Throws:

PortletException - if the portlet cannot fulfilling the request

PortletSecurityException - if the portlet cannot fullfill this request because of security reasons

java.io.IOException - if the streaming causes an I/O problem

---

buildURL

public java.lang.String buildURL(RenderResponse resp,
                                 java.lang.String path)

Rewrites urls. Typically, this is used for image src calls from the html, so they route thru the CMSObjectCommandMapper and invoke the StreamObjectCommand.

---

doHelp

public void doHelp(RenderRequest req,
                   RenderResponse resp)
            throws java.io.IOException,
                   PortletException

Description copied from class: GenericPortlet

Helper method to serve up the help mode.

The default implementation throws an exception.

Overrides:

doHelp in class GenericPortlet

Parameters:

req - the portlet request

resp - the render response

Throws:

java.io.IOException - if the streaming causes an I/O problem

PortletException - if the portlet cannot fulfilling the request

---

doEdit

public void doEdit(RenderRequest req,
                   RenderResponse resp)
            throws java.io.IOException,
                   PortletException

Description copied from class: GenericPortlet

Helper method to serve up the edit mode.

The default implementation throws an exception.

Overrides:

doEdit in class GenericPortlet

Parameters:

req - the portlet request

resp - the render response

Throws:

PortletException - if the portlet cannot fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---