NotReadyFilter (Hyperic HQ Plugin API)
Keywords: org.hyperic.util.notReady.NotReadyFilter class

Overview | Package | Class | Tree | Deprecated | Index | Help
| Hyperic HQ Plugin API v. 4.4.0.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.hyperic.util.notReady
Class NotReadyFilter

    java.lang.Object
      org.hyperic.util.notReady.NotReadyFilter

All Implemented Interfaces:
  javax.servlet.Filter

    public class NotReadyFilter

extends java.lang.Object
implements javax.servlet.Filter

A simple filter that will return 503 ( Service unavailable ) until the setReady(true) is called. It can be used by HQ or any other app to reject requests until all initialization is completed. To use it, just insert it in the web.xml, and map all the URIs of interest through this filter. When all subsystems are initialized and started, call setReady(). Another option is to use the AuthenticationFilter ( for the HQ UI ) and the AgentCallbackBossEJBImpl ( for agent callbacks ). In any case - the critical step is figuring when all things are started correctly, and calling the method that will unlock the filter.

Constructor Summary
`NotReadyFilter()`

Method Summary
`void` | `destroy()`
`void` | `doFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain)`
`void` | `init(javax.servlet.FilterConfig filterConfig)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### NotReadyFilter

    public NotReadyFilter()

Method Detail

### init

    public void init(javax.servlet.FilterConfig filterConfig)
              throws javax.servlet.ServletException

  Specified by:
    `init` in interface `javax.servlet.Filter`
  Throws:
    `javax.servlet.ServletException`

### doFilter

    public void doFilter(javax.servlet.ServletRequest servletRequest,
                         javax.servlet.ServletResponse servletResponse,
                         javax.servlet.FilterChain filterChain)
                  throws java.io.IOException,
                         javax.servlet.ServletException

  Specified by:
    `doFilter` in interface `javax.servlet.Filter`
  Throws:
    `java.io.IOException`
    `javax.servlet.ServletException`

### destroy

    public void destroy()

  Specified by:
    `destroy` in interface `javax.servlet.Filter`

Overview | Package | Class | Tree | Deprecated | Index | Help
| Hyperic HQ Plugin API v. 4.4.0.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.