2525import net .sf .json .JSON ;
2626import net .sf .json .JSONArray ;
2727import net .sf .json .JSONObject ;
28- import org .apache .commons .lang .BooleanUtils ;
2928import org .apache .commons .lang .math .NumberUtils ;
3029
3130import java .lang .reflect .Constructor ;
3231import java .util .ArrayList ;
33- import java .util .HashMap ;
3432import java .util .List ;
35- import java .util .Map ;
3633
3734/**
3835 * A base class for Agile resources.
3936 *
37+ * @author pldupont
4038 * @see "https://docs.atlassian.com/jira-software/REST/cloud/"
4139 */
4240public abstract class AgileResource {
@@ -51,15 +49,16 @@ public abstract class AgileResource {
5149 private long id = 0 ;
5250 private String name ;
5351 private String self ;
54- private Map < String , Object > attributes = new HashMap < String , Object > ();
52+ private JSONObject attributes = new JSONObject ();
5553
5654 /**
5755 * Creates a new Agile resource.
5856 *
5957 * @param restclient REST client instance
6058 * @param json JSON payload
59+ * @throws JiraException when the retrieval fails
6160 */
62- public AgileResource (RestClient restclient , JSONObject json ) {
61+ public AgileResource (RestClient restclient , JSONObject json ) throws JiraException {
6362 this .restclient = restclient ;
6463 if (json != null ) {
6564 deserialize (json );
@@ -73,8 +72,9 @@ public AgileResource(RestClient restclient, JSONObject json) {
7372 * @param r a JSONObject instance
7473 * @param restclient REST client instance
7574 * @return a Resource instance or null if r isn't a JSONObject instance
75+ * @throws JiraException when the retrieval fails
7676 */
77- private static <T extends AgileResource > T getResource (
77+ protected static <T extends AgileResource > T getResource (
7878 Class <T > type , Object r , RestClient restclient ) throws JiraException {
7979
8080 if (!(r instanceof JSONObject )) {
@@ -101,26 +101,29 @@ private static <T extends AgileResource> T getResource(
101101 * @param type Resource data type
102102 * @param ra a JSONArray instance
103103 * @param restclient REST client instance
104+ * @param listName The name of the list of items from the JSON result.
104105 * @return a list of Resources found in ra
106+ * @throws JiraException when the retrieval fails
105107 */
106- private static <T extends AgileResource > List <T > getResourceArray (
107- Class <T > type , Object ra , RestClient restclient ) throws JiraException {
108+ protected static <T extends AgileResource > List <T > getResourceArray (
109+ Class <T > type , Object ra , RestClient restclient , String listName ) throws JiraException {
108110 if (!(ra instanceof JSONObject )) {
109111 throw new JiraException ("JSON payload is malformed" );
110112 }
111113
112114 JSONObject jo = (JSONObject ) ra ;
113115
114- if (!jo .containsKey ("values" ) || !(jo .get ("values" ) instanceof JSONArray )) {
116+ if (!jo .containsKey (listName ) || !(jo .get (listName ) instanceof JSONArray )) {
115117 throw new JiraException (type .getSimpleName () + " result is malformed" );
116118 }
117119
118120 List <T > results = new ArrayList <T >();
119121
120- for (Object v : (JSONArray ) jo .get ("values" )) {
122+ for (Object v : (JSONArray ) jo .get (listName )) {
121123 T item = getResource (type , v , restclient );
122- if (item != null )
124+ if (item != null ) {
123125 results .add (item );
126+ }
124127 }
125128
126129 return results ;
@@ -130,10 +133,28 @@ private static <T extends AgileResource> List<T> getResourceArray(
130133 * Retrieves all boards visible to the session user.
131134 *
132135 * @param restclient REST client instance
136+ * @param type The type of the object to deserialize.
137+ * @param url The URL to call.
138+ * @return a list of boards
139+ * @throws JiraException when the retrieval fails
140+ */
141+ static <T extends AgileResource > List <T > list (
142+ RestClient restclient , Class <T > type , String url ) throws JiraException {
143+ return list (restclient , type , url , "values" );
144+ }
145+
146+ /**
147+ * Retrieves all boards visible to the session user.
148+ *
149+ * @param restclient REST client instance
150+ * @param type The type of the object to deserialize.
151+ * @param url The URL to call.
152+ * @param listName The name of the list of items in the JSON response.
133153 * @return a list of boards
134154 * @throws JiraException when the retrieval fails
135155 */
136- static <T extends AgileResource > List <T > list (RestClient restclient , Class <T > type , String url ) throws JiraException {
156+ static <T extends AgileResource > List <T > list (
157+ RestClient restclient , Class <T > type , String url , String listName ) throws JiraException {
137158
138159 JSON result ;
139160 try {
@@ -145,7 +166,8 @@ static <T extends AgileResource> List<T> list(RestClient restclient, Class<T> ty
145166 return getResourceArray (
146167 type ,
147168 result ,
148- restclient
169+ restclient ,
170+ listName
149171 );
150172 }
151173
@@ -172,6 +194,44 @@ static <T extends AgileResource> T get(RestClient restclient, Class<T> type, Str
172194 );
173195 }
174196
197+ /**
198+ * Extract from a sub list the Resource array, if present.
199+ *
200+ * @param type Resource data type
201+ * @param subJson a JSONObject instance
202+ * @param resourceName The name of the list of items from the JSON result.
203+ * @param <T> The type of Agile resource to return.
204+ * @return The list of resources if present.
205+ * @throws JiraException when the retrieval fails
206+ */
207+ <T extends AgileResource > List <T > getSubResourceArray (
208+ Class <T > type , JSONObject subJson , String resourceName ) throws JiraException {
209+ List <T > result = null ;
210+ if (subJson .containsKey (resourceName )) {
211+ result = getResourceArray (type , subJson .get (resourceName ), getRestclient (), resourceName + "s" );
212+ }
213+ return result ;
214+ }
215+
216+ /**
217+ * Extract from a sub list the Resource, if present.
218+ *
219+ * @param type Resource data type
220+ * @param subJson a JSONObject instance
221+ * @param resourceName The name of the item from the JSON result.
222+ * @param <T> The type of Agile resource to return.
223+ * @return The resource if present.
224+ * @throws JiraException when the retrieval fails
225+ */
226+ <T extends AgileResource > T getSubResource (
227+ Class <T > type , JSONObject subJson , String resourceName ) throws JiraException {
228+ T result = null ;
229+ if (subJson .containsKey (resourceName )) {
230+ result = getResource (type , subJson .get (resourceName ), getRestclient ());
231+ }
232+ return result ;
233+ }
234+
175235 /**
176236 * @return Internal JIRA ID.
177237 */
@@ -186,6 +246,13 @@ public String getName() {
186246 return name ;
187247 }
188248
249+ /**
250+ * @param name Setter for the resource name. In some case, the name is called something else.
251+ */
252+ void setName (String name ) {
253+ this .name = name ;
254+ }
255+
189256 /**
190257 * @return The resource URL.
191258 */
@@ -206,47 +273,36 @@ protected RestClient getRestclient() {
206273 * @param name The name of the attribute to retrieve.
207274 * @return The value of the attribute.
208275 */
209- String getAttribute (String name ) {
276+ public Object getAttribute (String name ) {
210277 return (String ) attributes .get (name );
211278 }
212279
213- /**
214- * Retrieve the specified attribute as a generic object.
215- *
216- * @param name The name of the attribute to retrieve.
217- * @return The value of the attribute.
218- */
219- int getAttributeAsInt (String name ) {
220- return NumberUtils .toInt (getAttribute (name ), 0 );
221- }
222-
223- /**
224- * Retrieve the specified attribute as a generic object.
225- *
226- * @param name The name of the attribute to retrieve.
227- * @return The value of the attribute.
228- */
229- boolean getAttributeAsBoolean (String name ) {
230- return BooleanUtils .toBoolean (getAttribute (name ));
231- }
232-
233280 /**
234281 * Deserialize the json to extract standard attributes and keep a reference of
235282 * other attributes.
236283 *
237284 * @param json The JSON object to read.
238285 */
239- protected void deserialize (JSONObject json ) {
286+ void deserialize (JSONObject json ) throws JiraException {
240287
241288 id = getLong (json .get ("id" ));
242289 name = Field .getString (json .get ("name" ));
243290 self = Field .getString (json .get ("self" ));
291+ addAttributes (json );
292+ }
293+
294+ /**
295+ * Allow to add more attributes.
296+ *
297+ * @param json The json object to extract attributes from.
298+ */
299+ void addAttributes (JSONObject json ) {
244300 attributes .putAll (json );
245301 }
246302
247303 long getLong (Object o ) {
248304 if (o instanceof Integer || o instanceof Long ) {
249- return Field .getInteger (o );
305+ return Field .getLong (o );
250306 } else if (o instanceof String && NumberUtils .isDigits ((String ) o )) {
251307 return NumberUtils .toLong ((String ) o , 0L );
252308 } else {
0 commit comments