GenericResponse (Beadledom (Parent) 2.9 API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

BuiltGenericResponse, DelegatingGenericResponse
```
public interface GenericResponse<T>
extends Closeable
```
A JAX-RS based response with additional generic information about the response entity body.
This simplifies the consumption of a response with an entity body by tracking the type information of the response entity and allowing direct access to the body via the body() method.
To get the most value out of this class it should be used as part of a JAX-RS Resource interface definition that is shared by both a server implementation and a client auto-generated proxy. Some value can still be had by using this for client auto-generated proxies only.
Note: this is an interface, rather than an abstract class like Response, so that implementations can implement both Response and GenericResponse.

Since:

1.3

Author:

John Leacox

See Also:

Response

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`body()` Get the response entity body, `null` if no entity body is present.
`void`	`close()` Closes the underlying response input stream.
`ErrorBody`	`errorBody()` Get the error body, `null` if the response is not an error or no entity body is present.
`Set<String>`	`getAllowedMethods()` Gets the allowed HTTP methods.
`Map<String,javax.ws.rs.core.NewCookie>`	`getCookies()` Gets any new cookies on the response.
`Date`	`getDate()` Gets the resposne date, `null` if not present.
`javax.ws.rs.core.EntityTag`	`getEntityTag()` Gets the entity tag.
`javax.ws.rs.core.MultivaluedMap<String,Object>`	`getHeaders()` Gets a view of the response headers.
`String`	`getHeaderString(String name)` Gets a response header as a string value.
`Locale`	`getLanguage()` Gets the language of the response entity, `null` if not specified.
`Date`	`getLastModified()` Gets the last modified date, `null` if not present.
`int`	`getLength()` Gets the `Content-Length` of the response if present, `-1` otherwise.
`javax.ws.rs.core.Link`	`getLink(String relation)` Gets the link for the relation, `null` if not present.
`javax.ws.rs.core.Link.Builder`	`getLinkBuilder(String relation)` Returns a link builder for the relation, `null` if not present.
`Set<javax.ws.rs.core.Link>`	`getLinks()` Gets the links from the response headers.
`URI`	`getLocation()` Gets the location, `null` if not present.
`javax.ws.rs.core.MediaType`	`getMediaType()` Gets the response entity media type, or `null` of there is no response entity.
`int`	`getStatus()` Get the status of the response response.
`javax.ws.rs.core.Response.StatusType`	`getStatusInfo()` Get the status of the response response.
`javax.ws.rs.core.MultivaluedMap<String,String>`	`getStringHeaders()` Gets a view of the response headers.
`boolean`	`hasLink(String relation)` Returns true if a link exists for the specified relation, false otherwise.
`boolean`	`isSuccessful()` Returns true if `getStatus()` is in the range [200..300), false otherwise.

- Method Detail
  - isSuccessful
```
boolean isSuccessful()
```
    Returns true if getStatus() is in the range [200..300), false otherwise.
  - body
```
T body()
```
    Get the response entity body, null if no entity body is present.
  - errorBody
```
ErrorBody errorBody()
```
    Get the error body, null if the response is not an error or no entity body is present.
  - getStatus
```
int getStatus()
```
    Get the status of the response response.
  - getStatusInfo
```
javax.ws.rs.core.Response.StatusType getStatusInfo()
```
    Get the status of the response response.
  - close
```
void close()
```
    Closes the underlying response input stream.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Throws:
    
    javax.ws.rs.ProcessingException - if an error occurs while closing the response
    
    See Also:
    
    Response.close()
  - getMediaType
```
javax.ws.rs.core.MediaType getMediaType()
```
    Gets the response entity media type, or null of there is no response entity.
  - getLanguage
```
Locale getLanguage()
```
    Gets the language of the response entity, null if not specified.
  - getLength
```
int getLength()
```
    Gets the Content-Length of the response if present, -1 otherwise.
  - getAllowedMethods
```
Set<String> getAllowedMethods()
```
    Gets the allowed HTTP methods.
  - getCookies
```
Map<String,javax.ws.rs.core.NewCookie> getCookies()
```
    Gets any new cookies on the response.
  - getEntityTag
```
javax.ws.rs.core.EntityTag getEntityTag()
```
    Gets the entity tag.
  - getDate
```
Date getDate()
```
    Gets the resposne date, null if not present.
  - getLastModified
```
Date getLastModified()
```
    Gets the last modified date, null if not present.
  - getLocation
```
URI getLocation()
```
    Gets the location, null if not present.
  - getLinks
```
Set<javax.ws.rs.core.Link> getLinks()
```
    Gets the links from the response headers.
    
    See Also:
    
    Response.getLinks()
  - hasLink
```
boolean hasLink(String relation)
```
    Returns true if a link exists for the specified relation, false otherwise.
  - getLink
```
javax.ws.rs.core.Link getLink(String relation)
```
    Gets the link for the relation, null if not present.
    
    See Also:
    
    Response.getLink(String)
  - getLinkBuilder
```
javax.ws.rs.core.Link.Builder getLinkBuilder(String relation)
```
    Returns a link builder for the relation, null if not present.
    
    See Also:
    
    Response.getLinkBuilder(String)
  - getHeaders
```
javax.ws.rs.core.MultivaluedMap<String,Object> getHeaders()
```
    Gets a view of the response headers.
    
    See Also:
    
    Response.getHeaders(), getStringHeaders(), getHeaderString(java.lang.String)
  - getStringHeaders
```
javax.ws.rs.core.MultivaluedMap<String,String> getStringHeaders()
```
    Gets a view of the response headers.
    
    See Also:
    
    Response.getStringHeaders(), getHeaders(), getHeaderString(java.lang.String)
  - getHeaderString
```
String getHeaderString(String name)
```
    Gets a response header as a string value.
    If the header contains multiple values, they will be joined by a ',' character, null if the header is not present.
    
    See Also:
    
    Response.getHeaderString(String), getHeaders(), getHeaderString(java.lang.String)

Interface GenericResponse<T>

Method Summary

Method Detail

isSuccessful

body

errorBody

getStatus

getStatusInfo

close

getMediaType

getLanguage

getLength

getAllowedMethods

getCookies

getEntityTag

getDate

getLastModified

getLocation

getLinks

hasLink

getLink

getLinkBuilder

getHeaders

getStringHeaders

getHeaderString