OpenJDK 27 · sun.net.www.http.HttpClient · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
protected volatile AuthCacheImpl	authcache
protected boolean	cachedHttpClient
private static final boolean	cacheNTLMProp
private CacheRequest	cacheRequest whether the response is to be cached
private static final boolean	cacheSPNEGOProp
private HttpCapture	capture
private final ReentrantLock	clientLock
pack-priv volatile boolean	disableKeepAlive
pack-priv boolean	failedOnce
protected String	host
private static final int	HTTP_CONTINUE
pack-priv static final int	httpPortNumber Default port number for http daemons.
private boolean	ignoreContinue Response code for CONTINUE
protected boolean	inCache
protected static final KeepAliveCache	kac
pack-priv int	keepAliveConnections
private static final boolean	keepAliveProp
pack-priv int	keepAliveTimeout
pack-priv volatile boolean	keepingAlive
private static final PlatformLogger	logger
protected int	port
pack-priv PosterOutputStream	poster
protected boolean	proxyDisabled
pack-priv MessageHeader	requests
private static final boolean	retryPostProp
public boolean	reuse
private static final String	spnegoCBT
pack-priv boolean	streaming
protected URL	url Url being fetched.
public boolean	usingProxy

Inherited from sun.net.NetworkClient:: connectTimeout DEFAULT_CONNECT_TIMEOUT DEFAULT_READ_TIMEOUT defaultConnectTimeout defaultSoTimeout encoding proxy readTimeout serverInput serverOutput serverSocket

Constructor Summary

Access	Constructor and Description
protected	HttpClient()
protected	HttpClient(URL url, boolean proxyDisabled)
public	HttpClient(URL url, String proxyHost, int proxyPort)
protected	HttpClient(URL url, Proxy p, int to)
private	HttpClient(URL url, String proxyHost, int proxyPort, boolean proxyDisabled)
public	HttpClient(URL url, String proxyHost, int proxyPort, boolean proxyDisabled, int to)

Method Summary

Modifier and Type	Method and Description
public void	afterConnect()
protected boolean	Returns: `true`, if the connection to the server is still established and there is no stale data to be read; `false`, otherwise available() Returns `true`, if the connection to the server is still established and there is no stale data to be read; `false`, otherwise.
private void	checkTunneling(HttpURLConnection httpuc)
public void	closeIdleConnection()
public void	closeServer() Overrides sun.net.NetworkClient.closeServer. Close an open connection to the server.
public void	finished()
public final AuthCacheImpl	getAuthCache()
pack-priv CacheRequest	getCacheRequest()
protected int	getDefaultPort() return default port number (subclasses may override)
private static int	getDefaultPort(String proto)
public boolean	getHttpKeepAliveSet() Returns: true iff http keep alive is set (i.e. enabled).
public Proxy	getHttpProxy()
public InputStream	getInputStream()
pack-priv int	getKeepAliveTimeout()
public OutputStream	getOutputStream()
public String	getProxyHostUsed() Returns: the proxy host being used for this client, or null if we're not going through a proxy
public int	getProxyPortUsed() Returns: the proxy port being used for this client.
pack-priv String	getRequestMethod()
public String	getSpnegoCBT()
public String	getURLFile()
public boolean	getUsingProxy()
public boolean	isCachedConnection()
protected boolean	isInKeepAliveCache()
public final boolean	isKeepingAlive()
public final void	lock()
private static void	logError(String msg)
private static void	logFinest(String msg)
public boolean	needsTunneling()
public static HttpClient	New(URL url)
public static HttpClient	New(URL url, boolean useCache)
public static HttpClient	New(URL url, Proxy p, int to, boolean useCache, HttpURLConnection httpuc)
public static HttpClient	New(URL url, Proxy p, int to, HttpURLConnection httpuc)
public static HttpClient	New(URL url, String proxyHost, int proxyPort, boolean useCache)
public static HttpClient	New(URL url, String proxyHost, int proxyPort, boolean useCache, int to, HttpURLConnection httpuc)
protected static Proxy	newHttpProxy(String proxyHost, int proxyPort, String proto)
pack-priv static String	normalizeCBT(String s)
public void	openServer(String server, int port) Overrides sun.net.NetworkClient.openServer. Open a connection to the server.
private void	openServer(final InetSocketAddress server)
protected void	openServer()
public boolean	parseHTTP(MessageHeader responses, HttpURLConnection httpuc) Parse the first line of the HTTP request.
private boolean	parseHTTPHeader(MessageHeader responses, HttpURLConnection httpuc)
protected void	putInKeepAliveCache()
public static synchronized void	resetProperties() Deprecated -- system properties are no longer cached. A NOP method kept for backwards binary compatibility
public void	setCacheRequest(CacheRequest cacheRequest)
public void	setDoNotRetry(boolean value)
public void	setIgnoreContinue(boolean value)
private void	superOpenServer(final String proxyHost, final int proxyPort)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public final void	unlock()
public void	writeRequests(MessageHeader head) Deprecated
public void	writeRequests(MessageHeader head, PosterOutputStream pos)
public void	writeRequests(MessageHeader head, PosterOutputStream pos, boolean streaming)

