Package com.xebialabs.deployit.core.api

Interface BannerService

  • @Path("/banner")
public interface BannerService
    Retrieves and modifies the banner shown in the XL Deploy GUI

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ai.digital.deploy.sql.model.BannerInfo getBannerInfo​(ai.digital.deploy.sql.model.BannerInfo.BannerKind kind)
      Gets the banner to display
      void updateBannerInfo​(ai.digital.deploy.sql.model.BannerInfo bannerInfo)
      Admin only - Set the HTML contents for either MAINTENANCE or INFORMATION banner

    • Method Detail

      • getBannerInfo

        @GET
@Produces({"application/xml","application/json"})
ai.digital.deploy.sql.model.BannerInfo getBannerInfo​(@QueryParam("kind")
                                                     ai.digital.deploy.sql.model.BannerInfo.BannerKind kind)
        Gets the banner to display
        Parameters:
        kind - - either MAINTENANCE or INFORMATION
        Returns:
        the requested {@see com.xebialabs.deployit.core.api.dto.BannerInfo}

      • updateBannerInfo

        @PUT
@Consumes({"application/xml","application/json"})
void updateBannerInfo​(ai.digital.deploy.sql.model.BannerInfo bannerInfo)
        Admin only - Set the HTML contents for either MAINTENANCE or INFORMATION banner
        Parameters:
        bannerInfo - - a {@see com.xebialabs.deployit.core.api.dto.BannerInfo} object containing the banner kind and content