GeoServer

Add extension point to allow contributing content to the Web UI home page body

Details

  • Type: Task Task
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 2.1.1
  • Component/s: Wicket UI
  • Labels:
    None
  • Number of attachments :
    0

Description

Introduce a new extension point for modules to provide extra content to the geoserver home page, just like
CapabilitiesHomePageLinkProvider does for the getcapabilities panel.

The interface would be pretty much the same:

public interface HomeContentProvider {
    public Component getPageBodyComponent(final String id);
}

Except returned components are meant to be part of the main home page
body instead of the right caps panel, and it'd be valid to return null
(so that a provider may choose under what circumstances to return
content at all, like in whether the admin is logged in, etc.)

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Justin Deoliveira added a comment -

+1. I might be more explicit with the name though... like HomePageContentProvider.

Show
Justin Deoliveira added a comment - +1. I might be more explicit with the name though... like HomePageContentProvider.
Hide
Permalink
Gabriel Roldan added a comment -

Yup, it turned out being GeoServerHomePageContentProvider so that it also lays next to GeoServerHomePage. Does that sound good?

Show
Gabriel Roldan added a comment - Yup, it turned out being GeoServerHomePageContentProvider so that it also lays next to GeoServerHomePage . Does that sound good?
Hide
Permalink
Gabriel Roldan added a comment -

So it'd be:


/**
 * {@link GeoServerHomePage} extension point allowing to contribute a Wicket component to the
 * central body of the home page.
 * <p>
 * Instances of this type are to be looked up by the {@code GeoServerHomePage} by means of the
 * {@link GeoServerExtensions} mechanism and appended to the home page's central body in no
 * predefined order.
 * </p>
 * 
 * @author Gabriel Roldan
 * @see CapabilitiesHomePageLinkProvider
 */
public interface GeoServerHomePageContentProvider {

    /**
     * Returns a component to be added to the home page central body.
     * <p>
     * Note {@code null} is a valid return value, so that implementations may opt not to contribute
     * extra content to the home page under a circumstance of their choice. For example, if the
     * contributed content is not meant to be visible to anonymous users, etc.
     * </p>
     * 
     * @param id the id of the returned component
     * @return a component suitable to be contained by the home page central body, or {@code null}
     *         if no extra content is provided.
     */
    public Component getPageBodyComponent(final String id);

}
Show
Gabriel Roldan added a comment - So it'd be: /** * {@link GeoServerHomePage} extension point allowing to contribute a Wicket component to the * central body of the home page. * <p> * Instances of this type are to be looked up by the {@code GeoServerHomePage} by means of the * {@link GeoServerExtensions} mechanism and appended to the home page's central body in no * predefined order. * </p> * * @author Gabriel Roldan * @see CapabilitiesHomePageLinkProvider */ public interface GeoServerHomePageContentProvider { /** * Returns a component to be added to the home page central body. * <p> * Note {@code null } is a valid return value, so that implementations may opt not to contribute * extra content to the home page under a circumstance of their choice. For example, if the * contributed content is not meant to be visible to anonymous users, etc. * </p> * * @param id the id of the returned component * @ return a component suitable to be contained by the home page central body, or {@code null } * if no extra content is provided. */ public Component getPageBodyComponent( final String id); }
Hide
Permalink
Gabriel Roldan added a comment -

committed to trunk at r15792.

Show
Gabriel Roldan added a comment - committed to trunk at r15792.
Hide
Permalink
Gabriel Roldan added a comment -

backported to 2.1.x at r15973 together with CapabilitiesHomePageLinkProvider

Show
Gabriel Roldan added a comment - backported to 2.1.x at r15973 together with CapabilitiesHomePageLinkProvider

People

  • Assignee:
    Gabriel Roldan
    Reporter:
    Gabriel Roldan
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: