Package gov.usgs.util

Interface Configurable

All Known Subinterfaces:
IndexerListener, ListenerNotifier, NotificationIndex, NotificationListener, NotificationReceiver, ProductIndex, ProductSender, ProductStorage, StorageListener
All Known Implementing Classes:
AbstractListener, AdminSocketServer, ArchivePolicy, AwsProductReceiver, AwsProductSender, AwsSecretResolver, CLIProductBuilder, ConsolidatedFileProductStorage, ContentListener, DebugProductSender, DefaultConfigurable, DefaultIndexerListener, DefaultIndexerModule, DefaultNotificationListener, DefaultNotificationReceiver, DefaultNotificationSender, DefaultStorageListener, DirectoryPoller, DYFIIndexerModule, DYFIIndexerWedge, DYFILegacyStorage, EIDSInputWedge, EIDSNotificationReceiver, EIDSNotificationSender, EIDSOutputWedge, EIDSProductBuilder, EIDSProductReceiver, ExecutorListenerNotifier, ExtentIndex, ExtentIndexerListener, ExternalIndexerListener, ExternalNotificationListener, ExternalPreferredListener, FileProductStorage, FileTrackingListener, FutureListenerNotifier, HashFileProductStorage, HeartbeatListener, Indexer, InputWedge, JDBCConnection, JDBCNotificationIndex, JDBCProductIndex, JsonNotificationIndex, JsonProductStorage, MTIndexerModule, NATSClient, NATSStreamingNotificationReceiver, NATSStreamingNotificationSender, OriginIndexerModule, ProductArchivePolicy, ProductBuilder, ProductClient, ProductKey, ProductsCreatedAfterClient, RelayProductListener, ReliableIndexerListener, ReplicationStorageListener, RoundRobinListenerNotifier, SearchServerSocket, ShakeMapIndexerModule, ShakeMapIndexerWedge, SignatureVerifier, SocketProductReceiver, SocketProductSender, TectonicSummaryIndexerModule, TrackingIndex, URLProductStorage, WebSocketNotificationReceiver
public interface Configurable
An interface for objects that require configuration. Implementers of this interface should include an empty constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configure(Config config)
    This method is called after an object is instantiated, but before any other methods are called.
    String
    getName()
    Get this object name.
    void
    setName(String string)
    Set this object name.
    void
    shutdown()
    This method is called when the client is shutting down.
    void
    startup()
    This method is called after all objects are configured, and processing should begin.

  • Method Details

    • configure

      void configure(Config config) throws Exception
      This method is called after an object is instantiated, but before any other methods are called.
      Parameters:
      config - the Config to load.
      Throws:
      Exception - if configuration exceptions occur.

    • startup

      void startup() throws Exception
      This method is called after all objects are configured, and processing should begin.
      Throws:
      Exception - if exceptions occur while starting.

    • shutdown

      void shutdown() throws Exception
      This method is called when the client is shutting down.
      Throws:
      Exception - if exceptions occur while starting.

    • getName

      String getName()
      Get this object name.
      Returns:
      the name.

    • setName

      void setName(String string)
      Set this object name. This method is typically called by a Config object when the configurable object is loaded out of a config file. name will be set to the config section.
      Parameters:
      string - the name.