|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.jetspeed.util.template.JetspeedTool
Utility class for accessing Jetspeed in a "pull" mode Since the tool stores a RunData object, it may not be shared between threads and/or requests
Field Summary | |
protected JetspeedRunData |
rundata
RunData object for this request |
Constructor Summary | |
JetspeedTool()
Empty constructor used by introspection |
|
JetspeedTool(org.apache.turbine.util.RunData data)
The Tool constructor |
Method Summary | |
static Portlet |
getCustomizer(Portlet p)
This method retrieves the appropriate customizer portlet for the current portlet |
Entry |
getEntryFromRequest()
Retreives the Entry object for current portlet based on the "js_peid" parameter |
org.apache.ecs.ConcreteElement |
getPane(java.lang.String name)
Returns the portlet content customized for the current user. |
static java.lang.String |
getParameter(org.apache.turbine.util.RunData data,
java.lang.String parmStyle,
java.lang.String parmName,
java.lang.String parmValue,
java.lang.String parmOptions)
Returns a parameter rendered in specific parameter style |
org.apache.ecs.ConcreteElement |
getPortalElement(java.lang.String id)
Return the content of a portal element given the id of the element. |
org.apache.ecs.ConcreteElement |
getPortlet(java.lang.String name)
Deprecated. Use getPortletById() |
org.apache.ecs.ConcreteElement |
getPortletById(java.lang.String peid)
Return the content of a portlet using the portlet's id (PEID). |
org.apache.ecs.ConcreteElement |
getPortletById(java.lang.String peid,
boolean returnNull)
Return the content of a portlet using the portlet's id (PEID). |
org.apache.ecs.ConcreteElement |
getPortletFromRegistry(org.apache.turbine.util.RunData data)
Return the content of a portlet using the portlet's name. |
org.apache.ecs.ConcreteElement |
getPortletFromRegistry(java.lang.String portletName,
java.lang.String controlName)
Deprecated. Do not use this method because it's not secure. It will be removed after Beta 5. |
static Portlet |
getPortletInfoPortlet(org.apache.turbine.util.RunData data)
This method retrieves the appropriate information portlet for the current portlet |
static java.lang.String |
getPortletParameter(org.apache.turbine.util.RunData data,
Portlet portlet,
java.lang.String parmName)
Returns a parameter in its defined parameter style |
static java.lang.String |
getPortletParameter(org.apache.turbine.util.RunData data,
Portlet portlet,
java.lang.String parmName,
java.lang.String parmValue)
Returns a parameter in its defined parameter style |
static java.lang.String |
getPortletParameter(org.apache.turbine.util.RunData data,
Portlet portlet,
java.lang.String parmName,
java.lang.String parmValue,
java.lang.String parmOptions)
Returns a parameter in its defined parameter style |
SecurityReference |
getSecurityReference(Entry entry)
Retreives the correct SecurityReference for the portlet based on the current profile and the request. |
int |
getSecuritySource(Entry entry)
|
void |
init(java.lang.Object data)
This will initialise a JetspeedTool object that was constructed with the default constructor (ApplicationTool method). |
void |
refresh()
Refresh method - does nothing |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected JetspeedRunData rundata
Constructor Detail |
public JetspeedTool()
public JetspeedTool(org.apache.turbine.util.RunData data)
data
- the RunData object for the current requestMethod Detail |
public void init(java.lang.Object data)
init
in interface org.apache.turbine.services.pull.ApplicationTool
data
- assumed to be a RunData objectpublic void refresh()
refresh
in interface org.apache.turbine.services.pull.ApplicationTool
public org.apache.ecs.ConcreteElement getPane(java.lang.String name)
name
- the name of the pane to render
public org.apache.ecs.ConcreteElement getPortlet(java.lang.String name)
name
- the name of the portlet to render
public static Portlet getCustomizer(Portlet p)
p
- the portlet to customize
public static Portlet getPortletInfoPortlet(org.apache.turbine.util.RunData data)
data
- the RunData for this request
public org.apache.ecs.ConcreteElement getPortalElement(java.lang.String id)
id
- The portlet id
public org.apache.ecs.ConcreteElement getPortletById(java.lang.String peid)
peid
- the peid of the portlet to render
public org.apache.ecs.ConcreteElement getPortletById(java.lang.String peid, boolean returnNull)
peid
- the peid of the portlet to renderreturnNull
- allows the method to return null or not
public org.apache.ecs.ConcreteElement getPortletFromRegistry(org.apache.turbine.util.RunData data)
If a control name is specified to the portlet description, returns the defined portlet and control, otherwise use the default control.
Issues to resolve:
public org.apache.ecs.ConcreteElement getPortletFromRegistry(java.lang.String portletName, java.lang.String controlName)
If a control name is specified to the portlet description, returns the defined portlet and control, otherwise use the default control.
Issues to resolve:
portletName
- Name of the portlet as defined in registrycontrolName
- Optional control name to use in displaying the portlet
public static java.lang.String getPortletParameter(org.apache.turbine.util.RunData data, Portlet portlet, java.lang.String parmName)
data
- for this requestportlet
- portlet instanceparmName
- parameter name
public static java.lang.String getPortletParameter(org.apache.turbine.util.RunData data, Portlet portlet, java.lang.String parmName, java.lang.String parmValue)
data
- for this requestportlet
- portlet instanceparmName
- parameter nameparmValue
- current parameter value
public static java.lang.String getPortletParameter(org.apache.turbine.util.RunData data, Portlet portlet, java.lang.String parmName, java.lang.String parmValue, java.lang.String parmOptions)
data
- for this requestportlet
- portlet instanceparmName
- parameter nameparmValue
- current parameter value
public static java.lang.String getParameter(org.apache.turbine.util.RunData data, java.lang.String parmStyle, java.lang.String parmName, java.lang.String parmValue, java.lang.String parmOptions)
data
- for this requestparmStyle
- parameter styleparmName
- parameter nameparmValue
- current parameter value
public SecurityReference getSecurityReference(Entry entry)
public int getSecuritySource(Entry entry)
public Entry getEntryFromRequest() throws java.lang.Exception
java.lang.Exception
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |