org.apache.commons.httpclient
Class HostConfiguration

java.lang.Object
  |
  +--org.apache.commons.httpclient.HostConfiguration
All Implemented Interfaces:
Cloneable

public class HostConfiguration
extends Object
implements Cloneable

Since:
2.0
Author:
Michael Becke, Mike Bowler

Constructor Summary
HostConfiguration()
          Constructor for HostConfiguration.
HostConfiguration(HostConfiguration hostConfiguration)
          Copy constructor for HostConfiguration
 
Method Summary
 Object clone()
           
 boolean equals(Object o)
           
 String getHost()
          Returns the host.
 String getHostURL()
          Return the host url.
 int getPort()
          Returns the port.
 Protocol getProtocol()
          Returns the protocol.
 String getProxyHost()
          Returns the proxyHost.
 int getProxyPort()
          Returns the proxyPort.
 int hashCode()
           
 boolean hostEquals(HttpConnection connection)
          Tests if the host configuration equals the configuraiton set on the connection.
 boolean isHostSet()
          Return true if the host is set.
 boolean isProxySet()
           
 boolean proxyEquals(HttpConnection connection)
          Tests if the proxy configuration equals the configuraiton set on the connection.
 void setHost(String host, int port, Protocol protocol)
          Sets this configuration's host infomation.
 void setHost(String host, int port, String protocol)
          Set the host
 void setHost(URI uri)
          Sets the protocol, host and port from the given URI.
 void setProxy(String proxyHost, int proxyPort)
          Set the proxy settings.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HostConfiguration

public HostConfiguration()
Constructor for HostConfiguration.


HostConfiguration

public HostConfiguration(HostConfiguration hostConfiguration)
Copy constructor for HostConfiguration

Parameters:
hostConfiguration - the hostConfiguration to copy
Method Detail

clone

public Object clone()
Overrides:
clone in class Object
See Also:
Object.clone()

hostEquals

public boolean hostEquals(HttpConnection connection)
Tests if the host configuration equals the configuraiton set on the connection. True only if the host, port and protocol are equal. If no host configuration has been set false will be returned.

Parameters:
connection - the connection to test against
Returns:
true if the connection's host information equals that of this configuration
See Also:
proxyEquals(HttpConnection)

proxyEquals

public boolean proxyEquals(HttpConnection connection)
Tests if the proxy configuration equals the configuraiton set on the connection. True only if the proxyHost and proxyPort are equal.

Parameters:
connection - the connection to test against
Returns:
true if the connection's proxy information equals that of this configuration
See Also:
hostEquals(HttpConnection)

isHostSet

public boolean isHostSet()
Return true if the host is set.

Returns:
boolean True if the host is set.

setHost

public void setHost(String host,
                    int port,
                    String protocol)
Set the host

Parameters:
host - The host.
port - The port
protocol - The protocol.

setHost

public void setHost(String host,
                    int port,
                    Protocol protocol)
Sets this configuration's host infomation.

Parameters:
host - the host, IP or DNS name
port - the host port or -1 to use protocol default
protocol - the protocol

setHost

public void setHost(URI uri)
Sets the protocol, host and port from the given URI.

Parameters:
uri - the URI.

getHostURL

public String getHostURL()
Return the host url.

Returns:
String The host url.

getHost

public String getHost()
Returns the host.

Returns:
String

getPort

public int getPort()
Returns the port.

Returns:
int

getProtocol

public Protocol getProtocol()
Returns the protocol.

Returns:
String The protocol.

isProxySet

public boolean isProxySet()
Returns:
boolean True if a proxy server has been set.

setProxy

public void setProxy(String proxyHost,
                     int proxyPort)
Set the proxy settings.

Parameters:
proxyHost - The proxy host
proxyPort - The proxy port

getProxyHost

public String getProxyHost()
Returns the proxyHost.

Returns:
String

getProxyPort

public int getProxyPort()
Returns the proxyPort.

Returns:
int

equals

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

hashCode

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


Copyright (c) 1999-2002 - Apache Software Foundation