Package org.glassfish.admin.rest.model

Class RestCollectionResponseBody<T extends RestModel>

java.lang.Object

org.glassfish.admin.rest.model.ResponseBody

org.glassfish.admin.rest.model.RestCollectionResponseBody<T>

public class RestCollectionResponseBody<T extends RestModel>
extends ResponseBody

Used to return a standard REST response body that contains a collection of entities

Author:

tmoreau

Field Summary

Fields inherited from class org.glassfish.admin.rest.model.ResponseBody

EVENT_NAME

Constructor Summary

Constructors

Constructor	Description
RestCollectionResponseBody(boolean includeResourceLinks, jakarta.ws.rs.core.UriInfo uriInfo, String collectionName)
RestCollectionResponseBody(jakarta.ws.rs.core.UriInfo uriInfo, String collectionName)

Method Summary

Modifier and Type	Method	Description
void	addItem(T item, String name)
void	addItem(T item, String collectionName, String name, URI uri)
void	addItem(T item, String name, URI uri)
String	getCollectionName()
List<T>	getItems()
jakarta.ws.rs.core.UriInfo	getUriInfo()
protected void	populateJson(jakarta.json.JsonObject object)
void	setCollectionName(String collectionName)
void	setItems(List<T> items)
void	setUriInfo(jakarta.ws.rs.core.UriInfo uriInfo)

Methods inherited from class org.glassfish.admin.rest.model.ResponseBody

add, add, addActionResourceLink, addFailure, addFailure, addFailure, addMessage, addMessage, addParentResourceLink, addResourceLink, addResourceLink, addSuccess, addWarning, getMessages, getResourceLinks, setIncludeResourceLinks, setMessages, setResourceLinks, toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestCollectionResponseBody

public RestCollectionResponseBody(jakarta.ws.rs.core.UriInfo uriInfo,
                                  String collectionName)

RestCollectionResponseBody

public RestCollectionResponseBody(boolean includeResourceLinks,
                                  jakarta.ws.rs.core.UriInfo uriInfo,
                                  String collectionName)

Method Detail

getCollectionName

public String getCollectionName()

setCollectionName

public void setCollectionName(String collectionName)

getUriInfo

public jakarta.ws.rs.core.UriInfo getUriInfo()

setUriInfo

public void setUriInfo(jakarta.ws.rs.core.UriInfo uriInfo)

getItems

public List<T> getItems()

setItems

public void setItems(List<T> items)

addItem

public void addItem(T item,
                    String name)

addItem

public void addItem(T item,
                    String name,
                    URI uri)

addItem

public void addItem(T item,
                    String collectionName,
                    String name,
                    URI uri)

populateJson

protected void populateJson(jakarta.json.JsonObject object)
                     throws jakarta.json.JsonException

Overrides:

populateJson in class ResponseBody

Throws:

jakarta.json.JsonException