Package org.apache.commons.httpclient.auth

Class AuthScope

java.lang.Object
org.apache.commons.httpclient.auth.AuthScope
Direct Known Subclasses:
HttpAuthRealm
@Deprecated public class AuthScope extends Object
Deprecated.
Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.
The class represents an authentication scope consisting of a host name, a port number, a realm name and an authentication scheme name which Credentials apply to.
Since:
3.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final AuthScope
    ANY
    Deprecated.
    Default scope matching any host, port, realm and authentication scheme.
    static final String
    ANY_HOST
    Deprecated.
    The null value represents any host.
    static final int
    ANY_PORT
    Deprecated.
    The -1 value represents any port.
    static final String
    ANY_REALM
    Deprecated.
    The null value represents any realm.
    static final String
    ANY_SCHEME
    Deprecated.
    The null value represents any authentication scheme.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AuthScope(String host, int port)
    Deprecated.
    Creates a new credentials scope for the given host, port, any realm name, and any authentication scheme.
    AuthScope(String host, int port, String realm)
    Deprecated.
    Creates a new credentials scope for the given host, port, realm, and any authentication scheme.
    AuthScope(String host, int port, String realm, String scheme)
    Deprecated.
    Creates a new credentials scope for the given host, port, realm, and authentication scheme.
    AuthScope(AuthScope authscope)
    Deprecated.
    Creates a copy of the given credentials scope.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Deprecated.
     
    String
    getHost()
    Deprecated.
     
    int
    getPort()
    Deprecated.
     
    String
    getRealm()
    Deprecated.
     
    String
    getScheme()
    Deprecated.
     
    int
    hashCode()
    Deprecated.
     
    int
    match(AuthScope that)
    Deprecated.
    Tests if the authentication scopes match.
    String
    toString()
    Deprecated.
     

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • ANY_HOST

      public static final String ANY_HOST
      Deprecated.
      The null value represents any host. In the future versions of HttpClient the use of this parameter will be discontinued.

    • ANY_PORT

      public static final int ANY_PORT
      Deprecated.
      The -1 value represents any port.
      See Also:

    • ANY_REALM

      public static final String ANY_REALM
      Deprecated.
      The null value represents any realm.

    • ANY_SCHEME

      public static final String ANY_SCHEME
      Deprecated.
      The null value represents any authentication scheme.

    • ANY

      public static final AuthScope ANY
      Deprecated.
      Default scope matching any host, port, realm and authentication scheme. In the future versions of HttpClient the use of this parameter will be discontinued.

  • Constructor Details

    • AuthScope

      public AuthScope(String host, int port, String realm, String scheme)
      Deprecated.
      Creates a new credentials scope for the given host, port, realm, and authentication scheme.
      Parameters:
      host - the host the credentials apply to. May be set to null if credenticals are applicable to any host.
      port - the port the credentials apply to. May be set to negative value if credenticals are applicable to any port.
      realm - the realm the credentials apply to. May be set to null if credenticals are applicable to any realm.
      scheme - the authentication scheme the credentials apply to. May be set to null if credenticals are applicable to any authentication scheme.
      Since:
      3.0

    • AuthScope

      public AuthScope(String host, int port, String realm)
      Deprecated.
      Creates a new credentials scope for the given host, port, realm, and any authentication scheme.
      Parameters:
      host - the host the credentials apply to. May be set to null if credenticals are applicable to any host.
      port - the port the credentials apply to. May be set to negative value if credenticals are applicable to any port.
      realm - the realm the credentials apply to. May be set to null if credenticals are applicable to any realm.
      Since:
      3.0

    • AuthScope

      public AuthScope(String host, int port)
      Deprecated.
      Creates a new credentials scope for the given host, port, any realm name, and any authentication scheme.
      Parameters:
      host - the host the credentials apply to. May be set to null if credenticals are applicable to any host.
      port - the port the credentials apply to. May be set to negative value if credenticals are applicable to any port.
      Since:
      3.0

    • AuthScope

      public AuthScope(AuthScope authscope)
      Deprecated.
      Creates a copy of the given credentials scope.
      Since:
      3.0

  • Method Details

    • getHost

      public String getHost()
      Deprecated.
      Returns:
      the host
      Since:
      3.0

    • getPort

      public int getPort()
      Deprecated.
      Returns:
      the port
      Since:
      3.0

    • getRealm

      public String getRealm()
      Deprecated.
      Returns:
      the realm name
      Since:
      3.0

    • getScheme

      public String getScheme()
      Deprecated.
      Returns:
      the scheme type
      Since:
      3.0

    • match

      public int match(AuthScope that)
      Deprecated.
      Tests if the authentication scopes match.
      Returns:
      the match factor. Negative value signifies no match. Non-negative signifies a match. The greater the returned value the closer the match.
      Since:
      3.0

    • equals

      public boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object
      See Also:

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object
      See Also:

    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object
      See Also: