|
Wildfire 3.2.4 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.wildfire.XMPPServer
public class XMPPServer
The main XMPP server that will load, initialize and start all the server's
modules. The server is unique in the JVM and could be obtained by using the
getInstance()
method.
The loaded modules will be initialized and may access through the server other modules. This means that the only way for a module to locate another module is through the server. The server maintains a list of loaded modules.
After starting up all the modules the server will load any available plugin. For more information see:
PluginManager
.A configuration file keeps the server configuration. This information is required for the server to work correctly. The server assumes that the configuration file is named wildfire.xml and is located in the conf folder. The folder that keeps the configuration file must be located under the home folder. The server will try different methods to locate the home folder.
Constructor Summary | |
---|---|
XMPPServer()
Creates a server and starts it. |
Method Summary | |
---|---|
void |
addServerListener(XMPPServerListener listener)
Adds a new server listener that will be notified when the server has been started or is about to be stopped. |
JID |
createJID(String username,
String resource)
Creates an XMPPAddress local to this server. |
void |
finishSetup()
Finish the setup process. |
AdHocCommandHandler |
getAdHocCommandHandler()
Returns the AdHocCommandHandler registered with this server. |
Collection<JID> |
getAdmins()
Returns a collection with the JIDs of the server's admins. |
AuditManager |
getAuditManager()
Returns the AuditManager registered with this server. |
ConnectionManager |
getConnectionManager()
Returns the ConnectionManager registered with this server. |
FileTransferManager |
getFileTransferManager()
Returns the FileTransferManager registered with this server. |
FileTransferProxy |
getFileTransferProxy()
Returns the FileTransferProxy registered with this server. |
static XMPPServer |
getInstance()
Returns a singleton instance of XMPPServer. |
IQAuthHandler |
getIQAuthHandler()
Returns the IQAuthHandler registered with this server. |
IQDiscoInfoHandler |
getIQDiscoInfoHandler()
Returns the IQDiscoInfoHandler registered with this server. |
IQDiscoItemsHandler |
getIQDiscoItemsHandler()
Returns the IQDiscoItemsHandler registered with this server. |
List<IQHandler> |
getIQHandlers()
Returns a list with all the modules registered with the server that inherit from IQHandler. |
IQRegisterHandler |
getIQRegisterHandler()
Returns the IQRegisterHandler registered with this server. |
IQRouter |
getIQRouter()
Returns the IQRouter registered with this server. |
MediaProxyService |
getMediaProxyService()
Returns the MediaProxyService registered with this server. |
MessageRouter |
getMessageRouter()
Returns the MessageRouter registered with this server. |
MulticastRouter |
getMulticastRouter()
Returns the MulticastRouter registered with this server. |
MultiUserChatServer |
getMultiUserChatServer()
Returns the MultiUserChatServer registered with this server. |
OfflineMessageStore |
getOfflineMessageStore()
Returns the OfflineMessageStore registered with this server. |
OfflineMessageStrategy |
getOfflineMessageStrategy()
Returns the OfflineMessageStrategy registered with this server. |
PacketDeliverer |
getPacketDeliverer()
Returns the PacketDeliverer registered with this server. |
PacketRouter |
getPacketRouter()
Returns the PacketRouter registered with this server. |
PluginManager |
getPluginManager()
Returns the PluginManager instance registered with this server. |
PresenceManager |
getPresenceManager()
Returns the PresenceManager registered with this server. |
PresenceRouter |
getPresenceRouter()
Returns the PresenceRouter registered with this server. |
PresenceSubscribeHandler |
getPresenceSubscribeHandler()
Returns the PresenceSubscribeHandler registered with this server. |
PresenceUpdateHandler |
getPresenceUpdateHandler()
Returns the PresenceUpdateHandler registered with this server. |
PrivateStorage |
getPrivateStorage()
Returns the PrivateStorage registered with this server. |
PubSubModule |
getPubSubModule()
Returns the PubSubModule registered with this server. |
RosterManager |
getRosterManager()
Returns the RosterManager registered with this server. |
RoutingTable |
getRoutingTable()
Returns the RoutingTable registered with this server. |
List<ServerFeaturesProvider> |
getServerFeaturesProviders()
Returns a list with all the modules that provide "discoverable" features. |
XMPPServerInfo |
getServerInfo()
Returns a snapshot of the server's status. |
List<ServerItemsProvider> |
getServerItemsProviders()
Returns a list with all the modules that provide "discoverable" items associated with the server. |
SessionManager |
getSessionManager()
Returns the SessionManager registered with this server. |
STUNService |
getSTUNService()
Returns the STUNService registered with this server. |
TransportHandler |
getTransportHandler()
Returns the TransportHandler registered with this server. |
UpdateManager |
getUpdateManager()
Returns the UpdateManager registered with this server. |
UserManager |
getUserManager()
Returns the UserManager registered with this server. |
boolean |
isLocal(JID jid)
Returns true if the given address is local to the server (managed by this server domain). |
boolean |
isRemote(JID jid)
Returns true if the given address does not match the local server hostname and does not match a component service JID. |
boolean |
isRestartable()
|
boolean |
isSetupMode()
|
boolean |
isStandAlone()
Returns if the server is running in standalone mode. |
boolean |
matchesComponent(JID jid)
Returns true if the given address matches a component service JID. |
void |
removeServerListener(XMPPServerListener listener)
Removes a server listener that was being notified when the server was being started or was about to be stopped. |
void |
restart()
Restarts the server and all it's modules only if the server is restartable. |
void |
restartHTTPServer()
Restarts the HTTP server only when running in stand alone mode. |
void |
start()
|
void |
stop()
Stops the server only if running in standalone mode. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMPPServer()
Method Detail |
---|
public static XMPPServer getInstance()
public XMPPServerInfo getServerInfo()
public boolean isLocal(JID jid)
jid
- the JID to check.
public boolean isRemote(JID jid)
jid
- the JID to check.
public boolean matchesComponent(JID jid)
jid
- the JID to check.
public JID createJID(String username, String resource)
username
- the user name portion of the id or null to indicate none is needed.resource
- the resource portion of the id or null to indicate none is needed.
public Collection<JID> getAdmins()
public void addServerListener(XMPPServerListener listener)
listener
- the new server listener to add.public void removeServerListener(XMPPServerListener listener)
listener
- the server listener to remove.public void finishSetup()
public void start()
public void restart()
public void restartHTTPServer()
public void stop()
public boolean isSetupMode()
public boolean isRestartable()
public boolean isStandAlone()
public ConnectionManager getConnectionManager()
ConnectionManager
registered with this server. The
ConnectionManager
was registered with the server as a module while starting up
the server.
ConnectionManager
registered with this server.public RoutingTable getRoutingTable()
RoutingTable
registered with this server. The
RoutingTable
was registered with the server as a module while starting up
the server.
RoutingTable
registered with this server.public PacketDeliverer getPacketDeliverer()
PacketDeliverer
registered with this server. The
PacketDeliverer
was registered with the server as a module while starting up
the server.
PacketDeliverer
registered with this server.public RosterManager getRosterManager()
RosterManager
registered with this server. The
RosterManager
was registered with the server as a module while starting up
the server.
RosterManager
registered with this server.public PresenceManager getPresenceManager()
PresenceManager
registered with this server. The
PresenceManager
was registered with the server as a module while starting up
the server.
PresenceManager
registered with this server.public OfflineMessageStore getOfflineMessageStore()
OfflineMessageStore
registered with this server. The
OfflineMessageStore
was registered with the server as a module while starting up
the server.
OfflineMessageStore
registered with this server.public OfflineMessageStrategy getOfflineMessageStrategy()
OfflineMessageStrategy
registered with this server. The
OfflineMessageStrategy
was registered with the server as a module while starting
up the server.
OfflineMessageStrategy
registered with this server.public PacketRouter getPacketRouter()
PacketRouter
registered with this server. The
PacketRouter
was registered with the server as a module while starting up
the server.
PacketRouter
registered with this server.public IQRegisterHandler getIQRegisterHandler()
IQRegisterHandler
registered with this server. The
IQRegisterHandler
was registered with the server as a module while starting up
the server.
IQRegisterHandler
registered with this server.public IQAuthHandler getIQAuthHandler()
IQAuthHandler
registered with this server. The
IQAuthHandler
was registered with the server as a module while starting up
the server.
IQAuthHandler
registered with this server.public PluginManager getPluginManager()
PluginManager
instance registered with this server.
public PubSubModule getPubSubModule()
PubSubModule
registered with this server. The
PubSubModule
was registered with the server as a module while starting up
the server.
PubSubModule
registered with this server.public List<IQHandler> getIQHandlers()
public SessionManager getSessionManager()
SessionManager
registered with this server. The
SessionManager
was registered with the server as a module while starting up
the server.
SessionManager
registered with this server.public TransportHandler getTransportHandler()
TransportHandler
registered with this server. The
TransportHandler
was registered with the server as a module while starting up
the server.
TransportHandler
registered with this server.public PresenceUpdateHandler getPresenceUpdateHandler()
PresenceUpdateHandler
registered with this server. The
PresenceUpdateHandler
was registered with the server as a module while starting
up the server.
PresenceUpdateHandler
registered with this server.public PresenceSubscribeHandler getPresenceSubscribeHandler()
PresenceSubscribeHandler
registered with this server. The
PresenceSubscribeHandler
was registered with the server as a module while
starting up the server.
PresenceSubscribeHandler
registered with this server.public IQRouter getIQRouter()
IQRouter
registered with this server. The
IQRouter
was registered with the server as a module while starting up
the server.
IQRouter
registered with this server.public MessageRouter getMessageRouter()
MessageRouter
registered with this server. The
MessageRouter
was registered with the server as a module while starting up
the server.
MessageRouter
registered with this server.public PresenceRouter getPresenceRouter()
PresenceRouter
registered with this server. The
PresenceRouter
was registered with the server as a module while starting up
the server.
PresenceRouter
registered with this server.public MulticastRouter getMulticastRouter()
MulticastRouter
registered with this server. The
MulticastRouter
was registered with the server as a module while starting up
the server.
MulticastRouter
registered with this server.public UserManager getUserManager()
UserManager
registered with this server. The
UserManager
was registered with the server as a module while starting up
the server.
UserManager
registered with this server.public UpdateManager getUpdateManager()
UpdateManager
registered with this server. The
UpdateManager
was registered with the server as a module while starting up
the server.
UpdateManager
registered with this server.public AuditManager getAuditManager()
AuditManager
registered with this server. The
AuditManager
was registered with the server as a module while starting up
the server.
AuditManager
registered with this server.public List<ServerFeaturesProvider> getServerFeaturesProviders()
public List<ServerItemsProvider> getServerItemsProviders()
public IQDiscoInfoHandler getIQDiscoInfoHandler()
IQDiscoInfoHandler
registered with this server. The
IQDiscoInfoHandler
was registered with the server as a module while starting up
the server.
IQDiscoInfoHandler
registered with this server.public IQDiscoItemsHandler getIQDiscoItemsHandler()
IQDiscoItemsHandler
registered with this server. The
IQDiscoItemsHandler
was registered with the server as a module while starting up
the server.
IQDiscoItemsHandler
registered with this server.public PrivateStorage getPrivateStorage()
PrivateStorage
registered with this server. The
PrivateStorage
was registered with the server as a module while starting up
the server.
PrivateStorage
registered with this server.public MultiUserChatServer getMultiUserChatServer()
MultiUserChatServer
registered with this server. The
MultiUserChatServer
was registered with the server as a module while starting up
the server.
MultiUserChatServer
registered with this server.public AdHocCommandHandler getAdHocCommandHandler()
AdHocCommandHandler
registered with this server. The
AdHocCommandHandler
was registered with the server as a module while starting up
the server.
AdHocCommandHandler
registered with this server.public FileTransferProxy getFileTransferProxy()
FileTransferProxy
registered with this server. The
FileTransferProxy
was registered with the server as a module while starting up
the server.
FileTransferProxy
registered with this server.public FileTransferManager getFileTransferManager()
FileTransferManager
registered with this server. The
FileTransferManager
was registered with the server as a module while starting up
the server.
FileTransferProxy
registered with this server.public MediaProxyService getMediaProxyService()
MediaProxyService
registered with this server. The
MediaProxyService
was registered with the server as a module while starting up
the server.
MediaProxyService
registered with this server.public STUNService getSTUNService()
STUNService
registered with this server. The
MediaProxyService
was registered with the server as a module while starting up
the server.
STUNService
registered with this server.
|
Wildfire 3.2.4 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |