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
WebResource
s 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.
//TODO make this an interface before making public - CRA-627
-
Constructor Summary
ConstructorDescriptionAuthenticatedWebResourceProvider
(com.sun.jersey.api.client.Client client, String baseUrl, String path) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Clears the current authenticated user, if any.void
close()
createWithNewClient
(String baseUrl) Helper method to create new AuthenticatedWebResourceProviders using a default client and no extra base WebResource path.com.sun.jersey.api.client.WebResource.Builder
newJsonResource
(String path) Returns a new web resource accepting JSON.com.sun.jersey.api.client.WebResource
void
setAuthContext
(String username, char[] password) Authenticates a user to make remote requests with.
-
Constructor Details
-
AuthenticatedWebResourceProvider
-
-
Method Details
-
createWithNewClient
Helper method to create new AuthenticatedWebResourceProviders using a default client and no extra base WebResource path. -
newRestWebResource
public com.sun.jersey.api.client.WebResource newRestWebResource() -
newJsonResource
Returns a new web resource accepting JSON. -
setAuthContext
Authenticates a user to make remote requests with.- Parameters:
username
- the login username of the userpassword
- the password of the user
-
clearAuthContext
public void clearAuthContext()Clears the current authenticated user, if any. -
getUsername
-
close
public void close()- Specified by:
close
in interfaceAutoCloseable
-