Jive Messenger 2.2.2 Javadoc

org.jivesoftware.util
Class WebManager

java.lang.Object
  extended by org.jivesoftware.util.WebBean
      extended by org.jivesoftware.util.WebManager

public class WebManager
extends WebBean

A utility bean for Messenger admin console pages.


Field Summary
 
Fields inherited from class org.jivesoftware.util.WebBean
application, out, request, response, session
 
Constructor Summary
WebManager()
           
 
Method Summary
 void addBreadCrumb(String name, String url)
           
static void copy(URL src, File dst)
          Copies the contents at src to dst.
 AuthToken getAuthToken()
          Returns the auth token redirects to the login page if an auth token is not found.
 Map getBreadCrumbs()
           
 int getBreadcrumbSize()
           
 int getCurrentPage()
           
 GroupManager getGroupManager()
           
 WebManager getManager()
           
 MultiUserChatServer getMultiUserChatServer()
           
 PresenceManager getPresenceManager()
           
 PrivateStorage getPrivateStore()
           
 int getRange()
           
 int getRefreshValue(String pageName, int defaultValue)
          Returns the number of seconds between each page refresh for the specified page for the current logged user.
 RosterManager getRosterManager()
           
 int getRowsPerPage(String pageName, int defaultValue)
          Returns the number of rows per page for the specified page for the current logged user.
 XMPPServerInfo getServerInfo()
           
 SessionManager getSessionManager()
           
 String getSidebar()
           
 int getStart()
           
 String getTitle()
           
 User getUser()
          Returns the page user or null if one is not found.
 UserManager getUserManager()
           
 XMPPServer getXMPPServer()
          Returns the XMPP server object -- can get many config items from here.
 boolean isEmbedded()
          Returns true if the server is in embedded mode, false otherwise.
 boolean isServerRunning()
           
 boolean isSetupMode()
          Returns true if the Messenger container is in setup mode, false otherwise.
 void restart()
          Restarts the server then sleeps for 3 seconds.
 void setPageProperty(String pageName, String property, int newValue)
           
 void setRange(int range)
           
 void setRefreshValue(String pageName, int newValue)
          Sets the number of seconds between each page refresh for the specified page for the current logged user.
 void setRowsPerPage(String pageName, int newValue)
          Sets the new number of rows per page for the specified page for the current logged user.
 void setSidebar(String sidebar)
           
 void setStart(int start)
           
 void setTitle(String title)
           
protected  void showServerDown()
           
 void stop()
          Stops the server then sleeps for 3 seconds.
 void validateService()
           
 
Methods inherited from class org.jivesoftware.util.WebBean
init, init, init
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebManager

public WebManager()
Method Detail

getAuthToken

public AuthToken getAuthToken()
Returns the auth token redirects to the login page if an auth token is not found.


isSetupMode

public boolean isSetupMode()
Returns true if the Messenger container is in setup mode, false otherwise.


getXMPPServer

public XMPPServer getXMPPServer()
Returns the XMPP server object -- can get many config items from here.


getUserManager

public UserManager getUserManager()

getGroupManager

public GroupManager getGroupManager()

getRosterManager

public RosterManager getRosterManager()

getPrivateStore

public PrivateStorage getPrivateStore()

getPresenceManager

public PresenceManager getPresenceManager()

getSessionManager

public SessionManager getSessionManager()

getMultiUserChatServer

public MultiUserChatServer getMultiUserChatServer()

getServerInfo

public XMPPServerInfo getServerInfo()

getUser

public User getUser()
Returns the page user or null if one is not found.


isEmbedded

public boolean isEmbedded()
Returns true if the server is in embedded mode, false otherwise.


restart

public void restart()
Restarts the server then sleeps for 3 seconds.


stop

public void stop()
Stops the server then sleeps for 3 seconds.


getManager

public WebManager getManager()

validateService

public void validateService()

isServerRunning

public boolean isServerRunning()

addBreadCrumb

public void addBreadCrumb(String name,
                          String url)

getBreadCrumbs

public Map getBreadCrumbs()

setSidebar

public void setSidebar(String sidebar)

getSidebar

public String getSidebar()

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

getBreadcrumbSize

public int getBreadcrumbSize()

setStart

public void setStart(int start)

getStart

public int getStart()

setRange

public void setRange(int range)

getRange

public int getRange()

getCurrentPage

public int getCurrentPage()

showServerDown

protected void showServerDown()

copy

public static void copy(URL src,
                        File dst)
                 throws IOException
Copies the contents at src to dst.

Throws:
IOException

getRowsPerPage

public int getRowsPerPage(String pageName,
                          int defaultValue)
Returns the number of rows per page for the specified page for the current logged user. The rows per page value is stored as a user property. The same property is being used for different pages. The encoding format is the following "pageName1=value,pageName2=value".

Parameters:
pageName - the name of the page to look up its stored value.
defaultValue - the default value to return if no user value was found.
Returns:
the number of rows per page for the specified page for the current logged user.

setRowsPerPage

public void setRowsPerPage(String pageName,
                           int newValue)
Sets the new number of rows per page for the specified page for the current logged user. The rows per page value is stored as a user property. The same property is being used for different pages. The encoding format is the following "pageName1=value,pageName2=value".

Parameters:
pageName - the name of the page to stored its new value.
newValue - the new rows per page value.

getRefreshValue

public int getRefreshValue(String pageName,
                           int defaultValue)
Returns the number of seconds between each page refresh for the specified page for the current logged user. The value is stored as a user property. The same property is being used for different pages. The encoding format is the following "pageName1=value,pageName2=value".

Parameters:
pageName - the name of the page to look up its stored value.
defaultValue - the default value to return if no user value was found.
Returns:
the number of seconds between each page refresh for the specified page for the current logged user.

setRefreshValue

public void setRefreshValue(String pageName,
                            int newValue)
Sets the number of seconds between each page refresh for the specified page for the current logged user. The value is stored as a user property. The same property is being used for different pages. The encoding format is the following "pageName1=value,pageName2=value".

Parameters:
pageName - the name of the page to stored its new value.
newValue - the new number of seconds between each page refresh.

setPageProperty

public void setPageProperty(String pageName,
                            String property,
                            int newValue)

Jive Messenger 2.2.2 Javadoc

Copyright © 1999-2004 Jive Software.