GridServlet (Apache OODT 0.7 API)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - org.apache.oodt.grid.GridServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

ConfigServlet, LoginServlet, QueryServlet
```
public abstract class GridServlet
extends javax.servlet.http.HttpServlet
```
Grid servlet is an abstract servlet that provides basic behavior (configuration access) for grid servlets.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
GridServlet()

Constructors
Constructor and Description
`GridServlet()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected boolean`	`approveAccess(Configuration config, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` Check if administrative access is allowed.
`void`	`doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` By default, grid servlets are POST only, so GETs get you the welcome page.
`protected ConfigBean`	`getConfigBean(javax.servlet.http.HttpServletRequest req)` Get the config bean.
`protected Configuration`	`getConfiguration()` Get the configuration.

Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

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

- Constructor Detail
  - GridServlet
```
public GridServlet()
```
- Method Detail
  - doGet
```
public void doGet(javax.servlet.http.HttpServletRequest req,
         javax.servlet.http.HttpServletResponse res)
           throws IOException,
                  javax.servlet.ServletException
```
    By default, grid servlets are POST only, so GETs get you the welcome page.
    
    Overrides:
    
    doGet in class javax.servlet.http.HttpServlet
    
    Parameters:
    req - a HttpServletRequest value.
    res - a HttpServletResponse value.
    
    Throws:
    
    IOException - if an error occurs.
    
    javax.servlet.ServletException - if an error occurs.
  - getConfiguration
```
protected Configuration getConfiguration()
                                  throws javax.servlet.ServletException,
                                         IOException
```
    Get the configuration.
    
    Returns:
    a Configuration value.
    
    Throws:
    
    javax.servlet.ServletException - if an error occurs.
    
    IOException - if an error occurs.
  - getConfigBean
```
protected ConfigBean getConfigBean(javax.servlet.http.HttpServletRequest req)
                            throws javax.servlet.ServletException,
                                   IOException
```
    Get the config bean.
    
    Parameters:
    req - a HttpServletRequest value.
    
    Returns:
    a ConfigBean value.
    
    Throws:
    
    javax.servlet.ServletException - if an error occurs.
    
    IOException - if an error occurs.
  - approveAccess
```
protected boolean approveAccess(Configuration config,
                    javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse res)
                         throws IOException
```
    Check if administrative access is allowed. This examines the request scheme (http, ftp, https, etc.) and sees if https is required by the configuration. It also checks the remote host and sees if localhost access is required.
    
    Parameters:
    config - a Configuration value.
    req - a HttpServletRequest value.
    res - a HttpServletResponse value.
    
    Returns:
    True if access is approved, false otherwise.
    
    Throws:
    
    IOException - if an error occurs.

Class GridServlet

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Constructor Detail

GridServlet

Method Detail

doGet

getConfiguration

getConfigBean

approveAccess