|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletURLProvider
Defines the interface used by the portlet container to create Portal URLs. This provider must be implemented by the Portal and provided via the container services upon initialization of the container.
Method Summary | |
---|---|
void |
clearParameters()
Removes all pre-existing parameters in this URL |
java.lang.String[] |
getPrivateRenderParameters(java.lang.String name)
Gets the values from the parameters from this request. |
java.lang.String[] |
getPublicRenderParameters(java.lang.String name)
Gets the values from the current public-render-parameters from this request. |
boolean |
isResourceServing()
Shows you if the lifecycle is serveResource |
boolean |
isSecureSupported()
Determine whether or not this url provider supports secure urls. |
void |
savePortalURL(javax.servlet.http.HttpServletRequest request)
|
void |
setAction(boolean action)
Specifies whether or not this request should be considered an action request. |
void |
setParameters(java.util.Map parameters)
Sets the given parameters as parameters into the URL, Removes all previously set parameters. |
void |
setPortletMode(PortletMode mode)
Sets the new portlet mode at the URL. |
void |
setPublicRenderParameters(java.util.Map parameters)
Sets the given public-render-parameters as parameters into the URL. |
void |
setResourceServing(boolean resource)
Specifies whether or not this request should be considered an resource Serving request. |
void |
setSecure()
By calling this method the URL is defined as a secure URL. |
void |
setWindowState(WindowState state)
Sets the new window state at the URL. |
java.lang.String |
toString()
Returns the URL in string format. |
Method Detail |
---|
void setPortletMode(PortletMode mode)
mode
- the new portlet modevoid setWindowState(WindowState state)
state
- the new window statevoid setAction(boolean action)
void setResourceServing(boolean resource)
boolean isResourceServing()
void setSecure() throws PortletSecurityException
PortletSecurityException
boolean isSecureSupported()
PortletSecurityException
void clearParameters()
void setParameters(java.util.Map parameters)
parameters
- a map containing the name [java.lang.String] and value
[java.lang.String[]] of the parameters.void setPublicRenderParameters(java.util.Map parameters)
parameters
- a map containing the name [java.lang.String] and value
[java.lang.String[]] of the parameters.java.lang.String toString()
toString
in class java.lang.Object
void savePortalURL(javax.servlet.http.HttpServletRequest request)
java.lang.String[] getPublicRenderParameters(java.lang.String name)
name
- Parametername
java.lang.String[] getPrivateRenderParameters(java.lang.String name)
name
- Parametername
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |