Struts2 json response using $.getJSON results undefined response

Question

I'm trying to get a String value from action class using $.getJSON method, but I'm getting the result as undefined. Here are the code snippets which I have tried with

Script:

$(function() {
        $("#newPostionFormID").submit(
                function() {
                    var formInput = $(this).serialize();
                    $.getJSON('../employeeShifts/addnewposition.action',
                            formInput, function(jsonResponse) {
                                console.log(jsonResponse.positionAdded);
                            });
                    return false;
                });
    });

strus.xml:

<package name="employeeShifts" namespace="/employeeShifts"
                extends="struts-default,json-default">
     <action name="addnewposition" 
        class="com.vgt.intranet.employeeshifts.action.EmployeeShiftAction"
                    method="addNewPosition">
                    <result type="json">
                        <!-- <param name="excludeNullProperties">true</param>
                        <param name="noCache">true</param>
                        <param name="root">positionAdded</param> -->
                    </result>
        </action>
   </package>

action class:

public class EmployeeShiftAction extends ActionSupport {
private String position;
private String positionAdded;

public String addNewPosition() {
    log.info("inside addNewPosition");
    position = this.getPosition();
    log.info("Position: " + position);
    positionAdded = position;
    log.info("positionAdded: " + positionAdded);
    return Action.SUCCESS;
}

public String getPosition() {
    return position;
}

public void setPosition(String position) {
    this.position = position;
}

public String getPositionAdded() {
    return positionAdded;
}

public void setPositionAdded(String positionAdded) {
    this.positionAdded = positionAdded;
}

Console Log:

undefined

I don't know where I went wrong? any help appreciated.

Answer 1

In the console log you print jsonResponse.positionAdded, but you don't have a property positionAdded in the JSON returned by the action. To access this property you should return JSON result

<result type="json">
    <!-- <param name="excludeNullProperties">true</param> -->
    <param name="noCache">true</param>
</result> 

Answer 2

You can define multiple objects as out parameters using inlcude params.. By default some times , a JSON call will automatically calls all the funtions/methods in that controller which have their method names starting with 'get'.. So make sure this doesn't happen.

<result type="json">
<param name="excludeNullProperties">true</param>
     <param name="ignoreHierarchy">false</param>
     <param name="includeProperties">list1.*,list2.*,string</param>
</result>

Answer 3

You should code in your action class for json.You should return back json data to client side.In my situation i have used GSON that it is a java library that can be used to convert Java Objects into their JSON representation.GSON(https://code.google.com/p/google-gson/) Have a look here.You can not retrieve json data in your client side until you have return back json data from your action class.Try to convert positionAdded to JSON data from your action class.

I would suggest for your client side,this script:

 jQuery.ajax(
                        {
                            type: 'POST',
                            url:'../employeeShifts/addnewposition.action',,
                            dataType: 'json',
                            success:function(data){
                                var dat=data.positionAdded
                                //alert(dat);
                                var obj = jQuery.parseJSON(dat);

                                            alert(obj);

                },
                            error:function(data1,data2,data3){
                                //alert("error");

                                alert(data3);
                            }



                    });

Answer 4

Thanks you for all. Here I'm posting the final working struts configuration as an answer with your responses.

<result type="json">
    <param name="root">action</param>
    <param name="includeProperties">positionAdded</param>
    <param name="excludeNullProperties">true</param>
    <param name="noCache">true</param>
</result>