Package net.bluemind.system.api

Interface IInstallation

All Superinterfaces:
ICustomTheme
@Path("/system/installation") public interface IInstallation extends ICustomTheme

  • Method Details

    • getSubscriptionInformations

      @GET @Path("subscription") SubscriptionInformations getSubscriptionInformations() throws ServerFault
      Throws:
      ServerFault

    • getSubscriptionKind

      @GET @Path("subscriptionKind") SubscriptionInformations.Kind getSubscriptionKind() throws ServerFault
      Throws:
      ServerFault

    • isValidProductionSubscription

      @GET @Path("subscriptionProductiveValid") Boolean isValidProductionSubscription() throws ServerFault
      Throws:
      ServerFault

    • updateSubscription

      @POST @Path("subscription") void updateSubscription(String licence) throws ServerFault
      Throws:
      ServerFault

    • updateSubscriptionWithArchive

      @POST @Path("subscription/_archive") @Consumes("application/zip") void updateSubscriptionWithArchive(Stream archive) throws ServerFault
      Throws:
      ServerFault

    • updateSubscriptionVersion

      @POST @Path("subscription/_version") void updateSubscriptionVersion(@QueryParam("version") String version)
      Update subscription URL to given version on all servers
      Parameters:
      version - target version. Special versions:
      • latest targets the latest published version of installed BlueMind major version
      • current targets the current installed version of BlueMind
      Throws:
      ServerFault - standard error object (unchecked exception)

    • removeSubscription

      @DELETE @Path("subscription") void removeSubscription() throws ServerFault
      Throws:
      ServerFault

    • getSystemState

      @GET @Path("state") SystemState getSystemState() throws ServerFault
      Throws:
      ServerFault

    • maintenanceMode

      @PUT @Path("state/_maintenance") void maintenanceMode() throws ServerFault
      Throws:
      ServerFault

    • runningMode

      @DELETE @Path("state/_maintenance") void runningMode() throws ServerFault
      Throws:
      ServerFault

    • getVersion

      @GET @Path("version") InstallationVersion getVersion() throws ServerFault
      Throws:
      ServerFault

    • markSchemaAsUpgraded

      @POST @Path("version") void markSchemaAsUpgraded() throws ServerFault
      Throws:
      ServerFault

    • initialize

      @POST @Path("_initialize") TaskRef initialize() throws ServerFault
      Throws:
      ServerFault

    • upgrade

      @POST @Path("_upgrade") TaskRef upgrade() throws ServerFault
      Throws:
      ServerFault

    • postinst

      @POST @Path("_postinst") TaskRef postinst() throws ServerFault
      Run post-installation upgraders
      Returns:
      Throws:
      ServerFault

    • upgradeStatus

      @GET @Path("_upgrade") UpgradeStatus upgradeStatus() throws ServerFault
      Throws:
      ServerFault

    • resetIndexes

      @POST @Path("_resetIndexes") TaskRef resetIndexes()

    • resetIndex

      @POST @Path("{index}/_resetIndex") TaskRef resetIndex(@PathParam("index") String index)

    • getInfos

      @GET @Path("_infos") PublicInfos getInfos()

    • ping

      @POST @Path("{ip}/ping") void ping(@PathParam("ip") String ip) throws ServerFault
      Throws:
      ServerFault

    • getSubscriptionContacts

      @GET @Path("_subscriptionContacts") List<String> getSubscriptionContacts() throws ServerFault
      Throws:
      ServerFault

    • setSubscriptionContacts

      @POST @Path("_subscriptionContacts") void setSubscriptionContacts(List<String> emails) throws ServerFault
      Throws:
      ServerFault

    • getHostReport

      @GET @Path("_hostReport") String getHostReport()

    • sendHostReport

      @POST @Path("_hostReport") String sendHostReport()

    • clone

      @POST @Path("_clone") TaskRef clone(CloneConfiguration sourceParams)

    • demoteLeader

      @PUT @Path("state/_demote") void demoteLeader() throws ServerFault
      The instance will stop handling write requests then will write a BYE message into kafka to relinquish control to the clone.
      Throws:
      ServerFault

    • promoteLeader

      @PUT @Path("state/_promote") void promoteLeader() throws ServerFault
      Throws:
      ServerFault