Package com.atlassian.confluence.rest.client.authentication

Class AuthenticatedWebResourceProvider

java.lang.Object

com.atlassian.confluence.rest.client.authentication.AuthenticatedWebResourceProvider

All Implemented Interfaces:

AutoCloseable

@ExperimentalApi
public class AuthenticatedWebResourceProvider
extends Object
implements AutoCloseable

Provides authenticated WebTargets for Remote API clients.

Clients should call setAuthContext(String, char[]) to set the active user before making remote requests, and clearAuthContext() when the user authentication is no longer needed.

Constructor Summary

Constructors

Constructor	Description
AuthenticatedWebResourceProvider(jakarta.ws.rs.client.Client client, String restApiBaseUrl)
AuthenticatedWebResourceProvider(jakarta.ws.rs.client.Client client, String baseUrl, String path)

Method Summary

Modifier and Type	Method	Description
void	clearAuthContext()	Clears the current authenticated user, if any.
void	close()
static AuthenticatedWebResourceProvider	createWithNewClient(String baseUrl)	Helper method to create new AuthenticatedWebResourceProviders using a default client and no extra base WebResource path.
jakarta.ws.rs.client.Client	getClient()
String	getRestApiBaseUrl()
String	getUsername()
boolean	isClientActive()
jakarta.ws.rs.client.Invocation.Builder	newJsonResource(String path)	Returns a new web resource accepting JSON.
jakarta.ws.rs.client.Invocation.Builder	newResource(String path, String mediaType)	Returns a new web resource accepting mediaType.
jakarta.ws.rs.client.WebTarget	newWebTarget()
void	setAuthContext(String username, char[] password)	Authenticates a user to make remote requests with.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticatedWebResourceProvider

public AuthenticatedWebResourceProvider(jakarta.ws.rs.client.Client client,
 String restApiBaseUrl)

AuthenticatedWebResourceProvider

public AuthenticatedWebResourceProvider(jakarta.ws.rs.client.Client client,
 String baseUrl,
 String path)

Method Details

createWithNewClient

public static AuthenticatedWebResourceProvider createWithNewClient(String baseUrl)

Helper method to create new AuthenticatedWebResourceProviders using a default client and no extra base WebResource path.

getRestApiBaseUrl

public String getRestApiBaseUrl()

getClient

public jakarta.ws.rs.client.Client getClient()

isClientActive

public boolean isClientActive()

newWebTarget

public jakarta.ws.rs.client.WebTarget newWebTarget()

newJsonResource

public jakarta.ws.rs.client.Invocation.Builder newJsonResource(String path)

Returns a new web resource accepting JSON.

newResource

public jakarta.ws.rs.client.Invocation.Builder newResource(String path,
 String mediaType)

Returns a new web resource accepting mediaType.

setAuthContext

public void setAuthContext(String username,
 char[] password)

Authenticates a user to make remote requests with.

Parameters:

username - the login username of the user

password - the password of the user

clearAuthContext

public void clearAuthContext()

Clears the current authenticated user, if any.

getUsername

public String getUsername()

close

public void close()

Specified by:

close in interface AutoCloseable