Package org.kiwiproject.jaxrs.client

Class WebTargetClientHelper

java.lang.Object

org.kiwiproject.jaxrs.client.WebTargetClientHelper

@Beta
public class WebTargetClientHelper
extends Object

Use with Jakarta REST Client instances to provide additional functionality via WebTargetHelper. Each of the target methods returns a WebTargetHelper to allow method chaining. Please see the documentation in WebTargetHelper for more explanation.

See Also:

• WebTargetHelper

Method Summary

Modifier and Type	Method	Description
WebTargetHelper	target(jakarta.ws.rs.core.Link link)	Build a new web resource target.
WebTargetHelper	target(jakarta.ws.rs.core.UriBuilder uriBuilder)	Build a new web resource target.
WebTargetHelper	target(String uri)	Build a new web resource target.
WebTargetHelper	target(URI uri)	Build a new web resource target.
static WebTargetClientHelper	withClient(jakarta.ws.rs.client.Client client)	Create a new instance with the given Client.

Methods inherited from class java.lang.Object

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

Method Details

withClient

public static WebTargetClientHelper withClient(jakarta.ws.rs.client.Client client)

Create a new instance with the given Client.

Parameters:

client - the Client to use when building requests

Returns:

a new instance

target

public WebTargetHelper target(String uri)

Build a new web resource target.

Parameters:

uri - web resource URI. May contain template parameters. Must not be null

Returns:

a WebTargetHelper with the target bound to the provided URI

See Also:

• Client.target(String)

target

public WebTargetHelper target(URI uri)

Build a new web resource target.

Parameters:

uri - web resource URI. Must not be null.

Returns:

a WebTargetHelper with the target bound to the provided URI.

See Also:

• Client.target(URI)

target

public WebTargetHelper target(jakarta.ws.rs.core.UriBuilder uriBuilder)

Build a new web resource target.

Parameters:

uriBuilder - web resource URI represented as URI builder. Must not be null.

Returns:

a WebTargetHelper with the target bound to the provided URI.

target

public WebTargetHelper target(jakarta.ws.rs.core.Link link)

Build a new web resource target.

Parameters:

link - link to a web resource. Must not be null.

Returns:

a WebTargetHelper with the target bound to the linked web resource