|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SimpleLinkManager
A manager that looks after generating lists of SimpleLink
and
SimpleLinkSection
.
Method Summary | |
---|---|
List<SimpleLink> |
getLinksForSection(String section,
com.atlassian.crowd.embedded.api.User remoteUser,
JiraHelper jiraHelper)
Gets a list of SimpleLink for the given section. |
List<SimpleLink> |
getLinksForSection(String section,
com.atlassian.crowd.embedded.api.User remoteUser,
JiraHelper jiraHelper,
boolean addIconCachingPrefix)
Gets a list of SimpleLink for the given section. |
List<SimpleLink> |
getLinksForSectionIgnoreConditions(String section,
com.atlassian.crowd.embedded.api.User remoteUser,
JiraHelper jiraHelper)
Gets a list of SimpleLink for the given section, without
filtering links using the conditions specified for the links. |
List<SimpleLinkSection> |
getNotEmptySectionsForLocation(String location,
com.atlassian.crowd.embedded.api.User remoteUser,
JiraHelper jiraHelper)
Gets a list of SimpleLinkSection for the given location, that have either web-items or
other web-sections within them. |
SimpleLinkSection |
getSectionForURL(String topLevelSection,
String URL,
com.atlassian.crowd.embedded.api.User remoteUser,
JiraHelper jiraHelper)
Recursively search through our sections within sections within sections within ... |
List<SimpleLinkSection> |
getSectionsForLocation(String location,
com.atlassian.crowd.embedded.api.User remoteUser,
JiraHelper jiraHelper)
Gets a list of SimpleLinkSection for the given location. |
boolean |
shouldLocationBeLazy(String location,
com.atlassian.crowd.embedded.api.User remoteUser,
JiraHelper jiraHelper)
This determines whether a location should be loaded lazily if possible. |
boolean |
shouldSectionBeLazy(String section)
This determines whether an individual section should be loaded lazily if possible. |
Method Detail |
---|
boolean shouldLocationBeLazy(String location, com.atlassian.crowd.embedded.api.User remoteUser, JiraHelper jiraHelper)
location
- The location to check forremoteUser
- The user that we are generating the list forjiraHelper
- The context under which the list is being generated
boolean shouldSectionBeLazy(String section)
section
- The section to check for
@Nonnull List<SimpleLink> getLinksForSection(@Nonnull String section, com.atlassian.crowd.embedded.api.User remoteUser, @Nonnull JiraHelper jiraHelper)
SimpleLink
for the given section.
section
- The section to generate the list forremoteUser
- The user that we are generating the list forjiraHelper
- The context under which the list is being generated
@Nonnull List<SimpleLink> getLinksForSection(@Nonnull String section, com.atlassian.crowd.embedded.api.User remoteUser, @Nonnull JiraHelper jiraHelper, boolean addIconCachingPrefix)
SimpleLink
for the given section.
Additionally it adds caching prefix to icon url, if addIconCachinPrefix is true
section
- The section to generate the list forremoteUser
- The user that we are generating the list forjiraHelper
- The context under which the list is being generatedaddIconCachingPrefix
- Diecides if relative icon URL will be automatically prefixed
@Nonnull List<SimpleLink> getLinksForSectionIgnoreConditions(@Nonnull String section, com.atlassian.crowd.embedded.api.User remoteUser, @Nonnull JiraHelper jiraHelper)
SimpleLink
for the given section, without
filtering links using the conditions specified for the links. This will effectively return a list of links
without running any security checks.
section
- The section to generate the list forremoteUser
- The user that we are generating the list forjiraHelper
- The context under which the list is being generated
@Nonnull List<SimpleLinkSection> getSectionsForLocation(@Nonnull String location, com.atlassian.crowd.embedded.api.User remoteUser, @Nonnull JiraHelper jiraHelper)
SimpleLinkSection
for the given location.
location
- The location to generate the list forremoteUser
- The user that we are generating the list forjiraHelper
- The context under which the list is being generated
SimpleLinkSection getSectionForURL(@Nonnull String topLevelSection, @Nonnull String URL, com.atlassian.crowd.embedded.api.User remoteUser, JiraHelper jiraHelper)
URL
- The URL for the action e.g. https://jdog.atlassian.com/secure/project/ViewProjects.jspa. We check if this URL contains a web-item's path which is usually something shorter like /secure/project/ViewProjects.jspatopLevelSection
- The top level section from where to start searching!remoteUser
- The user that we are generating the list forjiraHelper
- The context under which the list is being generated
@Nonnull List<SimpleLinkSection> getNotEmptySectionsForLocation(@Nonnull String location, com.atlassian.crowd.embedded.api.User remoteUser, @Nonnull JiraHelper jiraHelper)
SimpleLinkSection
for the given location, that have either web-items or
other web-sections within them.
location
- The location to generate the list forremoteUser
- The user that we are generating the list forjiraHelper
- The context under which the list is being generated
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |