Package org.jclouds.lifecycle

Interface LifeCycle

All Known Implementing Classes:
BaseLifeCycle
public interface LifeCycle
// TODO: Adrian: Document this!

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    LifeCycle.Status
    States that are possible for a component.

  • Method Summary

    Modifier and Type
    Method
    Description
    Exception
    getException()
     
    LifeCycle.Status
    getStatus()
     
    void
    shutdown()
    Requests shutdown of the component.
    void
    shutdown(long waitMs)
    Requests shutdown, but will only wait @link waitms milliseconds
    void
    start()
    Asynchronously starts the component

  • Method Details

    • getStatus

      LifeCycle.Status getStatus()
      Returns:
      the current state of the component;

    • getException

      Exception getException()
      Returns:
      Exception or null, if there are no fatal Exceptions encountered in the lifecycle of this component.

    • start

      @PostConstruct void start()
      Asynchronously starts the component

    • shutdown

      @PreDestroy void shutdown()
      Requests shutdown of the component.

    • shutdown

      void shutdown(long waitMs)
      Requests shutdown, but will only wait @link waitms milliseconds
      Parameters:
      waitMs - maximum time to wait in milliseconds