Package gov.usgs.util

Class DefaultConfigurable

java.lang.Object

gov.usgs.util.DefaultConfigurable

All Implemented Interfaces:

Configurable

Direct Known Subclasses:

AbstractListener, AdminSocketServer, ArchivePolicy, AwsProductSender, AwsSecretResolver, CLIProductBuilder, DebugProductSender, DefaultIndexerModule, DefaultNotificationReceiver, DefaultStorageListener, DirectoryPoller, ExecutorListenerNotifier, FileProductStorage, FileTrackingListener, JDBCConnection, ProductBuilder, ProductClient, ProductKey, ProductsCreatedAfterClient, RoundRobinListenerNotifier, SearchServerSocket, SignatureVerifier, SnsPublisher, SocketProductSender, WebSocketClient

public class DefaultConfigurable
extends Object
implements Configurable

Default implementation of all methods on the Configurable interface. Classes may override individual methods as needed.

Constructor Summary

Constructors

Constructor	Description
DefaultConfigurable()

Method Summary

Modifier and Type	Method	Description
void	configure(Config config)	Process configuration settings.
String	getName()	Get this object name.
void	setName(String name)	Set this object name.
void	shutdown()	Stop any processing/background threads.
void	startup()	Start any processing/background threads.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultConfigurable

public DefaultConfigurable()

Method Details

configure

public void configure(Config config)
               throws Exception

Process configuration settings. Called before startup().

Specified by:

configure in interface Configurable

Parameters:

config - the Config object with settings.

Throws:

Exception - if configuration exceptions occur.

startup

public void startup()
             throws Exception

Start any processing/background threads.

Specified by:

startup in interface Configurable

Throws:

Exception - if exceptions occur while starting.

shutdown

public void shutdown()
              throws Exception

Stop any processing/background threads.

Specified by:

shutdown in interface Configurable

Throws:

Exception - if exceptions occur while starting.

getName

public String getName()

Description copied from interface: Configurable

Get this object name.

Specified by:

getName in interface Configurable

Returns:

the name.

setName

public void setName(String name)

Description copied from interface: Configurable

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.

Specified by:

setName in interface Configurable

Parameters:

name - the name.