Inherited from sun.net.NetworkClient:: createSocket doConnect getConnectTimeout getLocalAddress getReadTimeout serverIsOpen setConnectTimeout setReadTimeout

Field Detail

authcache	back to summary
protected volatile AuthCacheImpl authcache

cachedHttpClient	back to summary
protected boolean cachedHttpClient

cacheNTLMProp	back to summary
private static final boolean cacheNTLMProp

cacheRequest	back to summary
private CacheRequest cacheRequest whether the response is to be cached

cacheSPNEGOProp	back to summary
private static final boolean cacheSPNEGOProp

capture	back to summary
private HttpCapture capture

clientLock	back to summary
private final ReentrantLock clientLock

disableKeepAlive	back to summary
pack-priv volatile boolean disableKeepAlive

failedOnce	back to summary
pack-priv boolean failedOnce

host	back to summary
protected String host

HTTP_CONTINUE	back to summary
private static final int HTTP_CONTINUE

httpPortNumber	back to summary
pack-priv static final int httpPortNumber Default port number for http daemons. REMIND: make these private

ignoreContinue	back to summary
private boolean ignoreContinue Response code for CONTINUE

inCache	back to summary
protected boolean inCache

kac	back to summary
protected static final KeepAliveCache kac

keepAliveConnections	back to summary
pack-priv int keepAliveConnections

keepAliveProp	back to summary
private static final boolean keepAliveProp

keepAliveTimeout	back to summary
pack-priv int keepAliveTimeout

keepingAlive	back to summary
pack-priv volatile boolean keepingAlive

logger	back to summary
private static final PlatformLogger logger

port	back to summary
protected int port

poster	back to summary
pack-priv PosterOutputStream poster

proxyDisabled	back to summary
protected boolean proxyDisabled

requests	back to summary
pack-priv MessageHeader requests

retryPostProp	back to summary
private static final boolean retryPostProp

reuse	back to summary
public boolean reuse

spnegoCBT	back to summary
private static final String spnegoCBT

streaming	back to summary
pack-priv boolean streaming

url	back to summary
protected URL url Url being fetched.

usingProxy	back to summary
public boolean usingProxy

Constructor Detail

HttpClient	back to summary
protected HttpClient()

HttpClient	back to summary
protected HttpClient(URL url, boolean proxyDisabled) throws IOException

HttpClient	back to summary
public HttpClient(URL url, String proxyHost, int proxyPort) throws IOException

HttpClient	back to summary
protected HttpClient(URL url, Proxy p, int to) throws IOException

HttpClient	back to summary
private HttpClient(URL url, String proxyHost, int proxyPort, boolean proxyDisabled) throws IOException

HttpClient	back to summary
public HttpClient(URL url, String proxyHost, int proxyPort, boolean proxyDisabled, int to) throws IOException

Method Detail

afterConnect	back to summary
public void afterConnect() throws IOException

available back to summary

available	back to summary
protected boolean available() Returns `true`, if the connection to the server is still established and there is no stale data to be read; `false`, otherwise. A `true` return value indicates that the connection is reusable for an HTTP request. A `false` return value indicates that the connection is either lost or dirty, and it should be closed. Returns:boolean `true`, if the connection to the server is still established and there is no stale data to be read; `false`, otherwise

protected boolean available()

Returns true, if the connection to the server is still established and there is no stale data to be read; false, otherwise.

A true return value indicates that the connection is reusable for an HTTP request. A false return value indicates that the connection is either lost or dirty, and it should be closed.

Returns:boolean: true, if the connection to the server is still established and there is no stale data to be read; false, otherwise

checkTunneling	back to summary
private void checkTunneling(HttpURLConnection httpuc) throws IOException

closeIdleConnection	back to summary
public void closeIdleConnection()

closeServer	back to summary
public void closeServer() Overrides sun.net.NetworkClient.closeServer. Doc from sun.net.NetworkClient.closeServer. Close an open connection to the server. Annotations @Override

closeServer

back to summary

public void closeServer()

Overrides sun.net.NetworkClient.closeServer.

