Interface BoxConfigurable

  • All Known Subinterfaces:
    BoxDatabase, Harvester, Processor, ReadOnlyDatabase, SingleProcessor
    All Known Implementing Classes:
    FacetView, MemoryDatabase, QueueRunner, RemoteDatabase, View

    public interface BoxConfigurable
    Any extension classes (ie, classes that implement Processor, Harvester, BoxDatabase, etc) must implement this. This is very similar to the PostConstruct and PreDestroy annotations in Java EE managed classes. When Box instantiates an extension class, it calls postConstruct and passes it configuration information. By default this method binds the values in params to the fields in the newly constructed object. The binding is handled by Jackson.

    When the application is undeployed, preDestroy() is called so the client can perform any cleanup necessary. By default this method does nothing.

    Note: postConstruct and preDestroy are only called if Box constructs the instance.

    Author:
    Charles Draper
    • Method Detail

      • postConstruct

        default void postConstruct​(ConstructConfig config)
        Called when Box constructs a new instance of the class.
        Parameters:
        config - configuration for this client.
      • postInit

        default void postInit​(InitConfig config)
        Called after Box is completely initialized.
        Parameters:
        config - configuration for this client.
      • preDestroy

        default void preDestroy()
        Called when the application is undeployed to allow the client to cleanup resources. Default is to do nothing.