public class XMPPServer extends Object
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 openfire.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 and Description |
---|
XMPPServer()
Creates a server and starts it.
|
Modifier and Type | Method and Description |
---|---|
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.
|
org.xmpp.packet.JID |
createJID(String username,
String resource)
Creates an XMPPAddress local to this server.
|
org.xmpp.packet.JID |
createJID(String username,
String resource,
boolean skipStringprep)
Creates an XMPPAddress local to this server.
|
void |
finishSetup()
Finish the setup process.
|
AdHocCommandHandler |
getAdHocCommandHandler()
Returns the
AdHocCommandHandler registered with this server. |
Collection<org.xmpp.packet.JID> |
getAdmins()
Returns a collection with the JIDs of the server's admins.
|
AuditManager |
getAuditManager()
Returns the
AuditManager registered with this server. |
CertificateStoreManager |
getCertificateStoreManager()
Returns the
CertificateStoreManager 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. |
FlashCrossDomainHandler |
getFlashCrossDomainHandler()
Returns the
FlashCrossDomainHandler registered with this server. |
static XMPPServer |
getInstance()
Returns a singleton instance of XMPPServer.
|
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.
|
IQPEPHandler |
getIQPEPHandler()
Returns the
IQPEPHandler registered with this server. |
IQRegisterHandler |
getIQRegisterHandler()
Returns the
IQRegisterHandler registered with this server. |
IQRouter |
getIQRouter()
Returns the
IQRouter registered with this server. |
LockOutManager |
getLockOutManager()
Returns the
LockOutManager 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. |
MultiUserChatManager |
getMultiUserChatManager()
Returns the
MultiUserChatManager registered with this server. |
NodeID |
getNodeID()
Returns an ID that uniquely identifies this server in a cluster.
|
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. |
RemoteSessionLocator |
getRemoteSessionLocator()
Returns the locator to use to find sessions hosted in other cluster nodes.
|
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.
|
List<ServerIdentitiesProvider> |
getServerIdentitiesProviders()
Returns a list with all the modules that provide "discoverable" identities.
|
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. |
TransportHandler |
getTransportHandler()
Returns the
TransportHandler registered with this server. |
UpdateManager |
getUpdateManager()
Returns the
UpdateManager registered with this server. |
List<UserIdentitiesProvider> |
getUserIdentitiesProviders()
Returns a list with all the modules that provide "discoverable" user identities.
|
List<UserItemsProvider> |
getUserItemsProviders()
Returns a list with all the modules that provide "discoverable" items associated with
users.
|
UserManager |
getUserManager()
Returns the
UserManager registered with this server. |
VCardManager |
getVCardManager()
Returns the
VCardManager registered with this server. |
boolean |
isLocal(org.xmpp.packet.JID jid)
Returns true if the given address is local to the server (managed by this
server domain).
|
boolean |
isRemote(org.xmpp.packet.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 |
isShuttingDown()
Returns true if the server is being shutdown.
|
boolean |
isStandAlone()
Returns if the server is running in standalone mode.
|
boolean |
isStarted()
Returns whether or not the server has been started.
|
boolean |
matchesComponent(org.xmpp.packet.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 |
setNodeID(NodeID nodeID)
Sets an ID that uniquely identifies this server in a cluster.
|
void |
setRemoteSessionLocator(RemoteSessionLocator remoteSessionLocator)
Sets the locator to use to find sessions hosted in other cluster nodes.
|
void |
start() |
void |
stop()
Stops the server only if running in standalone mode.
|
public static final String EXIT
public static XMPPServer getInstance()
public XMPPServerInfo getServerInfo()
public boolean isLocal(org.xmpp.packet.JID jid)
jid
- the JID to check.public boolean isRemote(org.xmpp.packet.JID jid)
jid
- the JID to check.public NodeID getNodeID()
public void setNodeID(NodeID nodeID)
nodeID
- an ID that uniquely identifies this server in a cluster or null if not in a cluster.public boolean matchesComponent(org.xmpp.packet.JID jid)
jid
- the JID to check.public org.xmpp.packet.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 org.xmpp.packet.JID createJID(String username, String resource, boolean skipStringprep)
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.skipStringprep
- true if stringprep should not be applied.public Collection<org.xmpp.packet.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 boolean isShuttingDown()
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 IQPEPHandler getIQPEPHandler()
IQPEPHandler
registered with this server. The
IQPEPHandler
was registered with the server as a module while starting up
the server.IQPEPHandler
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 LockOutManager getLockOutManager()
LockOutManager
registered with this server. The
LockOutManager
was registered with the server as a module while starting up
the server.LockOutManager
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<ServerIdentitiesProvider> getServerIdentitiesProviders()
public List<ServerItemsProvider> getServerItemsProviders()
public List<UserIdentitiesProvider> getUserIdentitiesProviders()
public List<UserItemsProvider> getUserItemsProviders()
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 MultiUserChatManager getMultiUserChatManager()
MultiUserChatManager
registered with this server. The
MultiUserChatManager
was registered with the server as a module while starting up
the server.MultiUserChatManager
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 FlashCrossDomainHandler getFlashCrossDomainHandler()
FlashCrossDomainHandler
registered with this server. The
FlashCrossDomainHandler
was registered with the server as a module while starting up
the server.FlashCrossDomainHandler
registered with this server.public VCardManager getVCardManager()
VCardManager
registered with this server. The
VCardManager
was registered with the server as a module while starting up
the server.VCardManager
registered with this server.public CertificateStoreManager getCertificateStoreManager()
CertificateStoreManager
registered with this server. The
CertificateStoreManager
was registered with the server as a module while starting up
the server.CertificateStoreManager
registered with this server.public RemoteSessionLocator getRemoteSessionLocator()
public void setRemoteSessionLocator(RemoteSessionLocator remoteSessionLocator)
remoteSessionLocator
- the locator to use to find sessions hosted in other cluster nodes.public boolean isStarted()
Copyright © 2003-2008 Jive Software.