How to include parent class fields in json response using struts 2 json plugin

Question

I have following implementation

public abstract class BaseAcion extends ActionSupport {
    private String result;
    private String message;

    //getters, setters
}

public class MyAction extends BaseAction {
    private String myFirstField;
    private String mySecondField;

    public String execute() {
         ...
         myFirstField = "someValue";
         mySecondField = "someOtherValue";
         ...
         result = SUCCESS;
         message = "Some message here";
         ...
         return result;
    }

    //methods, getters, setters
}

I have used struts2-json plugin, action mapping is

<package name="my-package" namespace="/" extends="json-default" >
    <action name="myAction" class="MyAction">
        <result type="json"></result>
    </action> 
</package>

The response that I receive is something like this.

{
    "myFirstField":"someValue",
    "mySecondField":"someOtherValue"
}

I want to get "result" and "message" fields in response as well.

How can I include BaseAction fields in json response?

Umesh Awasthi · Accepted Answer · 2012-04-10 06:16:01Z

13

By default properties defined on base classes of the "root" object won't be serialized, to serialize properties in all base classes (up to Object) set "ignoreHierarchy" to false in the JSON result:

Something like

<result type="json">
  <param name="ignoreHierarchy">false</param>
</result>

For details refer to the JSON plugin documentation

JSONPlugin-BaseClasses

answered Apr 10, 2012 at 6:16

Umesh Awasthi

23.6k38 gold badges141 silver badges212 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Bilal Over a year ago

thank you. But It will serialize all properties of parent. I just want two property of parent in json. I guess I have to use "excludeProperties" in each action mapping. Is there any cleaner way ?

Umesh Awasthi Over a year ago

yes that's the way to exclude them else create an inner class within your Action that contains just the information you want to include in the JSON and set it as the base/root object to marshal.

Bilal Over a year ago

Instead of creating inner class in each action, I think it's better to extend JSON Result Type in my own way. I am going to dive into json plugin. Thanks Umesh for your valuable solution and ideas.

Umesh Awasthi Over a year ago

You can even create an inner class in your base action and use that as root object or can use reg expression for including/excluding properties

Collectives™ on Stack Overflow

How to include parent class fields in json response using struts 2 json plugin

1 Answer 1

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related