GwtRemoteInspectorImpl (Metawidget API Documentation)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
    - - com.google.gwt.user.server.rpc.RemoteServiceServlet
      - org.metawidget.inspector.gwt.remote.server.GwtRemoteInspectorImpl

All Implemented Interfaces:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, GwtRemoteInspector
```
public class GwtRemoteInspectorImpl
extends com.google.gwt.user.server.rpc.RemoteServiceServlet
implements GwtRemoteInspector
```
Servlet for running inspections in GWT environments.
This servlet recognizes the following <init-param>'s:
- config - fully qualified path to (optional) metawidget.xml, for example com/foo/metawidget.xml.
This Inspector is designed to work 'out of the box' for most cases. However, use of Serializable as a parameter type is not optimal for GWT. We recommend deriving your own interface with your own business-model-specific base class instead.
Author:

Richard Kennard

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`GwtRemoteInspectorImpl.GwtRemoteInspectorImplPipeline` Use the Pipeline for its Inspector/InspectionResultProcessor support.

Field Summary
- Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
  perThreadRequest, perThreadResponse

Constructor Summary

Constructors
Constructor and Description

GwtRemoteInspectorImpl()

Constructors
Constructor and Description
`GwtRemoteInspectorImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected String`	`getConfigInitParameter()` Refactored to support `GwtRemoteInspectorTestImpl`.
`void`	`init(javax.servlet.ServletConfig servletConfig)`
`String`	`inspect(Serializable toInspect, String type, String[] names)` Inspect the given Serializable/type using server-side processing and return the result.
`protected GwtRemoteInspectorImpl.GwtRemoteInspectorImplPipeline`	`newPipeline()` Instantiate the Pipeline used by this Metawidget.
`void`	`setInspectionResultProcessors(InspectionResultProcessor<GwtRemoteInspectorImpl>... inspectionResultProcessors)`
`void`	`setInspector(Inspector inspector)`

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet
checkPermutationStrongName, doGetSerializationPolicy, getSerializationPolicy, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processPost, shouldCompressResponse

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
doPost, doUnexpectedFailure, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

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

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

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

- Constructor Detail
  - GwtRemoteInspectorImpl
```
public GwtRemoteInspectorImpl()
```
- Method Detail
  - init
```
public void init(javax.servlet.ServletConfig servletConfig)
          throws javax.servlet.ServletException
```
    Specified by:
    
    init in interface javax.servlet.Servlet
    
    Overrides:
    
    init in class javax.servlet.GenericServlet
    
    Throws:
    
    javax.servlet.ServletException
  - inspect
```
public String inspect(Serializable toInspect,
             String type,
             String[] names)
```
    Inspect the given Serializable/type using server-side processing and return the result.
    
    Specified by:
    
    inspect in interface GwtRemoteInspector
    
    Returns:
    String the inspection result, converted to an XML string. Serialization should be relatively fast because it is using XmlUtils.nodeToString. Deserialization should be relatively fast because it is using the browser's native XmlParser.parse, not JavaScript.
  - setInspector
```
public void setInspector(Inspector inspector)
```
  - setInspectionResultProcessors
```
public void setInspectionResultProcessors(InspectionResultProcessor<GwtRemoteInspectorImpl>... inspectionResultProcessors)
```
  - newPipeline
```
protected GwtRemoteInspectorImpl.GwtRemoteInspectorImplPipeline newPipeline()
```
    Instantiate the Pipeline used by this Metawidget.
    Subclasses wishing to use their own Pipeline should override this method to instantiate their version.
  - getConfigInitParameter
```
protected String getConfigInitParameter()
```
    Refactored to support GwtRemoteInspectorTestImpl.

Class GwtRemoteInspectorImpl

Nested Class Summary

Field Summary

Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

Constructor Summary

Method Summary

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Constructor Detail

GwtRemoteInspectorImpl

Method Detail

init

inspect

setInspector

setInspectionResultProcessors

newPipeline

getConfigInitParameter