Package org.apache.commons.httpclient

Class HttpURL

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
    Direct Known Subclasses:
    HttpsURL
    public class HttpURL
extends URI
    The HTTP URL.
    See Also:
    Serialized Form

    • Field Detail

      • DEFAULT_SCHEME

        public static final char[] DEFAULT_SCHEME
        Default scheme for HTTP URL.

      • _default_scheme

        public static final char[] _default_scheme
        Deprecated.
        Use DEFAULT_SCHEME instead. This one doesn't conform to the project naming conventions.
        Default scheme for HTTP URL.

      • DEFAULT_PORT

        public static final int DEFAULT_PORT
        Default port for HTTP URL.
        See Also:
        Constant Field Values

      • _default_port

        public static final int _default_port
        Deprecated.
        Use DEFAULT_PORT instead. This one doesn't conform to the project naming conventions.
        Default port for HTTP URL.
        See Also:
        Constant Field Values

    • Constructor Detail

      • HttpURL

        public HttpURL​(char[] escaped,
               java.lang.String charset)
        throws URIException,
               java.lang.NullPointerException
        Construct a HTTP URL as an escaped form of a character array with the given charset to do escape encoding.
        Parameters:
        escaped - the HTTP URL character sequence
        charset - the charset string to do escape encoding
        Throws:
        URIException - If checkValid() fails
        java.lang.NullPointerException - if escaped is null
        See Also:
        URI.getProtocolCharset()

      • HttpURL

        public HttpURL​(char[] escaped)
        throws URIException,
               java.lang.NullPointerException
        Construct a HTTP URL as an escaped form of a character array.
        Parameters:
        escaped - the HTTP URL character sequence
        Throws:
        URIException - If checkValid() fails
        java.lang.NullPointerException - if escaped is null
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String original,
               java.lang.String charset)
        throws URIException
        Construct a HTTP URL from a given string with the given charset to do escape encoding.
        Parameters:
        original - the HTTP URL string
        charset - the charset string to do escape encoding
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String host,
               int port,
               java.lang.String path,
               java.lang.String query)
        throws URIException
        Construct a HTTP URL from given components.
        Parameters:
        host - the host string
        port - the port number
        path - the path string
        query - the query string
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String user,
               java.lang.String password,
               java.lang.String host)
        throws URIException
        Construct a HTTP URL from given components.
        Parameters:
        user - the user name
        password - his or her password
        host - the host string
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String user,
               java.lang.String password,
               java.lang.String host,
               int port)
        throws URIException
        Construct a HTTP URL from given components.
        Parameters:
        user - the user name
        password - his or her password
        host - the host string
        port - the port number
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String user,
               java.lang.String password,
               java.lang.String host,
               int port,
               java.lang.String path)
        throws URIException
        Construct a HTTP URL from given components.
        Parameters:
        user - the user name
        password - his or her password
        host - the host string
        port - the port number
        path - the path string
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String user,
               java.lang.String password,
               java.lang.String host,
               int port,
               java.lang.String path,
               java.lang.String query)
        throws URIException
        Construct a HTTP URL from given components.
        Parameters:
        user - the user name
        password - his or her password
        host - the host string
        port - the port number
        path - the path string
        query - The query string.
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String host,
               java.lang.String path,
               java.lang.String query,
               java.lang.String fragment)
        throws URIException
        Construct a HTTP URL from given components.
        Parameters:
        host - the host string
        path - the path string
        query - the query string
        fragment - the fragment string
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String userinfo,
               java.lang.String host,
               java.lang.String path,
               java.lang.String query,
               java.lang.String fragment)
        throws URIException
        Construct a HTTP URL from given components. Note: The userinfo format is normally <username>:<password> where username and password must both be URL escaped.
        Parameters:
        userinfo - the userinfo string whose parts are URL escaped
        host - the host string
        path - the path string
        query - the query string
        fragment - the fragment string
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String userinfo,
               java.lang.String host,
               int port,
               java.lang.String path)
        throws URIException
        Construct a HTTP URL from given components. Note: The userinfo format is normally <username>:<password> where username and password must both be URL escaped.
        Parameters:
        userinfo - the userinfo string whose parts are URL escaped
        host - the host string
        port - the port number
        path - the path string
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String userinfo,
               java.lang.String host,
               int port,
               java.lang.String path,
               java.lang.String query)
        throws URIException
        Construct a HTTP URL from given components. Note: The userinfo format is normally <username>:<password> where username and password must both be URL escaped.
        Parameters:
        userinfo - the userinfo string whose parts are URL escaped
        host - the host string
        port - the port number
        path - the path string
        query - the query string
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String userinfo,
               java.lang.String host,
               int port,
               java.lang.String path,
               java.lang.String query,
               java.lang.String fragment)
        throws URIException
        Construct a HTTP URL from given components. Note: The userinfo format is normally <username>:<password> where username and password must both be URL escaped.
        Parameters:
        userinfo - the userinfo string whose parts are URL escaped
        host - the host string
        port - the port number
        path - the path string
        query - the query string
        fragment - the fragment string
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(java.lang.String user,
               java.lang.String password,
               java.lang.String host,
               int port,
               java.lang.String path,
               java.lang.String query,
               java.lang.String fragment)
        throws URIException
        Construct a HTTP URL from given components.
        Parameters:
        user - the user name
        password - his or her password
        host - the host string
        port - the port number
        path - the path string
        query - the query string
        fragment - the fragment string
        Throws:
        URIException - If checkValid() fails
        See Also:
        URI.getDefaultProtocolCharset()

      • HttpURL

        public HttpURL​(HttpURL base,
               java.lang.String relative)
        throws URIException
        Construct a HTTP URL with a given relative URL string.
        Parameters:
        base - the base HttpURL
        relative - the relative HTTP URL string
        Throws:
        URIException - If checkValid() fails

    • Method Detail

      • getRawScheme

        public char[] getRawScheme()
        Get the scheme. You can get the scheme explicitly.
        Overrides:
        getRawScheme in class URI
        Returns:
        the scheme

      • getScheme

        public java.lang.String getScheme()
        Get the scheme. You can get the scheme explicitly.
        Overrides:
        getScheme in class URI
        Returns:
        the scheme null if empty or undefined

      • getPort

        public int getPort()
        Get the port number.
        Overrides:
        getPort in class URI
        Returns:
        the port number

      • setRawUserinfo

        public void setRawUserinfo​(char[] escapedUser,
                           char[] escapedPassword)
                    throws URIException
        Set the raw-escaped user and password.
        Parameters:
        escapedUser - the raw-escaped user
        escapedPassword - the raw-escaped password; could be null
        Throws:
        URIException - escaped user not valid or user required; escaped password not valid or username missed

      • setEscapedUserinfo

        public void setEscapedUserinfo​(java.lang.String escapedUser,
                               java.lang.String escapedPassword)
                        throws URIException,
                               java.lang.NullPointerException
        Set the raw-escaped user and password.
        Parameters:
        escapedUser - the escaped user
        escapedPassword - the escaped password; could be null
        Throws:
        URIException - escaped user not valid or user required; escaped password not valid or username missed
        java.lang.NullPointerException - null user

      • setUserinfo

        public void setUserinfo​(java.lang.String user,
                        java.lang.String password)
                 throws URIException,
                        java.lang.NullPointerException
        Set the user and password.
        Parameters:
        user - the user
        password - the password; could be null
        Throws:
        URIException - encoding error or username missed
        java.lang.NullPointerException - null user

      • setRawUser

        public void setRawUser​(char[] escapedUser)
                throws URIException
        Set the raw-escaped user.
        Parameters:
        escapedUser - the raw-escaped user
        Throws:
        URIException - escaped user not valid or user required

      • setEscapedUser

        public void setEscapedUser​(java.lang.String escapedUser)
                    throws URIException,
                           java.lang.NullPointerException
        Set the escaped user string.
        Parameters:
        escapedUser - the escaped user string
        Throws:
        URIException - escaped user not valid
        java.lang.NullPointerException - null user

      • setUser

        public void setUser​(java.lang.String user)
             throws URIException,
                    java.lang.NullPointerException
        Set the user string.
        Parameters:
        user - the user string
        Throws:
        URIException - user encoding error
        java.lang.NullPointerException - null user

      • getRawUser

        public char[] getRawUser()
        Get the raw-escaped user.
        Returns:
        the raw-escaped user

      • getEscapedUser

        public java.lang.String getEscapedUser()
        Get the escaped user
        Returns:
        the escaped user

      • setRawPassword

        public void setRawPassword​(char[] escapedPassword)
                    throws URIException
        Set the raw-escaped password.
        Parameters:
        escapedPassword - the raw-escaped password; could be null
        Throws:
        URIException - escaped password not valid or username missed

      • setEscapedPassword

        public void setEscapedPassword​(java.lang.String escapedPassword)
                        throws URIException
        Set the escaped password string.
        Parameters:
        escapedPassword - the escaped password string; could be null
        Throws:
        URIException - escaped password not valid or username missed

      • setPassword

        public void setPassword​(java.lang.String password)
                 throws URIException
        Set the password string.
        Parameters:
        password - the password string; could be null
        Throws:
        URIException - encoding error or username missed

      • getRawPassword

        public char[] getRawPassword()
        Get the raw-escaped password.
        Returns:
        the raw-escaped password

      • getEscapedPassword

        public java.lang.String getEscapedPassword()
        Get the escaped password.
        Returns:
        the escaped password

      • getRawPath

        public char[] getRawPath()
        Get the raw escaped path.
        Overrides:
        getRawPath in class URI
        Returns:
        the path '/' if empty or undefined

      • setQuery

        public void setQuery​(java.lang.String queryName,
                     java.lang.String queryValue)
              throws URIException,
                     java.lang.NullPointerException
        Set the query as the name and value pair.
        Parameters:
        queryName - the query string.
        queryValue - the query string.
        Throws:
        URIException - incomplete trailing escape pattern Or unsupported character encoding
        java.lang.NullPointerException - null query
        See Also:
        URI.encode(java.lang.String, java.util.BitSet, java.lang.String)

      • setQuery

        public void setQuery​(java.lang.String[] queryName,
                     java.lang.String[] queryValue)
              throws URIException,
                     java.lang.NullPointerException
        Set the query as the name and value pairs.
        Parameters:
        queryName - the array of the query string.
        queryValue - the array of the query string.
        Throws:
        URIException - incomplete trailing escape pattern, unsupported character encoding or wrong array size
        java.lang.NullPointerException - null query
        See Also:
        URI.encode(java.lang.String, java.util.BitSet, java.lang.String)