com.alibaba.dubbo.common

Class URL

java.lang.Object

com.alibaba.dubbo.common.URL

All Implemented Interfaces:

Serializable

public final class URL
extends Object
implements Serializable

URL - Uniform Resource Locator (Immutable, ThreadSafe)

url example:

• http://www.facebook.com/friends?param1=value1&param2=value2
• http://username:password@10.20.130.230:8080/list?version=1.0.0
• ftp://username:password@192.168.1.7:21/1/read.txt
• registry://192.168.1.7:9090/com.alibaba.service1?param1=value1&param2=value2

Some strange example below:

• 192.168.1.3:20880
  for this case, url protocol = null, url host = 192.168.1.3, port = 20880, url path = null
• file:///home/user1/router.js?type=script
  for this case, url protocol = null, url host = null, url path = home/user1/router.js
• file://home/user1/router.js?type=script
  for this case, url protocol = file, url host = home, url path = user1/router.js
• file:///D:/1/router.js?type=script
  for this case, url protocol = file, url host = null, url path = D:/1/router.js
• file:/D:/1/router.js?type=script
  same as above file:///D:/1/router.js?type=script
• /home/user1/router.js?type=script
  for this case, url protocol = null, url host = null, url path = home/user1/router.js
• home/user1/router.js?type=script
  for this case, url protocol = null, url host = home, url path = user1/router.js

See Also:

URL, URI, Serialized Form

Constructor Summary

Constructors

Constructor and Description
URL(String protocol, String host, int port)
URL(String protocol, String host, int port, Map<String,String> parameters)
URL(String protocol, String host, int port, String path)
URL(String protocol, String host, int port, String[] pairs)
URL(String protocol, String host, int port, String path, Map<String,String> parameters)
URL(String protocol, String host, int port, String path, String... pairs)
URL(String protocol, String username, String password, String host, int port, String path)
URL(String protocol, String username, String password, String host, int port, String path, Map<String,String> parameters)
URL(String protocol, String username, String password, String host, int port, String path, String... pairs)

Method Summary

Methods

Modifier and Type	Method and Description
URL	addParameter(String key, boolean value)
URL	addParameter(String key, byte value)
URL	addParameter(String key, char value)
URL	addParameter(String key, CharSequence value)
URL	addParameter(String key, double value)
URL	addParameter(String key, Enum<?> value)
URL	addParameter(String key, float value)
URL	addParameter(String key, int value)
URL	addParameter(String key, long value)
URL	addParameter(String key, Number value)
URL	addParameter(String key, short value)
URL	addParameter(String key, String value)
URL	addParameterAndEncoded(String key, String value)
URL	addParameterIfAbsent(String key, String value)
URL	addParameters(Map<String,String> parameters) Add parameters to a new url.
URL	addParameters(String... pairs)
URL	addParametersIfAbsent(Map<String,String> parameters)
URL	addParameterString(String query)
URL	clearParameters()
static String	decode(String value)
static String	encode(String value)
boolean	equals(Object obj)
String	getAbsolutePath()
String	getAddress()
String	getAuthority()
String	getBackupAddress()
String	getBackupAddress(int defaultPort)
List<URL>	getBackupUrls()
boolean	getBooleanParameter(String key) Deprecated. Replace to getParameter(String, boolean)
boolean	getBooleanParameter(String key, boolean defaultValue) Deprecated. Replace to getParameter(String, boolean)
String	getHost()
int	getIntParameter(String key) Deprecated. Replace to getParameter(String, int)
int	getIntParameter(String key, int defaultValue) Deprecated. Replace to getParameter(String, int)
String	getIp() Fetch IP address for this URL.
boolean	getMethodBooleanParameter(String method, String key) Deprecated. Replace to getMethodParameter(String, String, boolean)
boolean	getMethodBooleanParameter(String method, String key, boolean defaultValue) Deprecated. Replace to getMethodParameter(String, String, boolean)
int	getMethodIntParameter(String method, String key) Deprecated. Replace to getMethodParameter(String, String, int)
int	getMethodIntParameter(String method, String key, int defaultValue) Deprecated. Replace to getMethodParameter(String, String, int)
String	getMethodParameter(String method, String key)
boolean	getMethodParameter(String method, String key, boolean defaultValue)
byte	getMethodParameter(String method, String key, byte defaultValue)
char	getMethodParameter(String method, String key, char defaultValue)
double	getMethodParameter(String method, String key, double defaultValue)
float	getMethodParameter(String method, String key, float defaultValue)
int	getMethodParameter(String method, String key, int defaultValue)
long	getMethodParameter(String method, String key, long defaultValue)
short	getMethodParameter(String method, String key, short defaultValue)
String	getMethodParameter(String method, String key, String defaultValue)
String	getMethodParameterAndDecoded(String method, String key)
String	getMethodParameterAndDecoded(String method, String key, String defaultValue)
int	getMethodPositiveIntParameter(String method, String key, int defaultValue) Deprecated. Replace to getMethodPositiveParameter(String, String, int)
byte	getMethodPositiveParameter(String method, String key, byte defaultValue)
double	getMethodPositiveParameter(String method, String key, double defaultValue)
float	getMethodPositiveParameter(String method, String key, float defaultValue)
int	getMethodPositiveParameter(String method, String key, int defaultValue)
long	getMethodPositiveParameter(String method, String key, long defaultValue)
short	getMethodPositiveParameter(String method, String key, short defaultValue)
String	getParameter(String key)
boolean	getParameter(String key, boolean defaultValue)
byte	getParameter(String key, byte defaultValue)
char	getParameter(String key, char defaultValue)
double	getParameter(String key, double defaultValue)
float	getParameter(String key, float defaultValue)
int	getParameter(String key, int defaultValue)
long	getParameter(String key, long defaultValue)
short	getParameter(String key, short defaultValue)
String	getParameter(String key, String defaultValue)
String[]	getParameter(String key, String[] defaultValue)
String	getParameterAndDecoded(String key)
String	getParameterAndDecoded(String key, String defaultValue)
Map<String,String>	getParameters()
String	getPassword()
String	getPath()
int	getPort()
int	getPort(int defaultPort)
int	getPositiveIntParameter(String key, int defaultValue) Deprecated. Replace to getPositiveParameter(String, int)
byte	getPositiveParameter(String key, byte defaultValue)
double	getPositiveParameter(String key, double defaultValue)
float	getPositiveParameter(String key, float defaultValue)
int	getPositiveParameter(String key, int defaultValue)
long	getPositiveParameter(String key, long defaultValue)
short	getPositiveParameter(String key, short defaultValue)
String	getProtocol()
String	getRawParameter(String key)
String	getServiceInterface()
String	getServiceKey()
String	getServiceName() Deprecated.
URL	getUrlParameter(String key)
String	getUsername()
int	hashCode()
boolean	hasMethodParameter(String method, String key)
boolean	hasParameter(String key)
boolean	isAnyHost()
boolean	isLocalHost()
URL	removeParameter(String key)
URL	removeParameters(Collection<String> keys)
URL	removeParameters(String... keys)
URL	setAddress(String address)
URL	setHost(String host)
URL	setPassword(String password)
URL	setPath(String path)
URL	setPort(int port)
URL	setProtocol(String protocol)
URL	setServiceInterface(String service)
URL	setUsername(String username)
String	toFullString()
String	toFullString(String... parameters)
String	toIdentityString()
String	toIdentityString(String... parameters)
InetSocketAddress	toInetSocketAddress()
URL	toJavaURL()
Map<String,String>	toMap()
String	toParameterString()
String	toParameterString(String... parameters)
String	toServiceString()
String	toServiceStringWithoutResolving()
String	toString()
String	toString(String... parameters)
static URL	valueOf(String url) Parse url string

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

URL

public URL(String protocol,
   String host,
   int port)

URL

public URL(String protocol,
   String host,
   int port,
   String[] pairs)

URL

public URL(String protocol,
   String host,
   int port,
   Map<String,String> parameters)

URL

public URL(String protocol,
   String host,
   int port,
   String path)

URL

public URL(String protocol,
   String host,
   int port,
   String path,
   String... pairs)

URL

public URL(String protocol,
   String host,
   int port,
   String path,
   Map<String,String> parameters)

URL

public URL(String protocol,
   String username,
   String password,
   String host,
   int port,
   String path)

URL

public URL(String protocol,
   String username,
   String password,
   String host,
   int port,
   String path,
   String... pairs)

URL

public URL(String protocol,
   String username,
   String password,
   String host,
   int port,
   String path,
   Map<String,String> parameters)

Method Detail

valueOf

public static URL valueOf(String url)

Parse url string

Parameters:

url - URL string

Returns:

URL instance

See Also:

URL

encode

public static String encode(String value)

decode

public static String decode(String value)

getProtocol

public String getProtocol()

setProtocol

public URL setProtocol(String protocol)

getUsername

