Package com.github.m0nk3y2k4.thetvdb.api
Interface Proxy
-
- All Known Implementing Classes:
RemoteAPI
public interface Proxy
Interface representing a proxy service to be used for communication with the remote API. Such proxies may be provided when creating a new API instance in order to forward the all the communication towards this proxy rather than directly communicating with the the actual TheTVDB.com remote API. The latter one will be the default behavior if no specific proxy is set during the API instantiation. Instances of this interface might be created via theTheTVDBApiFactory
. The URI represented by this proxy will be assembled in the following form:protocol://host:port[/path]
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getHost()
Returns the host name of this proxy.Optional<String>
getPath()
Returns the optional path component of this proxy.int
getPort()
Returns the port number used for communication with this proxy.String
getProtocol()
Returns the name of the communication protocol used for this proxy.
-
-
-
Method Detail
-
getProtocol
String getProtocol()
Returns the name of the communication protocol used for this proxy.- Returns:
- The protocol name used by this proxy
-
getHost
String getHost()
Returns the host name of this proxy.- Returns:
- The host name of this proxy
-
getPath
Optional<String> getPath()
Returns the optional path component of this proxy.- Returns:
- The optional path component of this proxy
-
getPort
int getPort()
Returns the port number used for communication with this proxy.- Returns:
- The port number of this proxy
-
-