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
A default Module implementation that basically avoids subclasses having to implement the whole
Module interface.
- Author:
- Gaston Dombiak
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
Destroys the module.getName()
Obtain the name of the module.void
initialize
(XMPPServer server) Initializes the basic module.void
start()
Starts the basic module.void
stop()
Stops the basic module.
-
Constructor Details
-
BasicModule
Create a basic module with the given name.
- Parameters:
moduleName
- The name for the module or null to use the default
-
-
Method Details
-
getName
Obtain the name of the module.
-
initialize
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 interfaceModule
- Parameters:
server
- the server hosting this module.
-
start
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 interfaceModule
- 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.
-
destroy
public void destroy()Destroys the module.
Does nothing in the basic module.
-