public String getUsername()

setUsername

public URL setUsername(String username)

getPassword

public String getPassword()

setPassword

public URL setPassword(String password)

getAuthority

public String getAuthority()

getHost

public String getHost()

setHost

public URL setHost(String host)

getIp

public String getIp()

Fetch IP address for this URL. Pls. note that IP should be used instead of Host when to compare with socket's address or to search in a map which use address as its key.

Returns:

ip in string format

getPort

public int getPort()

setPort

public URL setPort(int port)

getPort

public int getPort(int defaultPort)

getAddress

public String getAddress()

setAddress

public URL setAddress(String address)

getBackupAddress

public String getBackupAddress()

getBackupAddress

public String getBackupAddress(int defaultPort)

getBackupUrls

public List<URL> getBackupUrls()

getPath

public String getPath()

setPath

public URL setPath(String path)

getAbsolutePath

public String getAbsolutePath()

getParameters

public Map<String,String> getParameters()

getParameterAndDecoded

public String getParameterAndDecoded(String key)

getParameterAndDecoded

public String getParameterAndDecoded(String key,
                            String defaultValue)

getParameter

public String getParameter(String key)

getParameter

public String getParameter(String key,
                  String defaultValue)

getParameter

public String[] getParameter(String key,
                    String[] defaultValue)

getUrlParameter

public URL getUrlParameter(String key)

getParameter

public double getParameter(String key,
                  double defaultValue)

getParameter

public float getParameter(String key,
                 float defaultValue)

getParameter

public long getParameter(String key,
                long defaultValue)

getParameter

public int getParameter(String key,
               int defaultValue)

getParameter

public short getParameter(String key,
                 short defaultValue)

getParameter

public byte getParameter(String key,
                byte defaultValue)

getPositiveParameter

public float getPositiveParameter(String key,
                         float defaultValue)

getPositiveParameter

public double getPositiveParameter(String key,
                          double defaultValue)

getPositiveParameter

public long getPositiveParameter(String key,
                        long defaultValue)

getPositiveParameter

public int getPositiveParameter(String key,
                       int defaultValue)

getPositiveParameter

public short getPositiveParameter(String key,
                         short defaultValue)

getPositiveParameter

public byte getPositiveParameter(String key,
                        byte defaultValue)

getParameter

public char getParameter(String key,
                char defaultValue)

getParameter

public boolean getParameter(String key,
                   boolean defaultValue)

hasParameter

public boolean hasParameter(String key)

getMethodParameterAndDecoded

public String getMethodParameterAndDecoded(String method,
                                  String key)

getMethodParameterAndDecoded

public String getMethodParameterAndDecoded(String method,
                                  String key,
                                  String defaultValue)

getMethodParameter

public String getMethodParameter(String method,
                        String key)

getMethodParameter

public String getMethodParameter(String method,
                        String key,
                        String defaultValue)

getMethodParameter

public double getMethodParameter(String method,
                        String key,
                        double defaultValue)

getMethodParameter

public float getMethodParameter(String method,
                       String key,
                       float defaultValue)

getMethodParameter

public long getMethodParameter(String method,
                      String key,
                      long defaultValue)

getMethodParameter

public int getMethodParameter(String method,
                     String key,
                     int defaultValue)

getMethodParameter

public short getMethodParameter(String method,
                       String key,
                       short defaultValue)

getMethodParameter

public byte getMethodParameter(String method,
                      String key,
                      byte defaultValue)

getMethodPositiveParameter

public double getMethodPositiveParameter(String method,
                                String key,
                                double defaultValue)

getMethodPositiveParameter

public float getMethodPositiveParameter(String method,
                               String key,
                               float defaultValue)

getMethodPositiveParameter

public long getMethodPositiveParameter(String method,
                              String key,
                              long defaultValue)

getMethodPositiveParameter

public int getMethodPositiveParameter(String method,
                             String key,
                             int defaultValue)

getMethodPositiveParameter

public short getMethodPositiveParameter(String method,
                               String key,
                               short defaultValue)

getMethodPositiveParameter

public byte getMethodPositiveParameter(String method,
                              String key,
                              byte defaultValue)

getMethodParameter

public char getMethodParameter(String method,
                      String key,
                      char defaultValue)

getMethodParameter

public boolean getMethodParameter(String method,
                         String key,
                         boolean defaultValue)

hasMethodParameter

public boolean hasMethodParameter(String method,
                         String key)

isLocalHost

public boolean isLocalHost()

isAnyHost

public boolean isAnyHost()

