Package org.jivesoftware.openfire.container

Class BasicModule

java.lang.Object
org.jivesoftware.openfire.container.BasicModule
All Implemented Interfaces:
Module
Direct Known Subclasses:
ArchiveManager, AuditManagerImpl, CertificateExpiryChecker, CertificateStoreManager, ConnectionManagerImpl, DefaultFileTransferManager, EntityCapabilitiesManager, FileTransferProxy, InternalComponentManager, IQHandler, IQRouter, MediaProxyService, MessageRouter, MulticastDNSService, MulticastRouter, MultiUserChatManager, OfflineMessageStore, OfflineMessageStrategy, PacketDelivererImpl, PacketRouterImpl, PacketTransporterImpl, PresenceManagerImpl, PresenceRouter, PresenceSubscribeHandler, PresenceUpdateHandler, PrivateStorage, PubSubModule, RosterManager, RoutingTableImpl, SessionManager, SoftwareServerVersionManager, SoftwareVersionManager, TransportHandler, UpdateManager, VCardManager
public class BasicModule extends Object implements Module
A default Module implementation that basically avoids subclasses having to implement the whole Module interface.
Author:
Gaston Dombiak

  • Constructor Details

    • BasicModule

      public BasicModule(String moduleName)

      Create a basic module with the given name.

      Parameters:
      moduleName - The name for the module or null to use the default

  • Method Details

    • getName

      public String getName()

      Obtain the name of the module.

      Specified by:
      getName in interface Module
      Returns:
      The name of the module

    • initialize

      public void initialize(XMPPServer server)

      Initializes the basic module.

      Inheriting classes that choose to override this method MUST call this initialize() method before accessing BasicModule resources.

      Specified by:
      initialize in interface Module
      Parameters:
      server - the server hosting this module.

    • start

      public void start() throws IllegalStateException

      Starts the basic module.

      Inheriting classes that choose to override this method MUST call this start() method before accessing BasicModule resources.

      Specified by:
      start in interface Module
      Throws:
      IllegalStateException - If start is called before initialize successfully returns

    • stop

      public void stop()

      Stops the basic module.

      Inheriting classes that choose to override this method MUST call this stop() method before accessing BasicModule resources.

      Specified by:
      stop in interface Module

    • destroy

      public void destroy()

      Destroys the module.

      Does nothing in the basic module.

      Specified by:
      destroy in interface Module