Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts2.interceptor.debugging
Class DebuggingInterceptor

    java.lang.Object
      org.apache.struts2.interceptor.debugging.DebuggingInterceptor

All Implemented Interfaces:
  Interceptor, java.io.Serializable

    public class DebuggingInterceptor

extends java.lang.Object
implements Interceptor

Provides several different debugging screens to provide insight into the data behind the page. The value of the 'debug' request parameter determines the screen:

- `xml` - Dumps the parameters, context, session, and value stack as an XML document.
- `console` - Shows a popup 'OGNL Console' that allows the user to test OGNL expressions against the value stack. The XML data from the 'xml' mode is inserted at the top of the page.
- `command` - Tests an OGNL expression and returns the string result. Only used by the OGNL console.
- `browser` Shows field values of an object specified in the `object`parameter (#context by default). When the `object`parameters is set, the '#' character needs to be escaped to '%23'. Like debug=browser&object=%23parameters````

Example: http://localhost:8080/Welcome.action?debug=xml

This interceptor only is activated when devMode is enabled in struts.properties. The 'debug' parameter is removed from the parameter list before the action is executed. All operations occur before the natural Result has a chance to execute.

See Also:
  Serialized Form

Constructor Summary
`DebuggingInterceptor()`

Method Summary
`void` | `destroy()` Unused.
`void` | `init()` Unused.
`java.lang.String` | `intercept(ActionInvocation inv)`
`protected void` | `printContext()` Prints the current context to the response in XML format.
`protected void` | `printContext(PrettyPrintWriter writer)` Prints the current request to the existing writer.
`protected void` | `serializeIt(java.lang.Object bean, java.lang.String name, PrettyPrintWriter writer, java.util.List<java.lang.Object> stack)` Recursive function to serialize objects to XML.
`void` | `setDevMode(java.lang.String mode)`
`void` | `setEnableXmlWithConsole(boolean enableXmlWithConsole)`
`void` | `setFreemarkerManager(FreemarkerManager mgr)`
`void` | `setReflectionProvider(ReflectionProvider reflectionProvider)`

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

Constructor Detail

### DebuggingInterceptor

    public DebuggingInterceptor()

Method Detail

### setDevMode

    public void setDevMode(java.lang.String mode)

### setFreemarkerManager

    public void setFreemarkerManager(FreemarkerManager mgr)

### setReflectionProvider

    public void setReflectionProvider(ReflectionProvider reflectionProvider)

### init

    public void init()

  Unused.

  Specified by:
    `init` in interface `Interceptor`

### destroy

    public void destroy()

  Unused.

  Specified by:
    `destroy` in interface `Interceptor`

### intercept

    public java.lang.String intercept(ActionInvocation inv)
                               throws java.lang.Exception

  Specified by:
    `intercept` in interface `Interceptor`
  Throws:
    `java.lang.Exception`

### printContext

    protected void printContext()

  Prints the current context to the response in XML format.

### printContext

    protected void printContext(PrettyPrintWriter writer)

  Prints the current request to the existing writer.

  Parameters:
    `writer` - The XML writer

### serializeIt

    protected void serializeIt(java.lang.Object bean,
                               java.lang.String name,
                               PrettyPrintWriter writer,
                               java.util.List<java.lang.Object> stack)

  Recursive function to serialize objects to XML. Currently it will serialize Collections, maps, Arrays, and JavaBeans. It maintains a stack of objects serialized already in the current functioncall. This is used to avoid looping (stack overflow) of circular linked objects. Struts and XWork objects are ignored.

  Parameters:
    `bean` - The object you want serialized.
    `name` - The name of the object, used for element <name/>
    `writer` - The XML writer
    `stack` - List of objects we're serializing since the first calling of this function (to prevent looping on circular references).

### setEnableXmlWithConsole

    public void setEnableXmlWithConsole(boolean enableXmlWithConsole)

  Parameters:
    `enableXmlWithConsole` - the enableXmlWithConsole to set

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.