org.apache.http.conn.scheme.Scheme
Encapsulates specifics of a protocol scheme such as "http" or "https".
Schemes are identified by lowercase names.
Supported schemes are typically collected in a
SchemeRegistry.
For example, to configure support for "https://" URLs,
you could write code like the following:
Scheme https = new Scheme("https", new MySecureSocketFactory(), 443);
SchemeRegistry.DEFAULT.register(https);
Summary
Public Constructors
Public Methods
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Public Constructors
public
Scheme(String name, SocketFactory factory, int port)
Creates a new scheme.
Whether the created scheme allows for layered connections
depends on the class of
factory
.
Parameters
name
| the scheme name, for example "http".
The name will be converted to lowercase. |
factory
| the factory for creating sockets for communication
with this scheme |
port
| the default port for this scheme
|
Public Methods
public
final
boolean
equals(Object obj)
Compares this scheme to an object.
Parameters
obj
| the object to compare with |
Returns
true
iff the argument is equal to this scheme
public
final
int
getDefaultPort()
Obtains the default port.
Returns
- the default port for this scheme
public
final
String
getName()
Obtains the scheme name.
Returns
- the name of this scheme, in lowercase
public
int
hashCode()
Obtains a hash code for this scheme.
public
final
boolean
isLayered()
Indicates whether this scheme allows for layered connections.
Returns
true
if layered connections are possible,
false
otherwise
public
final
int
resolvePort(int port)
Resolves the correct port for this scheme.
Returns the given port if it is valid, the default port otherwise.
Parameters
port
| the port to be resolved,
a negative number to obtain the default port |
Returns
- the given port or the defaultPort
public
final
String
toString()
Return a string representation of this object.
Returns
- a human-readable string description of this scheme