Package org.htmlunit

Class DefaultCredentialsProvider

java.lang.Object
org.htmlunit.DefaultCredentialsProvider
All Implemented Interfaces:
Serializable, org.apache.http.client.CredentialsProvider

public class DefaultCredentialsProvider extends Object implements org.apache.http.client.CredentialsProvider, Serializable
Default HtmlUnit implementation of the CredentialsProvider interface. Provides credentials for both web servers and proxies. Supports Digest authentication, Socks authentication and Basic HTTP authentication.
See Also:
  • Field Summary Link icon

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The null value represents any host.
    static final int
    The -1 value represents any port.
    static final String
    The null value represents any realm.
    static final String
    The null value represents any authentication scheme.
  • Constructor Summary Link icon

    Constructors
    Constructor
    Description
     
  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    void
    addCredentials(String username, char[] password)
    Adds credentials for the specified username/password for any host/port/realm combination.
    void
    addCredentials(String username, char[] password, String host, int port, String realm)
    Adds credentials for the specified username/password on the specified host/port for the specified realm.
    void
    addNTLMCredentials(String username, char[] password, String host, int port, String workstation, String domain)
    Adds NTLM credentials for the specified username/password on the specified host/port.
    void
    addSocksCredentials(String username, char[] password, String host, int port)
    Adds Socks credentials for the specified username/password on the specified host/port.
    void
    org.apache.http.auth.Credentials
    getCredentials(org.apache.http.auth.AuthScope authscope)
    boolean
    removeCredentials(org.apache.http.auth.AuthScope authscope)
    Removes the credentials from the AuthScope.
    void
    setCredentials(org.apache.http.auth.AuthScope authscope, org.apache.http.auth.Credentials credentials)

    Methods inherited from class java.lang.Object Link icon

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details Link icon

    • ANY_HOST Link icon

      public static final String ANY_HOST
      The null value represents any host.
    • ANY_PORT Link icon

      public static final int ANY_PORT
      The -1 value represents any port.
      See Also:
    • ANY_REALM Link icon

      public static final String ANY_REALM
      The null value represents any realm.
    • ANY_SCHEME Link icon

      public static final String ANY_SCHEME
      The null value represents any authentication scheme.
  • Constructor Details Link icon

    • DefaultCredentialsProvider Link icon

      public DefaultCredentialsProvider()
  • Method Details Link icon

    • addCredentials Link icon

      public void addCredentials(String username, char[] password)
      Adds credentials for the specified username/password for any host/port/realm combination. The credentials may be for any authentication scheme, including NTLM, digest and basic HTTP authentication. If you are using sensitive username/password information, please do NOT use this method. If you add credentials using this method, any server that requires authentication may receive the specified username and password.
      Parameters:
      username - the username for the new credentials
      password - the password for the new credentials
    • addCredentials Link icon

      public void addCredentials(String username, char[] password, String host, int port, String realm)
      Adds credentials for the specified username/password on the specified host/port for the specified realm. The credentials may be for any authentication scheme, including NTLM, digest and basic HTTP authentication.
      Parameters:
      username - the username for the new credentials
      password - the password for the new credentials
      host - the host to which to the new credentials apply (null if applicable to any host)
      port - the port to which to the new credentials apply (negative if applicable to any port)
      realm - the realm to which to the new credentials apply (null if applicable to any realm)
    • addNTLMCredentials Link icon

      public void addNTLMCredentials(String username, char[] password, String host, int port, String workstation, String domain)
      Adds NTLM credentials for the specified username/password on the specified host/port.
      Parameters:
      username - the username for the new credentials; should not include the domain to authenticate with; for example: "user" is correct whereas "DOMAIN\\user" is not
      password - the password for the new credentials
      host - the host to which to the new credentials apply (null if applicable to any host)
      port - the port to which to the new credentials apply (negative if applicable to any port)
      workstation - The workstation the authentication request is originating from. Essentially, the computer name for this machine.
      domain - the domain to authenticate within
    • addSocksCredentials Link icon

      public void addSocksCredentials(String username, char[] password, String host, int port)
      Adds Socks credentials for the specified username/password on the specified host/port.
      Parameters:
      username - the username for the new credentials
      password - the password for the new credentials
      host - the host to which to the new credentials apply (null if applicable to any host)
      port - the port to which to the new credentials apply (negative if applicable to any port)
    • setCredentials Link icon

      public void setCredentials(org.apache.http.auth.AuthScope authscope, org.apache.http.auth.Credentials credentials)
      Specified by:
      setCredentials in interface org.apache.http.client.CredentialsProvider
    • getCredentials Link icon

      public org.apache.http.auth.Credentials getCredentials(org.apache.http.auth.AuthScope authscope)
      Specified by:
      getCredentials in interface org.apache.http.client.CredentialsProvider
    • removeCredentials Link icon

      public boolean removeCredentials(org.apache.http.auth.AuthScope authscope)
      Removes the credentials from the AuthScope.
      Parameters:
      authscope - the AuthScope to remove the credentials of
      Returns:
      whether it was removed or not
    • toString Link icon

      public String toString()
      Overrides:
      toString in class Object
    • clear Link icon

      public void clear()
      Specified by:
      clear in interface org.apache.http.client.CredentialsProvider