Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.util
Class MaintenanceFilter

java.lang.Object
  extended by com.jivesoftware.util.JiveServletFilter
      extended by com.jivesoftware.base.util.MaintenanceFilter
All Implemented Interfaces:
javax.servlet.Filter

public class MaintenanceFilter
extends JiveServletFilter

A filter that checks for the "skin.default.maintenance.enabled=true" Jive property. If the value is true this filter will redirect to the maintenance page.


Field Summary
 
Fields inherited from class com.jivesoftware.util.JiveServletFilter
filterConfig
 
Constructor Summary
MaintenanceFilter()
           
 
Method Summary
 void doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
           
 java.lang.String getMaintenancePage()
           
 void init(javax.servlet.FilterConfig config)
          Loads the maintenance page to redirect to.
 void setMaintenancePage(java.lang.String maintenancePage)
           
 
Methods inherited from class com.jivesoftware.util.JiveServletFilter
destroy, getFilterConfig, setFilterConfig
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MaintenanceFilter

public MaintenanceFilter()
Method Detail

init

public void init(javax.servlet.FilterConfig config)
          throws javax.servlet.ServletException
Loads the maintenance page to redirect to. Param is named "maintenancePage".

Specified by:
init in interface javax.servlet.Filter
Overrides:
init in class JiveServletFilter
Throws:
javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException
Specified by:
doFilter in interface javax.servlet.Filter
Specified by:
doFilter in class JiveServletFilter
Throws:
java.io.IOException
javax.servlet.ServletException

getMaintenancePage

public java.lang.String getMaintenancePage()

setMaintenancePage

public void setMaintenancePage(java.lang.String maintenancePage)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.