Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.im
Class IMSettingsUtils

java.lang.Object
  extended by com.jivesoftware.forum.im.IMSettingsUtils

public class IMSettingsUtils
extends java.lang.Object

Contains static utility methods for accessing XMPP configuration settings as well as other IM settings.


Method Summary
static ForumsChatSettings getChatSettings()
          Returns a ForumsChatSettings instance.
 int getXMPP_SSLPort()
          Returns the port to use for SSL XMPP connections.
static int getXMPPAdminPort()
          Returns the port of the admin console of the configured Wildfire server.
static java.lang.String getXMPPHost()
          Returns the host name of the configured XMPP server.
static int getXMPPPort()
          Returns the port of the configured XMPP server.
static boolean isAIMPresenceEnabled()
          Returns true if AOL IM presence has been enabled in the admin console.
static boolean isGroupChatEnabled()
          Returns true if XMPP integration is enabled.
static boolean isGuestChatEnabled()
          Returns true if guest group chat (which requires no login) is enabled.
static boolean isRegisteredChatEnabled()
          Returns true if registered group chat (which requires login) is enabled.
static boolean isXMMPPresenceEnabled()
          Returns true if XMPP presence has been enabled in the admin console.
 boolean isXMPP_SSLEnabled()
          Returns true if forums is configured to connect to an XMPP server via SSL.
static boolean isXMPPConfigured()
           
static void setSettings(ForumsChatSettings settings)
          Sets the ForumsChatSettings for this installation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isGroupChatEnabled

public static boolean isGroupChatEnabled()
Returns true if XMPP integration is enabled.

Returns:
true if XMPP integration is enabled.

isRegisteredChatEnabled

public static boolean isRegisteredChatEnabled()
Returns true if registered group chat (which requires login) is enabled.

Returns:
true if registered group chat is enabled.

isGuestChatEnabled

public static boolean isGuestChatEnabled()
Returns true if guest group chat (which requires no login) is enabled.

Returns:
true if guest group chat is enabled.

isXMPPConfigured

public static boolean isXMPPConfigured()

isXMMPPresenceEnabled

public static boolean isXMMPPresenceEnabled()
Returns true if XMPP presence has been enabled in the admin console.

Returns:
true if XMPP presence is enabled.

isAIMPresenceEnabled

public static boolean isAIMPresenceEnabled()
Returns true if AOL IM presence has been enabled in the admin console.

Returns:
true if AOL IM presence is enabled

getXMPPHost

public static java.lang.String getXMPPHost()
Returns the host name of the configured XMPP server.

Returns:
the host name of the configured XMPP server.

getXMPPPort

public static int getXMPPPort()
Returns the port of the configured XMPP server.

Returns:
the port of the configured XMPP server.

getXMPPAdminPort

public static int getXMPPAdminPort()
Returns the port of the admin console of the configured Wildfire server. Returns zero if no Wildfire server is configured.

Returns:
the port of the Wildfire admin console.

isXMPP_SSLEnabled

public boolean isXMPP_SSLEnabled()
Returns true if forums is configured to connect to an XMPP server via SSL.

Returns:
true if forums is configured to connect to an XMPP server via SSL.

getXMPP_SSLPort

public int getXMPP_SSLPort()
Returns the port to use for SSL XMPP connections.

Returns:
the port to use for SSL XMPP connections.

getChatSettings

public static ForumsChatSettings getChatSettings()
Returns a ForumsChatSettings instance. If no IM settings have ever been set in the admin console, an instance with default values is returned. (Ports will be set to default values, boolean flags will be false, and hostname will be null.)

Returns:
a ForumsChatSettings instance.

setSettings

public static void setSettings(ForumsChatSettings settings)
Sets the ForumsChatSettings for this installation. The settings will be immediately written to the file system.

Parameters:
settings - the ForumsChatSettings for this installation.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.