Class AuthScope


  • @Contract(threading=IMMUTABLE)
    public class AuthScope
    extends java.lang.Object
    AuthScope represents an authentication scope consisting of a host name, a port number, a realm name and an authentication scheme name.

    This class can also optionally contain a host of origin, if created in response to authentication challenge from a specific host.

    Since:
    4.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static AuthScope ANY
      Default scope matching any host, port, realm and authentication scheme.
      static java.lang.String ANY_HOST
      The null value represents any host.
      static int ANY_PORT
      The -1 value represents any port.
      static java.lang.String ANY_REALM
      The null value represents any realm.
      static java.lang.String ANY_SCHEME
      The null value represents any authentication scheme.
      private java.lang.String host
      The host the credentials apply to.
      private org.apache.http.HttpHost origin
      The original host, if known
      private int port
      The port the credentials apply to.
      private java.lang.String realm
      The realm the credentials apply to.
      private java.lang.String scheme
      The authentication scheme the credentials apply to.
    • Constructor Summary

      Constructors 
      Constructor Description
      AuthScope​(java.lang.String host, int port)
      Defines auth scope with the given host and port.
      AuthScope​(java.lang.String host, int port, java.lang.String realm)
      Defines auth scope with the given host, port and realm.
      AuthScope​(java.lang.String host, int port, java.lang.String realm, java.lang.String schemeName)
      Defines auth scope with the given host, port, realm, and schemeName.
      AuthScope​(AuthScope authscope)
      Creates a copy of the given credentials scope.
      AuthScope​(org.apache.http.HttpHost origin)
      Defines auth scope for a specific host of origin.
      AuthScope​(org.apache.http.HttpHost origin, java.lang.String realm, java.lang.String schemeName)
      Defines auth scope for a specific host of origin.
    • Field Detail

      • ANY_HOST

        public static final java.lang.String ANY_HOST
        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
        The -1 value represents any port.
        See Also:
        Constant Field Values
      • ANY_REALM

        public static final java.lang.String ANY_REALM
        The null value represents any realm.
      • ANY_SCHEME

        public static final java.lang.String ANY_SCHEME
        The null value represents any authentication scheme.
      • ANY

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

        private final java.lang.String scheme
        The authentication scheme the credentials apply to.
      • realm

        private final java.lang.String realm
        The realm the credentials apply to.
      • host

        private final java.lang.String host
        The host the credentials apply to.
      • port

        private final int port
        The port the credentials apply to.
      • origin

        private final org.apache.http.HttpHost origin
        The original host, if known
    • Constructor Detail

      • AuthScope

        public AuthScope​(java.lang.String host,
                         int port,
                         java.lang.String realm,
                         java.lang.String schemeName)
        Defines auth scope with the given host, port, realm, and schemeName.
        Parameters:
        host - authentication host. May be ANY_HOST if applies to any host.
        port - authentication port. May be ANY_PORT if applies to any port of the host.
        realm - authentication realm. May be ANY_REALM if applies to any realm on the host.
        schemeName - authentication scheme. May be ANY_SCHEME if applies to any scheme supported by the host.
      • AuthScope

        public AuthScope​(org.apache.http.HttpHost origin,
                         java.lang.String realm,
                         java.lang.String schemeName)
        Defines auth scope for a specific host of origin.
        Parameters:
        origin - host of origin
        realm - authentication realm. May be ANY_REALM if applies to any realm on the host.
        schemeName - authentication scheme. May be ANY_SCHEME if applies to any scheme supported by the host.
        Since:
        4.2
      • AuthScope

        public AuthScope​(org.apache.http.HttpHost origin)
        Defines auth scope for a specific host of origin.
        Parameters:
        origin - host of origin
        Since:
        4.2
      • AuthScope

        public AuthScope​(java.lang.String host,
                         int port,
                         java.lang.String realm)
        Defines auth scope with the given host, port and realm.
        Parameters:
        host - authentication host. May be ANY_HOST if applies to any host.
        port - authentication port. May be ANY_PORT if applies to any port of the host.
        realm - authentication realm. May be ANY_REALM if applies to any realm on the host.
      • AuthScope

        public AuthScope​(java.lang.String host,
                         int port)
        Defines auth scope with the given host and port.
        Parameters:
        host - authentication host. May be ANY_HOST if applies to any host.
        port - authentication port. May be ANY_PORT if applies to any port of the host.
      • AuthScope

        public AuthScope​(AuthScope authscope)
        Creates a copy of the given credentials scope.
    • Method Detail

      • getOrigin

        public org.apache.http.HttpHost getOrigin()
        Returns:
        host of origin. If unknown returns @null,
        Since:
        4.4
      • getHost

        public java.lang.String getHost()
        Returns:
        the host
      • getPort

        public int getPort()
        Returns:
        the port
      • getRealm

        public java.lang.String getRealm()
        Returns:
        the realm name
      • getScheme

        public java.lang.String getScheme()
        Returns:
        the scheme type
      • match

        public int match​(AuthScope that)
        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.
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
        See Also:
        Object.equals(Object)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()
      • hashCode

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