|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.jersey.api.client.filter.Filterable
com.sun.jersey.api.client.WebResource
public final class WebResource
An encapsulation of a Web resource capable of building requests to send to the Web resource and processing responses returned from the Web resource.
A WebResource instance is obtained from the Client
.
The Web resource implements the UniformInterface
to invoke the HTTP
method on the Web resource. A client request may be built before invocation
on the uniform interface.
Methods to create a request and return a response are thread-safe. Methods that modify filters are not guaranteed to be thread-safe.
Nested Class Summary | |
---|---|
class |
WebResource.Builder
The builder for building a ClientRequest instance and
handling the request using the UniformInterface . |
Method Summary | ||
---|---|---|
WebResource.Builder |
accept(javax.ws.rs.core.MediaType... types)
Add acceptable media types. |
|
WebResource.Builder |
accept(java.lang.String... types)
Add acceptable media types. |
|
WebResource.Builder |
acceptLanguage(java.util.Locale... locales)
Add acceptable languages |
|
WebResource.Builder |
acceptLanguage(java.lang.String... locales)
Add acceptable languages |
|
WebResource.Builder |
cookie(javax.ws.rs.core.Cookie cookie)
Add a cookie to be set. |
|
void |
delete()
Invoke the DELETE method with no request entity or response. |
|
|
delete(java.lang.Class<T> c)
Invoke the DELETE method with no request entity that returns a response. |
|
|
delete(java.lang.Class<T> c,
java.lang.Object requestEntity)
Invoke the DELETE method with a request entity that returns a response. |
|
|
delete(GenericType<T> gt)
Invoke the DELETE method with a request entity that returns a response. |
|
|
delete(GenericType<T> gt,
java.lang.Object requestEntity)
Invoke the DELETE method with a request entity that returns a response. |
|
void |
delete(java.lang.Object requestEntity)
Invoke the DELETE method with a request entity but no response. |
|
WebResource.Builder |
entity(java.lang.Object entity)
Set the request entity. |
|
WebResource.Builder |
entity(java.lang.Object entity,
javax.ws.rs.core.MediaType type)
Set the request entity it's media type. |
|
WebResource.Builder |
entity(java.lang.Object entity,
java.lang.String type)
Set the request entity it's media type. |
|
|
get(java.lang.Class<T> c)
Invoke the GET method. |
|
|
get(GenericType<T> gt)
Invoke the GET method. |
|
javax.ws.rs.core.UriBuilder |
getBuilder()
Get the URI builder to the resource. |
|
java.net.URI |
getURI()
Get the URI to the resource. |
|
ClientResponse |
head()
Invoke the HEAD method. |
|
WebResource.Builder |
header(java.lang.String name,
java.lang.Object value)
Add an HTTP header and value. |
|
void |
method(java.lang.String method)
Invoke a HTTP method with no request entity or response. |
|
|
method(java.lang.String method,
java.lang.Class<T> c)
Invoke a HTTP method with no request entity that returns a response. |
|
|
method(java.lang.String method,
java.lang.Class<T> c,
java.lang.Object requestEntity)
Invoke a HTTP method with a request entity that returns a response. |
|
|
method(java.lang.String method,
GenericType<T> gt)
Invoke a HTTP method with no request entity that returns a response. |
|
|
method(java.lang.String method,
GenericType<T> gt,
java.lang.Object requestEntity)
Invoke a HTTP method with a request entity that returns a response. |
|
void |
method(java.lang.String method,
java.lang.Object requestEntity)
Invoke a HTTP method with a request entity but no response. |
|
|
options(java.lang.Class<T> c)
Invoke the OPTIONS method. |
|
|
options(GenericType<T> gt)
Invoke the OPTIONS method. |
|
WebResource |
path(java.lang.String path)
Create a new WebResource from this web resource with an additional path added to the URI of this web resource. |
|
void |
post()
Invoke the POST method with no request entity or response. |
|
|
post(java.lang.Class<T> c)
Invoke the POST method with no request entity that returns a response. |
|
|
post(java.lang.Class<T> c,
java.lang.Object requestEntity)
Invoke the POST method with a request entity that returns a response. |
|
|
post(GenericType<T> gt)
Invoke the POST method with a request entity that returns a response. |
|
|
post(GenericType<T> gt,
java.lang.Object requestEntity)
Invoke the POST method with a request entity that returns a response. |
|
void |
post(java.lang.Object requestEntity)
Invoke the POST method with a request entity but no response. |
|
void |
put()
Invoke the PUT method with no request entity or response. |
|
|
put(java.lang.Class<T> c)
Invoke the PUT method with no request entity that returns a response. |
|
|
put(java.lang.Class<T> c,
java.lang.Object requestEntity)
Invoke the PUT method with a request entity that returns a response. |
|
|
put(GenericType<T> gt)
Invoke the PUT method with a request entity that returns a response. |
|
|
put(GenericType<T> gt,
java.lang.Object requestEntity)
Invoke the PUT method with a request entity that returns a response. |
|
void |
put(java.lang.Object requestEntity)
Invoke the PUT method with a request entity but no response. |
|
WebResource.Builder |
type(javax.ws.rs.core.MediaType type)
Set the media type. |
|
WebResource.Builder |
type(java.lang.String type)
Set the media type. |
|
WebResource |
uri(java.net.URI uri)
Create a new WebResource from this web resource. |
Methods inherited from class com.sun.jersey.api.client.filter.Filterable |
---|
addFilter, getHeadHandler, removeAllFilters, removeFilter |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public java.net.URI getURI()
public javax.ws.rs.core.UriBuilder getBuilder()
public ClientResponse head()
UniformInterface
head
in interface UniformInterface
public <T> T options(java.lang.Class<T> c)
UniformInterface
options
in interface UniformInterface
T
- the type of the response.c
- the type of the returned response.
c
.public <T> T options(GenericType<T> gt)
UniformInterface
options
in interface UniformInterface
T
- the type of the response.gt
- the generic type of the returned response.
public <T> T get(java.lang.Class<T> c)
UniformInterface
get
in interface UniformInterface
T
- the type of the response.c
- the type of the returned response.
c
.public <T> T get(GenericType<T> gt)
UniformInterface
get
in interface UniformInterface
T
- the type of the response.gt
- the generic type of the returned response.
public void put()
UniformInterface
If the status code is less than 300 and a representation is present then that representation is ignored.
put
in interface UniformInterface
public void put(java.lang.Object requestEntity)
UniformInterface
If the status code is less than 300 and a representation is present then that representation is ignored.
put
in interface UniformInterface
requestEntity
- the request entity.public <T> T put(java.lang.Class<T> c)
UniformInterface
put
in interface UniformInterface
T
- the type of the response.c
- the type of the returned response.
c
.public <T> T put(GenericType<T> gt)
UniformInterface
put
in interface UniformInterface
T
- the type of the response.gt
- the generic type of the returned response.
public <T> T put(java.lang.Class<T> c, java.lang.Object requestEntity)
UniformInterface
put
in interface UniformInterface
T
- the type of the response.c
- the type of the returned response.requestEntity
- the request entity.
c
.public <T> T put(GenericType<T> gt, java.lang.Object requestEntity)
UniformInterface
put
in interface UniformInterface
T
- the type of the response.gt
- the generic type of the returned response.requestEntity
- the request entity.
public void post()
UniformInterface
If the status code is less than 300 and a representation is present then that representation is ignored.
post
in interface UniformInterface
public void post(java.lang.Object requestEntity)
UniformInterface
If the status code is less than 300 and a representation is present then that representation is ignored.
post
in interface UniformInterface
requestEntity
- the request entity.public <T> T post(java.lang.Class<T> c)
UniformInterface
post
in interface UniformInterface
T
- the type of the response.c
- the type of the returned response.
c
.public <T> T post(GenericType<T> gt)
UniformInterface
post
in interface UniformInterface
T
- the type of the response.gt
- the generic type of the returned response.
public <T> T post(java.lang.Class<T> c, java.lang.Object requestEntity)
UniformInterface
post
in interface UniformInterface
T
- the type of the response.c
- the type of the returned response.requestEntity
- the request entity.
c
.public <T> T post(GenericType<T> gt, java.lang.Object requestEntity)
UniformInterface
post
in interface UniformInterface
T
- the type of the response.gt
- the generic type of the returned response.requestEntity
- the request entity.
public void delete()
UniformInterface
If the status code is less than 300 and a representation is present then that representation is ignored.
delete
in interface UniformInterface
public void delete(java.lang.Object requestEntity)
UniformInterface
If the status code is less than 300 and a representation is present then that representation is ignored.
delete
in interface UniformInterface
requestEntity
- the request entity.public <T> T delete(java.lang.Class<T> c)
UniformInterface
delete
in interface UniformInterface
T
- the type of the response.c
- the type of the returned response.
c
.public <T> T delete(GenericType<T> gt)
UniformInterface
delete
in interface UniformInterface
T
- the type of the response.gt
- the generic type of the returned response.
public <T> T delete(java.lang.Class<T> c, java.lang.Object requestEntity)
UniformInterface
delete
in interface UniformInterface
T
- the type of the response.c
- the type of the returned response.requestEntity
- the request entity.
c
.public <T> T delete(GenericType<T> gt, java.lang.Object requestEntity)
UniformInterface
delete
in interface UniformInterface
T
- the type of the response.gt
- the generic type of the returned response.requestEntity
- the request entity.
public void method(java.lang.String method)
UniformInterface
If the status code is less than 300 and a representation is present then that representation is ignored.
method
in interface UniformInterface
method
- the HTTP method.public void method(java.lang.String method, java.lang.Object requestEntity)
UniformInterface
If the status code is less than 300 and a representation is present then that representation is ignored.
method
in interface UniformInterface
method
- the HTTP method.requestEntity
- the request entity.public <T> T method(java.lang.String method, java.lang.Class<T> c)
UniformInterface
method
in interface UniformInterface
T
- the type of the response.method
- the HTTP method.c
- the type of the returned response.
c
.public <T> T method(java.lang.String method, GenericType<T> gt)
UniformInterface
method
in interface UniformInterface
T
- the type of the response.method
- the HTTP method.gt
- the generic type of the returned response.
public <T> T method(java.lang.String method, java.lang.Class<T> c, java.lang.Object requestEntity)
UniformInterface
method
in interface UniformInterface
T
- the type of the response.method
- the HTTP method.c
- the type of the returned response.requestEntity
- the request entity.
c
.public <T> T method(java.lang.String method, GenericType<T> gt, java.lang.Object requestEntity)
UniformInterface
method
in interface UniformInterface
T
- the type of the response.method
- the HTTP method.gt
- the generic type of the returned response.requestEntity
- the request entity.
public WebResource.Builder entity(java.lang.Object entity)
RequestBuilder
Any Java type instance for a request entity, that is supported by the client
configuration of the client, can be passed. If generic information is
required then an instance of GenericEntity
may
be used.
entity
in interface RequestBuilder<WebResource.Builder>
entity
- the request entity
public WebResource.Builder entity(java.lang.Object entity, javax.ws.rs.core.MediaType type)
RequestBuilder
Any Java type instance for a request entity, that is supported by the client
configuration of the client, can be passed. If generic information is
required then an instance of GenericEntity
may
be used.
entity
in interface RequestBuilder<WebResource.Builder>
entity
- the request entitytype
- the media type
public WebResource.Builder entity(java.lang.Object entity, java.lang.String type)
RequestBuilder
Any Java type instance for a request entity, that is supported by the client
configuration of the client, can be passed. If generic information is
required then an instance of GenericEntity
may
be used.
entity
in interface RequestBuilder<WebResource.Builder>
entity
- the request entitytype
- the media type
public WebResource.Builder type(javax.ws.rs.core.MediaType type)
RequestBuilder
type
in interface RequestBuilder<WebResource.Builder>
type
- the media type
public WebResource.Builder type(java.lang.String type)
RequestBuilder
type
in interface RequestBuilder<WebResource.Builder>
type
- the media type
public WebResource.Builder accept(javax.ws.rs.core.MediaType... types)
RequestBuilder
accept
in interface RequestBuilder<WebResource.Builder>
types
- an array of the acceptable media types
public WebResource.Builder accept(java.lang.String... types)
RequestBuilder
accept
in interface RequestBuilder<WebResource.Builder>
types
- an array of the acceptable media types
public WebResource.Builder acceptLanguage(java.util.Locale... locales)
RequestBuilder
acceptLanguage
in interface RequestBuilder<WebResource.Builder>
locales
- an array of the acceptable languages
public WebResource.Builder acceptLanguage(java.lang.String... locales)
RequestBuilder
acceptLanguage
in interface RequestBuilder<WebResource.Builder>
locales
- an array of the acceptable languages
public WebResource.Builder cookie(javax.ws.rs.core.Cookie cookie)
RequestBuilder
cookie
in interface RequestBuilder<WebResource.Builder>
cookie
- to be set.
public WebResource.Builder header(java.lang.String name, java.lang.Object value)
RequestBuilder
header
in interface RequestBuilder<WebResource.Builder>
name
- the HTTP header name.value
- the HTTP header value.
public WebResource path(java.lang.String path)
Any filters on this web resource are inherited. Removal of filters may cause undefined behaviour.
path
- the additional path.
public WebResource uri(java.net.URI uri)
If the URI contains a path component and the path starts with a '/' then the path of this web resource URI is replaced. Otherwise the path is appended.
If the URI contains query parameters then those query parameters will replace the query parameters (if any) of this web resource.
Any filters on this web resource are inherited. Removal of filters may cause undefined behaviour.
uri
- the URI.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |