|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is a central service of the portal. It should be used to create links inside the portal pages.
Nested Class Summary | |
static class |
LinkService.ParameterDescription
|
Field Summary | |
static String |
DEFAULT_REQUEST_EVENT_PARAMETER_NAME
|
static String |
ROLE
|
Method Summary | |
void |
addEventToLink(Event event)
Add this event to the list of events contained in the uri |
void |
addParameterToLink(String name,
String value)
Add this parameter to every link. |
void |
addUniqueParameterToLink(String name,
String value)
Add this parameter to every link. |
String |
encodeURL(String url)
|
List |
getInternalParameterNames()
A list of parameters that should be filtered when coplets are called. |
String |
getLinkURI(Event event)
Get the uri for this coplet containing the additional event |
String |
getLinkURI(Event event,
Boolean secure)
Get the uri for this coplet containing the additional event and using a secure protocol if requested. |
String |
getLinkURI(List events)
Get the uri for this coplet containing the additional events. |
String |
getLinkURI(List events,
Boolean secure)
Get a uri for this coplet containing the additional events. |
String |
getRefreshLinkURI()
Get a link that simply refreshs the portal |
String |
getRefreshLinkURI(Boolean secure)
Get a link that simply refreshs the portal |
boolean |
isInternalParameterName(String name)
Test if the parameter is an internal one. |
boolean |
isSecure()
Determine whether the current url is using a secure protocol |
Field Detail |
public static final String ROLE
public static final String DEFAULT_REQUEST_EVENT_PARAMETER_NAME
Method Detail |
public String getLinkURI(Event event)
event
- The event to add (null is also allowed for convenience)
public String getLinkURI(Event event, Boolean secure)
event
- The event to add (null is also allowed for convenience)secure
- true if a secure protocol is required, false otherwise.
public String getLinkURI(List events)
events
- The events to add: These can either be Event
s or LinkService.ParameterDescription
s.
public String getLinkURI(List events, Boolean secure)
events
- The events to add: These can either be Event
s or LinkService.ParameterDescription
s.secure
- true if a secure protocol is required, false otherwise.
public void addEventToLink(Event event)
event
- Event to addpublic void addParameterToLink(String name, String value)
name
- The request parameter namevalue
- The value for the parameteraddUniqueParameterToLink(String, String)
public void addUniqueParameterToLink(String name, String value)
name
- The request parameter namevalue
- The value for the parameteraddUniqueParameterToLink(String, String)
public String getRefreshLinkURI()
public String getRefreshLinkURI(Boolean secure)
secure
- true if a secure protocol is required, false otherwise.
public boolean isSecure()
public String encodeURL(String url)
url
- The url to encode.
HttpServletResponse.encodeURL(java.lang.String)
public List getInternalParameterNames()
public boolean isInternalParameterName(String name)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |