Proxy (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • java.net.Proxy

• ---

public class Proxy
extends Object
This class represents a proxy setting, typically a type (http, socks) and a socket address. A Proxy is an immutable object.
Since:
1.5
See Also:
ProxySelector

• • Nested Class Summary

  Nested Classes

  Modifier and Type	Class	Description
  static class	Proxy.Type	Represents the proxy type.

  • Field Summary

  Fields

  Modifier and Type	Field	Description
  static Proxy	NO_PROXY	A proxy setting that represents a DIRECT connection, basically telling the protocol handler not to use any proxying.

  • Constructor Summary

  Constructors

  Constructor	Description
  Proxy(Proxy.Type type,SocketAddress sa)	Creates an entry representing a PROXY connection.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  SocketAddress	address()	Returns the socket address of the proxy, ornull if its a direct connection.
  boolean	equals(Object obj)	Compares this object against the specified object.
  int	hashCode()	Returns a hashcode for this Proxy.
  String	toString()	Constructs a string representation of this Proxy.
  Proxy.Type	type()	Returns the proxy type.

     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Field Detail

     * #### NO\_PROXY  
     public static final [Proxy](../../java/net/Proxy.html "class in java.net") NO_PROXY  
     A proxy setting that represents a `DIRECT` connection, basically telling the protocol handler not to use any proxying. Used, for instance, to create sockets bypassing any other global proxy settings (like SOCKS):  
     `Socket s = new Socket(Proxy.NO_PROXY);`  

  • Constructor Detail

    * #### Proxy  
    public Proxy([Proxy.Type](../../java/net/Proxy.Type.html "enum in java.net") type,  
                 [SocketAddress](../../java/net/SocketAddress.html "class in java.net") sa)  
    Creates an entry representing a PROXY connection. Certain combinations are illegal. For instance, for types Http, and Socks, a SocketAddress **must** be provided.  
     Use the `Proxy.NO_PROXY` constant for representing a direct connection.  
    Parameters:  
    `type` \- the `Type` of the proxy  
    `sa` \- the `SocketAddress` for that proxy  
    Throws:  
    `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- when the type and the address are incompatible  

  • Method Detail

    * #### type  
    public [Proxy.Type](../../java/net/Proxy.Type.html "enum in java.net") type()  
    Returns the proxy type.  
    Returns:  
    a Type representing the proxy type  
    * #### address  
    public [SocketAddress](../../java/net/SocketAddress.html "class in java.net") address()  
    Returns the socket address of the proxy, or`null` if its a direct connection.  
    Returns:  
    a `SocketAddress` representing the socket end point of the proxy  
    * #### toString  
    public [String](../../java/lang/String.html "class in java.lang") toString()  
    Constructs a string representation of this Proxy. This String is constructed by calling toString() on its type and concatenating " @ " and the toString() result from its address if its type is not `DIRECT`.  
    Overrides:  
    `[toString](../../java/lang/Object.html#toString--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a string representation of this object.  
    * #### equals  
    public final boolean equals([Object](../../java/lang/Object.html "class in java.lang") obj)  
    Compares this object against the specified object. The result is `true` if and only if the argument is not `null` and it represents the same proxy as this object.  
     Two instances of `Proxy` represent the same address if both the SocketAddresses and type are equal.  
    Overrides:  
    `[equals](../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Parameters:  
    `obj` \- the object to compare against.  
    Returns:  
    `true` if the objects are the same;`false` otherwise.  
    See Also:  
    [InetSocketAddress.equals(java.lang.Object)](../../java/net/InetSocketAddress.html#equals-java.lang.Object-)  
    * #### hashCode  
    public final int hashCode()  
    Returns a hashcode for this Proxy.  
    Overrides:  
    `[hashCode](../../java/lang/Object.html#hashCode--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a hash code value for this Proxy.  
    See Also:  
    [Object.equals(java.lang.Object)](../../java/lang/Object.html#equals-java.lang.Object-), [System.identityHashCode(java.lang.Object)](../../java/lang/System.html#identityHashCode-java.lang.Object-)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.