Class AuthenticatedWebResourceProvider

  • All Implemented Interfaces:

    public class AuthenticatedWebResourceProvider
    extends Object
    implements AutoCloseable
    Provides authenticated WebResources 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 Detail

      • AuthenticatedWebResourceProvider

        public AuthenticatedWebResourceProvider​(com.sun.jersey.api.client.Client client,
                                                String baseUrl,
                                                String path)
    • Method Detail

      • createWithNewClient

        public static AuthenticatedWebResourceProvider createWithNewClient​(String baseUrl)
        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

        public com.sun.jersey.api.client.WebResource.Builder newJsonResource​(String path)
        Returns a new web resource accepting JSON.
      • setAuthContext

        public void setAuthContext​(String username,
                                   char[] password)
        Authenticates a user to make remote requests with.
        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()