addParameterAndEncoded

public URL addParameterAndEncoded(String key,
                         String value)

addParameter

public URL addParameter(String key,
               boolean value)

addParameter

public URL addParameter(String key,
               char value)

addParameter

public URL addParameter(String key,
               byte value)

addParameter

public URL addParameter(String key,
               short value)

addParameter

public URL addParameter(String key,
               int value)

addParameter

public URL addParameter(String key,
               long value)

addParameter

public URL addParameter(String key,
               float value)

addParameter

public URL addParameter(String key,
               double value)

addParameter

public URL addParameter(String key,
               Enum<?> value)

addParameter

public URL addParameter(String key,
               Number value)

addParameter

public URL addParameter(String key,
               CharSequence value)

addParameter

public URL addParameter(String key,
               String value)

addParameterIfAbsent

public URL addParameterIfAbsent(String key,
                       String value)

addParameters

public URL addParameters(Map<String,String> parameters)

Add parameters to a new url.

Parameters:

parameters - parameters in key-value pairs

Returns:

A new URL

addParametersIfAbsent

public URL addParametersIfAbsent(Map<String,String> parameters)

addParameters

public URL addParameters(String... pairs)

addParameterString

public URL addParameterString(String query)

removeParameter

public URL removeParameter(String key)

removeParameters

public URL removeParameters(Collection<String> keys)

removeParameters

public URL removeParameters(String... keys)

clearParameters

public URL clearParameters()

getRawParameter

public String getRawParameter(String key)

toMap

public Map<String,String> toMap()

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(String... parameters)

toIdentityString

public String toIdentityString()

toIdentityString

public String toIdentityString(String... parameters)

toFullString

public String toFullString()

toFullString

public String toFullString(String... parameters)

toParameterString

public String toParameterString()

toParameterString

public String toParameterString(String... parameters)

toJavaURL

public URL toJavaURL()

toInetSocketAddress

public InetSocketAddress toInetSocketAddress()

getServiceKey

public String getServiceKey()

toServiceStringWithoutResolving

public String toServiceStringWithoutResolving()

toServiceString

public String toServiceString()

getServiceName

@Deprecated
public String getServiceName()

Deprecated.

getServiceInterface

public String getServiceInterface()

setServiceInterface

public URL setServiceInterface(String service)

getIntParameter

@Deprecated
public int getIntParameter(String key)

Deprecated. Replace to getParameter(String, int)

See Also:

getParameter(String, int)

getIntParameter

@Deprecated
public int getIntParameter(String key,
                             int defaultValue)

Deprecated. Replace to getParameter(String, int)

See Also:

getParameter(String, int)

getPositiveIntParameter

@Deprecated
public int getPositiveIntParameter(String key,
                                     int defaultValue)

Deprecated. Replace to getPositiveParameter(String, int)

See Also:

getPositiveParameter(String, int)

getBooleanParameter

@Deprecated
public boolean getBooleanParameter(String key)

Deprecated. Replace to getParameter(String, boolean)

See Also:

getParameter(String, boolean)

getBooleanParameter

@Deprecated
public boolean getBooleanParameter(String key,
                                     boolean defaultValue)

Deprecated. Replace to getParameter(String, boolean)

See Also:

getParameter(String, boolean)

getMethodIntParameter

@Deprecated
public int getMethodIntParameter(String method,
                                   String key)

Deprecated. Replace to getMethodParameter(String, String, int)

See Also:

getMethodParameter(String, String, int)

getMethodIntParameter

@Deprecated
public int getMethodIntParameter(String method,
                                   String key,
                                   int defaultValue)

Deprecated. Replace to getMethodParameter(String, String, int)

See Also:

getMethodParameter(String, String, int)

getMethodPositiveIntParameter

@Deprecated
public int getMethodPositiveIntParameter(String method,
                                           String key,
                                           int defaultValue)

Deprecated. Replace to getMethodPositiveParameter(String, String, int)

See Also:

getMethodPositiveParameter(String, String, int)

getMethodBooleanParameter

@Deprecated
public boolean getMethodBooleanParameter(String method,
                                           String key)

Deprecated. Replace to getMethodParameter(String, String, boolean)

See Also:

getMethodParameter(String, String, boolean)

getMethodBooleanParameter

@Deprecated
public boolean getMethodBooleanParameter(String method,
                                           String key,
                                           boolean defaultValue)

Deprecated. Replace to getMethodParameter(String, String, boolean)

See Also:

getMethodParameter(String, String, boolean)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object