org.apache.commons.httpclient.protocol
public class Protocol extends Object
One use case for modifying the default set of protocols would be to set a custom SSL socket factory. This would look something like the following:
Protocol myHTTPS = new Protocol( "https", new MySSLSocketFactory(), 443 ); Protocol.registerProtocol( "https", myHTTPS );
Since: 2.0
Constructor Summary | |
---|---|
Protocol(String scheme, ProtocolSocketFactory factory, int defaultPort)
Constructs a new Protocol. | |
Protocol(String scheme, SecureProtocolSocketFactory factory, int defaultPort)
Constructs a new Protocol. |
Method Summary | |
---|---|
boolean | equals(Object obj)
Return true if the specified object equals this object. |
int | getDefaultPort()
Returns the defaultPort. |
static Protocol | getProtocol(String id)
Gets the protocol with the given ID.
|
String | getScheme()
Returns the scheme. |
ProtocolSocketFactory | getSocketFactory()
Returns the socketFactory. |
int | hashCode()
Return a hash code for this object |
boolean | isSecure()
Returns true if this protocol is secure |
static void | registerProtocol(String id, Protocol protocol)
Registers a new protocol with the given identifier. |
int | resolvePort(int port)
Resolves the correct port for this protocol. |
String | toString()
Return a string representation of this object. |
static void | unregisterProtocol(String id)
Unregisters the protocol with the given ID.
|
factory
.
Parameters: scheme the scheme (e.g. http, https) factory the factory for creating sockets for communication using this protocol defaultPort the port this protocol defaults to
Deprecated: Use the constructor that uses ProtocolSocketFactory, this version of the constructor is only kept for backwards API compatibility.
Constructs a new Protocol. Whether the created protocol is secure depends on the class offactory
.
Parameters: scheme the scheme (e.g. http, https) factory the factory for creating sockets for communication using this protocol defaultPort the port this protocol defaults to
Parameters: obj The object to compare against.
Returns: true if the objects are equal.
Returns: int
Parameters: id the protocol ID
Returns: Protocol a protocol
Throws: IllegalStateException if a protocol with the ID cannot be found
Returns: The scheme
Returns: SocketFactory
Returns: The hash code.
Returns: true if this protocol is secure
Parameters: id the identifier for this protocol protocol the protocol to register
See Also: getProtocol
Parameters: port the port to be resolved
Returns: the given port or the defaultPort
Returns: a string representation of this object.
Parameters: id the ID of the protocol to remove