edu.internet2.middleware.grouper.ui
Class GrouperUiFilter

java.lang.Object
  extended by edu.internet2.middleware.grouper.ui.GrouperUiFilter
All Implemented Interfaces:
Filter

public class GrouperUiFilter
extends Object
implements Filter

Generic filter for ui for grouper (e.g. set hooks context)

Version:
$Id: GrouperUiFilter.java,v 1.8 2009-10-11 22:04:18 mchyzer Exp $
Author:
Chris Hyzer.

Nested Class Summary
static class GrouperUiFilter.UiSection
          which UI section we are in
 
Constructor Summary
GrouperUiFilter()
           
 
Method Summary
static void assignHttpServlet(HttpServlet httpServlet)
          public method to get the http servlet
 void destroy()
          filter method
 void doFilter(ServletRequest servletRequest, ServletResponse response, FilterChain filterChain)
           
static List<org.apache.commons.fileupload.FileItem> fileItems()
          get the list of file items, cache these in request
static void finallyRequest()
          put this in a request finally block
 void init(FilterConfig config)
           
static GrouperRequestWrapper initRequest(ServletRequest servletRequest, ServletResponse response)
          init request part 1
static String remoteUser(HttpServletRequest httpServletRequest)
           
static Set<String> requestParameterNamesByPrefix(String prefix)
          find the request parameter names by prefix
static HttpServlet retrieveHttpServlet()
          public method to get the http servlet
static HttpServletRequest retrieveHttpServletRequest()
          public method to get the http servlet request
static HttpServletResponse retrieveHttpServletResponse()
          public method to get the http servlet request
static Properties retrieveMediaProperties()
          if the media resource bundle is null, use this
static long retrieveRequestStartMillis()
          if in request, get the start time
static ResourceBundle retrieveSessionMediaResourceBundle()
          get the media resource bundle from session
static ResourceBundle retrieveSessionNavResourceBundle()
          get the nav resource bundle from session
static Subject retrieveSubjectLoggedIn()
          retrieve the subject logged in
static String retrieveUserPrincipalNameFromRequest()
          retrieve the user principal (who is authenticated) from the (threadlocal) request object
 void sendErrorEmailIfNeeded()
          send error email if needed
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GrouperUiFilter

public GrouperUiFilter()
Method Detail

retrieveSessionNavResourceBundle

public static ResourceBundle retrieveSessionNavResourceBundle()
get the nav resource bundle from session

Returns:
the nav resource bundle

retrieveSessionMediaResourceBundle

public static ResourceBundle retrieveSessionMediaResourceBundle()
get the media resource bundle from session

Returns:
the media resource bundle

retrieveMediaProperties

public static Properties retrieveMediaProperties()
if the media resource bundle is null, use this

Returns:
properties

fileItems

public static List<org.apache.commons.fileupload.FileItem> fileItems()
get the list of file items, cache these in request

Returns:
the list of file items

requestParameterNamesByPrefix

public static Set<String> requestParameterNamesByPrefix(String prefix)
find the request parameter names by prefix

Parameters:
prefix -
Returns:
the set, never null

retrieveRequestStartMillis

public static long retrieveRequestStartMillis()
if in request, get the start time

Returns:
the start time

retrieveUserPrincipalNameFromRequest

public static String retrieveUserPrincipalNameFromRequest()
retrieve the user principal (who is authenticated) from the (threadlocal) request object

Returns:
the user principal name

retrieveSubjectLoggedIn

public static Subject retrieveSubjectLoggedIn()
retrieve the subject logged in

Returns:
the subject

remoteUser

public static String remoteUser(HttpServletRequest httpServletRequest)
Parameters:
httpServletRequest -
Returns:
user name

init

public void init(FilterConfig config)
          throws ServletException
Specified by:
init in interface Filter
Throws:
ServletException
See Also:
Filter.init(javax.servlet.FilterConfig)

initRequest

public static GrouperRequestWrapper initRequest(ServletRequest servletRequest,
                                                ServletResponse response)
init request part 1

Parameters:
servletRequest -
response -
Returns:
the request wrapper

finallyRequest

public static void finallyRequest()
put this in a request finally block


doFilter

public void doFilter(ServletRequest servletRequest,
                     ServletResponse response,
                     FilterChain filterChain)
              throws IOException,
                     ServletException
Specified by:
doFilter in interface Filter
Throws:
IOException
ServletException
See Also:
Filter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)

retrieveHttpServletRequest

public static HttpServletRequest retrieveHttpServletRequest()
public method to get the http servlet request

Returns:
the http servlet request

retrieveHttpServlet

public static HttpServlet retrieveHttpServlet()
public method to get the http servlet

Returns:
the http servlet

assignHttpServlet

public static void assignHttpServlet(HttpServlet httpServlet)
public method to get the http servlet

Parameters:
httpServlet - is servlet to assign

retrieveHttpServletResponse

public static HttpServletResponse retrieveHttpServletResponse()
public method to get the http servlet request

Returns:
the http servlet request

destroy

public void destroy()
filter method

Specified by:
destroy in interface Filter
See Also:
Filter.destroy()

sendErrorEmailIfNeeded

public void sendErrorEmailIfNeeded()
send error email if needed