Doc from sun.net.NetworkClient.closeServer.

Close an open connection to the server.

Annotations

@Override

finished	back to summary
public void finished()

getAuthCache	back to summary
public final AuthCacheImpl getAuthCache()

getCacheRequest	back to summary
pack-priv CacheRequest getCacheRequest()

getDefaultPort	back to summary
protected int getDefaultPort() return default port number (subclasses may override)

getDefaultPort	back to summary
private static int getDefaultPort(String proto)

getHttpKeepAliveSet	back to summary
public boolean getHttpKeepAliveSet() Returns:boolean true iff http keep alive is set (i.e. enabled). Defaults to true if the system property http.keepAlive isn't set.

getHttpProxy	back to summary
public Proxy getHttpProxy()

getInputStream	back to summary
public InputStream getInputStream()

getKeepAliveTimeout	back to summary
pack-priv int getKeepAliveTimeout()

getOutputStream	back to summary
public OutputStream getOutputStream()

getProxyHostUsed	back to summary
public String getProxyHostUsed() Returns:String the proxy host being used for this client, or null if we're not going through a proxy

getProxyPortUsed	back to summary
public int getProxyPortUsed() Returns:int the proxy port being used for this client. Meaningless if getProxyHostUsed() gives null.

getRequestMethod	back to summary
pack-priv String getRequestMethod()

getSpnegoCBT	back to summary
public String getSpnegoCBT()

getURLFile	back to summary
public String getURLFile() throws IOException

getUsingProxy	back to summary
public boolean getUsingProxy()

isCachedConnection	back to summary
public boolean isCachedConnection()

isInKeepAliveCache	back to summary
protected boolean isInKeepAliveCache()

isKeepingAlive	back to summary
public final boolean isKeepingAlive()

lock	back to summary
public final void lock()

logError	back to summary
private static void logError(String msg)

logFinest	back to summary
private static void logFinest(String msg)

needsTunneling	back to summary
public boolean needsTunneling()

New	back to summary
public static HttpClient New(URL url) throws IOException

New	back to summary
public static HttpClient New(URL url, boolean useCache) throws IOException

New	back to summary
public static HttpClient New(URL url, Proxy p, int to, boolean useCache, HttpURLConnection httpuc) throws IOException

New	back to summary
public static HttpClient New(URL url, Proxy p, int to, HttpURLConnection httpuc) throws IOException

New	back to summary
public static HttpClient New(URL url, String proxyHost, int proxyPort, boolean useCache) throws IOException

New	back to summary
public static HttpClient New(URL url, String proxyHost, int proxyPort, boolean useCache, int to, HttpURLConnection httpuc) throws IOException

newHttpProxy	back to summary
protected static Proxy newHttpProxy(String proxyHost, int proxyPort, String proto)

normalizeCBT	back to summary
pack-priv static String normalizeCBT(String s)

openServer

back to summary

public void openServer(String server, int port) throws IOException

Overrides sun.net.NetworkClient.openServer.

Doc from sun.net.NetworkClient.openServer.

Open a connection to the server.

Annotations

@Override

openServer	back to summary
private void openServer(final InetSocketAddress server) throws IOException

openServer	back to summary
protected void openServer() throws IOException

parseHTTP	back to summary
public boolean parseHTTP(MessageHeader responses, HttpURLConnection httpuc) throws IOException Parse the first line of the HTTP request. It usually looks something like: "HTTP/1.0 <number> comment\r\n".

parseHTTPHeader	back to summary
private boolean parseHTTPHeader(MessageHeader responses, HttpURLConnection httpuc) throws IOException

putInKeepAliveCache	back to summary
protected void putInKeepAliveCache()

resetProperties

back to summary

public static synchronized void resetProperties()

Deprecated

-- system properties are no longer cached.

A NOP method kept for backwards binary compatibility

Annotations

@Deprecated

setCacheRequest	back to summary
public void setCacheRequest(CacheRequest cacheRequest)

setDoNotRetry	back to summary
public void setDoNotRetry(boolean value)

setIgnoreContinue	back to summary
public void setIgnoreContinue(boolean value)

superOpenServer	back to summary
private void superOpenServer(final String proxyHost, final int proxyPort) throws IOException

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

unlock	back to summary
public final void unlock()

writeRequests	back to summary
public void writeRequests(MessageHeader head) Deprecated Annotations @Deprecated

writeRequests	back to summary
public void writeRequests(MessageHeader head, PosterOutputStream pos) throws IOException

writeRequests	back to summary
public void writeRequests(MessageHeader head, PosterOutputStream pos, boolean streaming) throws IOException

public Class HttpClient

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail