Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractClient - Class in rs.jerseyclient.util
-
The abstract implementation of all REST clients.
- AbstractClient() - Constructor for class rs.jerseyclient.util.AbstractClient
-
Constructor.
- AbstractClient(WebTarget) - Constructor for class rs.jerseyclient.util.AbstractClient
-
Constructor.
- AbstractData - Class in rs.jerseyclient.data
-
Abstract base for data classes providing the HATEOAS field
_links. - AbstractData() - Constructor for class rs.jerseyclient.data.AbstractData
-
Default constructor.
- add(int, T) - Method in class rs.jerseyclient.data.ResultList
- add(T) - Method in class rs.jerseyclient.data.ResultList
- addAll(int, Collection<? extends T>) - Method in class rs.jerseyclient.data.ResultList
- addAll(Collection<? extends T>) - Method in class rs.jerseyclient.data.ResultList
- applyPaging(WebTarget, Integer, Integer) - Method in class rs.jerseyclient.util.AbstractClient
-
Applies paging parameters to the target.
- applySort(WebTarget, String) - Method in class rs.jerseyclient.util.AbstractClient
-
Applies sort parameter to the target.
- authorize() - Method in class rs.jerseyclient.JerseyClient
-
Base method for authentication.
C
- checkResponse(Response) - Method in class rs.jerseyclient.util.AbstractClient
-
Helper method to raise exceptions in case of any other response than 2xx successful.
- checkResponse(Response, T) - Method in class rs.jerseyclient.util.AbstractClient
-
Helper method to raise exceptions in case of any other response than 2xx successful.
- clear() - Method in class rs.jerseyclient.data.ResultList
- ClientHolder - Class in rs.jerseyclient.util
-
A helper class to maintain (sub) clients within a client.
- ClientHolder(WebTarget) - Constructor for class rs.jerseyclient.util.ClientHolder
-
Constructor.
- close() - Method in class rs.jerseyclient.JerseyClient
-
Close the client.
- configure(Client) - Method in class rs.jerseyclient.JerseyClient
-
Configures the client by setting the default auth filter and - if applicable - the proxy filter.
- configure(JerseyClientConfig) - Method in class rs.jerseyclient.JerseyClient
-
Configures JAX-RS client and main web target based on this config.
- contains(Object) - Method in class rs.jerseyclient.data.ResultList
- containsAll(Collection<?>) - Method in class rs.jerseyclient.data.ResultList
- CookieAuthorizationFilter - Class in rs.jerseyclient.util
-
Handles cookies and "Accept" header in requests and responses.
- CookieAuthorizationFilter() - Constructor for class rs.jerseyclient.util.CookieAuthorizationFilter
-
Default Constructor.
- createClient() - Method in class rs.jerseyclient.JerseyClient
-
Creates the actual JAX-WS Jersey client instance.
- createClientConfig() - Method in class rs.jerseyclient.JerseyClient
-
Creates the Jersey client configuration based on the config for this client.
D
- DEFAULT_ACCEPT_HEADER - Static variable in class rs.jerseyclient.util.CookieAuthorizationFilter
-
Default Accept header value
E
- EmbeddedResultList() - Constructor for class rs.jerseyclient.data.HateOasPagedList.EmbeddedResultList
- equals(Object) - Method in class rs.jerseyclient.data.ResultList
F
- filter(ClientRequestContext) - Method in class rs.jerseyclient.util.CookieAuthorizationFilter
-
Sets cookies if required in the request.
- filter(ClientRequestContext) - Method in class rs.jerseyclient.util.UserAgentFilter
-
Sets user agent if it was set.
- filter(ClientRequestContext, ClientResponseContext) - Method in class rs.jerseyclient.util.CookieAuthorizationFilter
-
Filters the reponse and evaluate the cookies to be set.
- forEach(Consumer<? super T>) - Method in class rs.jerseyclient.data.ResultList
G
- get(int) - Method in class rs.jerseyclient.data.ResultList
- get(Class<T>) - Method in class rs.jerseyclient.util.AbstractClient
-
Returns the subclient of the given type.
- get(Class<T>) - Method in class rs.jerseyclient.util.ClientHolder
-
Returns the subclient of the given type.
- get_embedded() - Method in class rs.jerseyclient.data.HateOasPagedList
-
Returns the embedded result list.
- get_links() - Method in class rs.jerseyclient.data.AbstractData
-
Returns the links map.
- getAcceptableMediaTypes() - Method in class rs.jerseyclient.util.CookieAuthorizationFilter
-
Returns the acceptable media types to signal to the sever.
- getAuthorizationFilter() - Method in class rs.jerseyclient.JerseyClient
-
Returns the default filter(s) for authorization.
- getClient() - Method in class rs.jerseyclient.JerseyClient
-
Returns the configured Jersey client.
- getConfig() - Method in class rs.jerseyclient.JerseyClient
-
Returns the config of this client.
- getContext(Class<?>) - Method in class rs.jerseyclient.util.ObjectMapperProvider
- getHref() - Method in class rs.jerseyclient.data.Link
-
Returns the HREF attribute (URL) of the link.
- getLog() - Method in class rs.jerseyclient.util.AbstractClient
-
Returns the logger for this client.
- getNumber() - Method in class rs.jerseyclient.data.PageInfo
-
Returns the number of this page.
- getObjectMapper() - Method in class rs.jerseyclient.JerseyClientConfig
-
Returns the mapper.
- getPage() - Method in class rs.jerseyclient.data.HateOasPagedList
-
Returns the page information object
- getPageNumber() - Method in class rs.jerseyclient.data.ResultList
-
Returns the number of the current page.
- getPageSize() - Method in class rs.jerseyclient.data.ResultList
-
Returns the results page size.
- getPassword() - Method in class rs.jerseyclient.util.ProxyConfig
-
Returns the password.
- getProxyConfig() - Method in class rs.jerseyclient.JerseyClientConfig
-
Returns the proxyConfig.
- getProxyHost() - Method in class rs.jerseyclient.util.ProxyConfig
-
Returns the proxyHost.
- getProxyPort() - Method in class rs.jerseyclient.util.ProxyConfig
-
Returns the proxyPort.
- getRequest() - Method in class rs.jerseyclient.util.AbstractClient
-
Returns a request builder.
- getResults() - Method in class rs.jerseyclient.data.HateOasPagedList.EmbeddedResultList
-
Returns the result list.
- getResults(HateOasPagedList<T>) - Method in class rs.jerseyclient.util.AbstractClient
-
Retrieves the results from the REST response object.
- getSize() - Method in class rs.jerseyclient.data.PageInfo
-
Returns the size of a page.
- getTarget() - Method in class rs.jerseyclient.util.AbstractClient
-
Returns the target.
- getTarget() - Method in class rs.jerseyclient.util.ClientHolder
-
Returns the target.
- getTarget(Integer, Integer) - Method in class rs.jerseyclient.util.AbstractClient
-
Returns the target with paging parameters applied.
- getTarget(String) - Method in class rs.jerseyclient.util.AbstractClient
-
Returns the target with sort parameter applied.
- getTarget(String, Integer, Integer) - Method in class rs.jerseyclient.util.AbstractClient
-
Returns the target with paging and sort parameters applied.
- getTotalElements() - Method in class rs.jerseyclient.data.PageInfo
-
Returns the total number of results available.
- getTotalElements() - Method in class rs.jerseyclient.data.ResultList
-
Returns the total number of results.
- getTotalPages() - Method in class rs.jerseyclient.data.PageInfo
-
Returns the number of pages available.
- getTotalPages() - Method in class rs.jerseyclient.data.ResultList
-
Returns the total number of pages.
- getUri() - Method in class rs.jerseyclient.JerseyClientConfig
-
Returns the base URI of the API that needs to be targeted.
- getUserAgent() - Method in class rs.jerseyclient.JerseyClient
-
Returns the User-Agent string to be injected in calls.
- getUsername() - Method in class rs.jerseyclient.util.ProxyConfig
-
Returns the username.
H
- hashCode() - Method in class rs.jerseyclient.data.ResultList
- HateOasPagedList<T> - Class in rs.jerseyclient.data
-
The response according to HATEOAS paged responses.
- HateOasPagedList() - Constructor for class rs.jerseyclient.data.HateOasPagedList
-
Default constructor.
- HateOasPagedList.EmbeddedResultList<T> - Class in rs.jerseyclient.data
-
Embedded class for the result list.
I
- indexOf(Object) - Method in class rs.jerseyclient.data.ResultList
- isEmpty() - Method in class rs.jerseyclient.data.ResultList
- isVerbose() - Method in class rs.jerseyclient.JerseyClientConfig
-
Returns whether the Jersey client shall be configured to be verbose
- iterator() - Method in class rs.jerseyclient.data.ResultList
J
- JerseyClient - Class in rs.jerseyclient
-
The main entrance class.
- JerseyClient(Client) - Constructor for class rs.jerseyclient.JerseyClient
-
Constructor.
- JerseyClient(JerseyClientConfig) - Constructor for class rs.jerseyclient.JerseyClient
-
Constructor.
- JerseyClientConfig - Class in rs.jerseyclient
-
Holds configuration info for the client.
- JerseyClientConfig() - Constructor for class rs.jerseyclient.JerseyClientConfig
-
Default constructor.
- JerseyClientConfig(String, boolean) - Constructor for class rs.jerseyclient.JerseyClientConfig
-
Constructor.
- JerseyClientException - Exception in rs.jerseyclient
-
A standard exception for the client.
- JerseyClientException() - Constructor for exception rs.jerseyclient.JerseyClientException
-
Constructs a new exception with
nullas its detail message. - JerseyClientException(String) - Constructor for exception rs.jerseyclient.JerseyClientException
-
Constructs a new exception with the specified detail message.
- JerseyClientException(String, Throwable) - Constructor for exception rs.jerseyclient.JerseyClientException
-
Constructs a new exception with the specified detail message and cause.
- JerseyClientException(String, Throwable, boolean, boolean) - Constructor for exception rs.jerseyclient.JerseyClientException
-
Constructs a new exception with the specified detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
- JerseyClientException(Throwable) - Constructor for exception rs.jerseyclient.JerseyClientException
-
Constructs a new runtime exception with the specified cause and a detail message of
(cause==null ? null : cause.toString())(which typically contains the class and detail message ofcause).
L
- lastIndexOf(Object) - Method in class rs.jerseyclient.data.ResultList
- Link - Class in rs.jerseyclient.data
-
A link as defined by HATEOAS responses.
- Link() - Constructor for class rs.jerseyclient.data.Link
-
Default constructor.
- listIterator() - Method in class rs.jerseyclient.data.ResultList
- listIterator(int) - Method in class rs.jerseyclient.data.ResultList
N
- NAME - Static variable in class rs.jerseyclient.JerseyClient
-
Default name for User-Agent
O
- ObjectMapperProvider - Class in rs.jerseyclient.util
-
Provides a custom
ObjectMapper. - ObjectMapperProvider() - Constructor for class rs.jerseyclient.util.ObjectMapperProvider
P
- PageInfo - Class in rs.jerseyclient.data
-
The page information object as defined in HATEOAS paged response.
- PageInfo() - Constructor for class rs.jerseyclient.data.PageInfo
-
Default constructor.
- parallelStream() - Method in class rs.jerseyclient.data.ResultList
- ProxyConfig - Class in rs.jerseyclient.util
-
Proxy configuration
- ProxyConfig() - Constructor for class rs.jerseyclient.util.ProxyConfig
-
Default constructor.
- ProxyConfig(String, int) - Constructor for class rs.jerseyclient.util.ProxyConfig
-
Constructor.
- ProxyConfig(String, int, String, String) - Constructor for class rs.jerseyclient.util.ProxyConfig
-
Constructor for authenticated proxy.
R
- remove(int) - Method in class rs.jerseyclient.data.ResultList
- remove(Object) - Method in class rs.jerseyclient.data.ResultList
- removeAll(Collection<?>) - Method in class rs.jerseyclient.data.ResultList
- removeIf(Predicate<? super T>) - Method in class rs.jerseyclient.data.ResultList
- replaceAll(UnaryOperator<T>) - Method in class rs.jerseyclient.data.ResultList
- ResultList<T> - Class in rs.jerseyclient.data
-
Special list that also holds page information.
- ResultList() - Constructor for class rs.jerseyclient.data.ResultList
-
Default constructor.
- ResultList(List<T>, PageInfo) - Constructor for class rs.jerseyclient.data.ResultList
-
Constructor.
- retainAll(Collection<?>) - Method in class rs.jerseyclient.data.ResultList
- rs.jerseyclient - package rs.jerseyclient
-
Main package providing most important classes for bootstrap.
- rs.jerseyclient.data - package rs.jerseyclient.data
-
Provide data implementations for HATEOAS responses.
- rs.jerseyclient.util - package rs.jerseyclient.util
-
Some helper classes.
S
- set(int, T) - Method in class rs.jerseyclient.data.ResultList
- set_embedded(HateOasPagedList.EmbeddedResultList<T>) - Method in class rs.jerseyclient.data.HateOasPagedList
-
Sets the embedded result list.
- set_links(Map<String, Link>) - Method in class rs.jerseyclient.data.AbstractData
-
Sets the links map.
- setAcceptableMediaTypes(String) - Method in class rs.jerseyclient.util.CookieAuthorizationFilter
-
Sets the acceptable media types to signal to the sever.
- setHref(String) - Method in class rs.jerseyclient.data.Link
-
Sets the HREF attribute (URL) of the link.
- setMapper(ObjectMapper) - Static method in class rs.jerseyclient.util.ObjectMapperProvider
-
Sets the
ObjectMapperobject. - setNumber(int) - Method in class rs.jerseyclient.data.PageInfo
-
Sets this page number.
- setObjectMapper(ObjectMapper) - Method in class rs.jerseyclient.JerseyClientConfig
-
Sets the mapper.
- setPage(PageInfo) - Method in class rs.jerseyclient.data.HateOasPagedList
-
Sets the page information object
- setPassword(String) - Method in class rs.jerseyclient.util.ProxyConfig
-
Sets the password.
- setProxyConfig(ProxyConfig) - Method in class rs.jerseyclient.JerseyClientConfig
-
Sets the proxyConfig.
- setProxyHost(String) - Method in class rs.jerseyclient.util.ProxyConfig
-
Sets the proxyHost.
- setProxyPort(int) - Method in class rs.jerseyclient.util.ProxyConfig
-
Sets the proxyPort.
- setResults(List<T>) - Method in class rs.jerseyclient.data.HateOasPagedList.EmbeddedResultList
-
Sets the result list.
- setSize(int) - Method in class rs.jerseyclient.data.PageInfo
-
Sets the size of a page.
- setTarget(WebTarget) - Method in class rs.jerseyclient.util.AbstractClient
-
Sets a target for this client.
- setTotalElements(int) - Method in class rs.jerseyclient.data.PageInfo
-
Sets the total number of results available.
- setTotalPages(int) - Method in class rs.jerseyclient.data.PageInfo
-
Sets the number of pages available.
- setUri(String) - Method in class rs.jerseyclient.JerseyClientConfig
-
Sets the base URI of the API that needs to be targeted.
- setUsername(String) - Method in class rs.jerseyclient.util.ProxyConfig
-
Sets the username.
- setVerbose(boolean) - Method in class rs.jerseyclient.JerseyClientConfig
-
Sets whether the Jersey client shall be configured to be verbose.
- size() - Method in class rs.jerseyclient.data.ResultList
- sort(Comparator<? super T>) - Method in class rs.jerseyclient.data.ResultList
- spliterator() - Method in class rs.jerseyclient.data.ResultList
- stream() - Method in class rs.jerseyclient.data.ResultList
- subList(int, int) - Method in class rs.jerseyclient.data.ResultList
T
- toArray() - Method in class rs.jerseyclient.data.ResultList
- toArray(IntFunction<X[]>) - Method in class rs.jerseyclient.data.ResultList
- toArray(X[]) - Method in class rs.jerseyclient.data.ResultList
U
- URL - Static variable in class rs.jerseyclient.JerseyClient
-
Default URL for User-Agent
- UserAgentFilter - Class in rs.jerseyclient.util
-
Handles cookies in requests and responses.
- UserAgentFilter() - Constructor for class rs.jerseyclient.util.UserAgentFilter
-
Default Constructor.
- UserAgentFilter(String) - Constructor for class rs.jerseyclient.util.UserAgentFilter
-
Constructor.
V
- VERSION - Static variable in class rs.jerseyclient.JerseyClient
-
Default version for User-Agent
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form