Class Protocol
java.lang.Object
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.protocol.Protocol
A class to encapsulate the specifics of a protocol. This class class also
provides the ability to customize the set and characteristics of the
protocols used.
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
ConstructorDescriptionProtocol
(String scheme, ProtocolSocketFactory factory, int defaultPort) Constructs a new Protocol.Protocol
(String scheme, SecureProtocolSocketFactory factory, int defaultPort) Deprecated.Use the constructor that uses ProtocolSocketFactory, this version of the constructor is only kept for backwards API compatibility. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Return true if the specified object equals this object.int
Returns the defaultPort.static Protocol
getProtocol
(String id) Gets the protocol with the given ID.Returns the scheme.Returns the socketFactory.int
hashCode()
Return a hash code for this objectboolean
isSecure()
Returns true if this protocol is securestatic 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.toString()
Return a string representation of this object.static void
Unregisters the protocol with the given ID.
-
Constructor Details
-
Protocol
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 protocoldefaultPort
- the port this protocol defaults to
-
Protocol
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 protocoldefaultPort
- the port this protocol defaults to
-
-
Method Details
-
registerProtocol
Registers a new protocol with the given identifier. If a protocol with the given ID already exists it will be overridden. This ID is the same one used to retrieve the protocol from getProtocol(String).- Parameters:
id
- the identifier for this protocolprotocol
- the protocol to register- See Also:
-
unregisterProtocol
Unregisters the protocol with the given ID.- Parameters:
id
- the ID of the protocol to remove
-
getProtocol
Gets the protocol with the given ID.- Parameters:
id
- the protocol ID- Returns:
- Protocol a protocol
- Throws:
IllegalStateException
- if a protocol with the ID cannot be found
-
getDefaultPort
public int getDefaultPort()Returns the defaultPort.- Returns:
- int
-
getSocketFactory
Returns the socketFactory. If secure the factory is a SecureProtocolSocketFactory.- Returns:
- SocketFactory
-
getScheme
Returns the scheme.- Returns:
- The scheme
-
isSecure
public boolean isSecure()Returns true if this protocol is secure- Returns:
- true if this protocol is secure
-
resolvePort
public int resolvePort(int port) Resolves the correct port for this protocol. Returns the given port if valid or the default port otherwise.- Parameters:
port
- the port to be resolved- Returns:
- the given port or the defaultPort
-
toString
Return a string representation of this object. -
equals
Return true if the specified object equals this object. -
hashCode
public int hashCode()Return a hash code for this object
-