Package com.ibm.wsspi.http

Interface WelcomePage

public interface WelcomePage
Implementations of this service can override the default branding and information applied to Open Liberty. By default when no apps are bound to / the welcome page is shown, and if a 404 is returned a pretty 404 is returned as a default. This can be overridden by registering a service with a higher service ranking than 0.

  • Method Summary

    Modifier and Type
    Method
    Description
    InputStream
    openNotFoundPage()
    The not found page is returned for a 404 page if there is no replacement.
    InputStream
    openWelcomePage(String url)
    This is called when the welcome page is being displayed.

  • Method Details

    • openWelcomePage

      InputStream openWelcomePage(String url)
      This is called when the welcome page is being displayed. It can be used to return any text or image file required for the page. Resources in sub-directories could clash with deployed applications, so care needs to be taken. If null is returned a 404 response will be returned.
      Parameters:
      url - the url being requested.
      Returns:
      the InputStream for the 404 response, or null if there is none.

    • openNotFoundPage

      InputStream openNotFoundPage()
      The not found page is returned for a 404 page if there is no replacement. The returned page must be self contained, it can't have references to other local pages since there is no way to guarantee these pages do not clash with other locations. If null is returned a defualt and basic 404 response will be returned.
      Returns:
      the InputStream for the 404 response, or null if there is none.