1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*******************************************************************************
* Copyright (c) 2012-2014 University of Stuttgart.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and the Apache License 2.0 which both accompany this distribution,
* and are available at http://www.eclipse.org/legal/epl-v10.html
* and http://www.apache.org/licenses/LICENSE-2.0
*
* Contributors:
* Oliver Kopp - initial API and implementation
*******************************************************************************/
package org.eclipse.winery.repository.resources._support.collections;
import java.util.ArrayList;
import java.util.List;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import org.eclipse.winery.common.Util;
import org.eclipse.winery.repository.datatypes.select2.Select2DataItem;
import org.eclipse.winery.repository.resources._support.IPersistable;
import org.restdoc.annotations.RestDoc;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.sun.jersey.api.NotFoundException;
import com.sun.jersey.api.view.Viewable;
/**
* Class managing a list of entities. It is intended to manage subresources,
* which are stored in a list. Either all entities have a unique key given by
* the TOSCA specification (subclass EntityWithIdCollectionResource) or a unique
* key is generated (subclass EntityWithoutIdCollectionResource)
*
* @param <EntityResourceT> the resource modeling the entity
* @param <EntityT> the entity type of single items in the list
*/
public abstract class EntityCollectionResource<EntityResourceT extends EntityResource<EntityT>, EntityT> implements IIdDetermination<EntityT> {
private static final Logger logger = LoggerFactory.getLogger(EntityCollectionResource.class);
protected final List<EntityT> list;
protected final IPersistable res;
protected final Class<EntityT> entityTClazz;
protected final Class<EntityResourceT> entityResourceTClazz;
/**
* @param clazz the class of EntityT. Required as it is not possible to call
* new EntityT (see http://stackoverflow.com/a/1090488/873282)
* @param list the list of entities contained in this resource. Has to be
* typed <Object> as not all TOSCA elements in the specification
* inherit from TExtensibleElements
* @param res the main resource the list is belonging to. Required for
* persistence.
*/
public EntityCollectionResource(Class<EntityResourceT> entityResourceTClazz, Class<EntityT> entityTClazz, List<EntityT> list, IPersistable res) {
this.entityResourceTClazz = entityResourceTClazz;
this.entityTClazz = entityTClazz;
this.list = list;
this.res = res;
}
/**
* Returns a list of ids of all entities nested here
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
public Object getListOfAllEntityIds(@QueryParam("select2") String select2) {
if (select2 == null) {
return this.getListOfAllEntityIdsAsList();
} else {
// return data ready for consumption by select2
List<Select2DataItem> res = new ArrayList<Select2DataItem>(this.list.size());
for (EntityT o : this.list) {
String id = this.getId(o);
Select2DataItem di = new Select2DataItem(id, id);
res.add(di);
}
return res;
}
}
public List<String> getListOfAllEntityIdsAsList() {
List<String> res = new ArrayList<String>(this.list.size());
for (EntityT o : this.list) {
// We assume that different Object serializations *always* have different hashCodes
res.add(this.getId(o));
}
return res;
}
/**
* Required by reqandcapdefs.jsp
*/
public List<EntityResourceT> getAllEntityResources() {
List<String> listOfAllSubResources = this.getListOfAllEntityIdsAsList();
List<EntityResourceT> res = new ArrayList<EntityResourceT>(listOfAllSubResources.size());
for (String id : listOfAllSubResources) {
res.add(this.getEntityResourceFromDecodedId(id));
}
return res;
}
public EntityResourceT getEntityResourceFromDecodedId(String id) {
EntityT entity = null;
int idx = -1;
for (EntityT c : this.list) {
idx++;
String cId = this.getId(c);
if (cId.equals(id)) {
entity = c;
break;
}
}
if (entity == null) {
throw new NotFoundException();
} else {
return this.getEntityResourceInstance(entity, idx);
}
}
@Path("{id}/")
public EntityResourceT getEntityResource(@PathParam("id") String id) {
if (id == null) {
throw new IllegalArgumentException("id has to be given");
}
id = Util.URLdecode(id);
return this.getEntityResourceFromDecodedId(id);
}
/**
* @param entity the entity to create a resource for
* @param idx the index in the list
* @return the resource managing the given entity
*/
protected abstract EntityResourceT getEntityResourceInstance(EntityT entity, int idx);
@GET
@Produces(MediaType.TEXT_HTML)
@RestDoc(methodDescription = "@return the HTML fragment (DIV-container) to be embedded in the 'Interface' part of nodetype.js ")
public Response getHTMLAsResponse() {
Viewable viewable = this.getHTML();
return Response.ok().header(HttpHeaders.VARY, HttpHeaders.ACCEPT).entity(viewable).build();
}
/**
* called by getHTMLAsResponse
*/
public abstract Viewable getHTML();
/**
* Adds a new entity
*
* In case the element already exists, we return "CONFLICT"
*/
@POST
@Consumes({MediaType.TEXT_XML, MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
public Response addNewElement(EntityT entity) {
if (entity == null) {
return Response.status(Status.BAD_REQUEST).entity("a valid XML/JSON element has to be posted").build();
}
if (this.alreadyContains(entity)) {
// we do not replace the element, but replace it
return Response.status(Status.CONFLICT).build();
}
this.list.add(entity);
return CollectionsHelper.persist(this.res, this, entity);
}
@Override
public abstract String getId(EntityT entity);
/**
* Checks for containment of e in the list. <code>equals</code> is not used
* as most EntityT do not offer a valid implementation
*
* @return true if list already contains e.
*/
public boolean alreadyContains(EntityT e) {
String id = this.getId(e);
for (EntityT el : this.list) {
if (this.getId(el).equals(id)) {
// break loop
// we found an equal list item
return true;
}
}
// all items checked: nothing equal contained
return false;
}
}
|
