TrueUpdate Agent Specification 0.7

net.java.trueupdate.agent.spec
Interface UpdateAgent


public interface UpdateAgent

An update agent cooperates with an update manager to automatically install updates to an application. All communication between the update agent and the update manager is asynchronous.

Implementations must be thread-safe.

Author:
Christian Schlichtherle

Method Summary
 void cancel()
          Sends a negative response to a redeployment request in order to cancel the installation of an artifact update.
 void install(String version)
          Sends a request to install the given artifact version.
 void proceed()
          Sends a positive response to a redeployment request in order to complete the installation of an artifact update.
 void subscribe()
          Sends a request to subscribe to the list of recipients for update notices for the application.
 void unsubscribe()
          Sends a request to unsubscribe from the list of recipients for update notices for the application.
 

Method Detail

cancel

void cancel()
            throws Exception
Sends a negative response to a redeployment request in order to cancel the installation of an artifact update.

Throws:
Exception

install

void install(String version)
             throws Exception
Sends a request to install the given artifact version.

Parameters:
version - the artifact version to install. Specifying the current version shows no effect. Specifying a higher version upgrades the application. Specifying a prior version downgrades the application.
Throws:
Exception

proceed

void proceed()
             throws Exception
Sends a positive response to a redeployment request in order to complete the installation of an artifact update. On success, this will subsequently shutdown this application, install the update and restart the updated application.

Throws:
Exception

subscribe

void subscribe()
               throws Exception
Sends a request to subscribe to the list of recipients for update notices for the application.

Throws:
Exception

unsubscribe

void unsubscribe()
                 throws Exception
Sends a request to unsubscribe from the list of recipients for update notices for the application.

Throws:
Exception

TrueUpdate Agent Specification 0.7

Copyright © 2013 Schlichtherle IT Services. All rights reserved.