com.screenscraper.http.util

Class SharedHttpClientBase

java.lang.Object

com.screenscraper.http.util.SharedHttpClientBase

All Implemented Interfaces:

SharedHttpClient, java.lang.AutoCloseable

Direct Known Subclasses:

AsyncScrapingHttpClient2.SharedAsyncHttpClient

public abstract class SharedHttpClientBase
extends java.lang.Object
implements SharedHttpClient

Base for a shared http client implementation

Version:

7.0.11a

Field Summary

Fields inherited from interface com.screenscraper.http.util.SharedHttpClient

SHUTDOWN_USE_COUNT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SharedHttpClientBase()

Method Summary

Modifier and Type	Method and Description
boolean	addUse() Attempts to mark a new use of this shared resources and returns whether or not the addition was successful
void	close()
protected abstract void	closeUnderlyingResources() Method called to close any resources when no more references are held to this object.
java.util.Set<SharedResourceUser>	getCurrentUsers() Returns a set of the current users of the client.
int	getOpenCount() Returns the number of open uses of the client
boolean	isClosed() Returns whether or not this shared resource is closed.
void	registerUser(SharedResourceUser user) Registers a user of the resource.
void	removeUser(SharedResourceUser user) Registers a user of the resource.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SharedHttpClientBase

protected SharedHttpClientBase()

Method Detail

addUse

public boolean addUse()

Description copied from interface: SharedHttpClient

Attempts to mark a new use of this shared resources and returns whether or not the addition was successful

Specified by:

addUse in interface SharedHttpClient

Returns:

True if a new use was registered, false if not (meaning it was already closed)

isClosed

public boolean isClosed()

Description copied from interface: SharedHttpClient

Returns whether or not this shared resource is closed. If closed it should no longer be used as underlying resources are no longer available. It should be noted that if this method is being called to check if another resource can use it, it is better to call the SharedHttpClient.addUse() method which atomically checks for availability and adds a new use. Otherwise you might check and get it's useable but then have it be closed by the time you call the next method on it

Specified by:

isClosed in interface SharedHttpClient

Returns:

True if the underlying resources are closed, false otherwise.

getOpenCount

public int getOpenCount()

Description copied from interface: SharedHttpClient

Returns the number of open uses of the client

Specified by:

getOpenCount in interface SharedHttpClient

Returns:

The number of open uses of the client

close

public void close()
           throws java.io.IOException

Specified by:

close in interface SharedHttpClient

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

registerUser

public void registerUser(@NotNull
                         SharedResourceUser user)

Description copied from interface: SharedHttpClient

Registers a user of the resource. Note this doesn't check if the resource is usable but is instead used for debugging to find leaks that aren't closed

Specified by:

registerUser in interface SharedHttpClient

Parameters:

user - The user to register

removeUser

public void removeUser(@NotNull
                       SharedResourceUser user)

Description copied from interface: SharedHttpClient

Registers a user of the resource. Note this doesn't check if the resource is usable but is instead used for debugging to find leaks that aren't closed

Specified by:

removeUser in interface SharedHttpClient

Parameters:

user - The user to remove

getCurrentUsers

@NotNull
public java.util.Set<SharedResourceUser> getCurrentUsers()

Description copied from interface: SharedHttpClient

Returns a set of the current users of the client. Note that by the time this returns the set may no longer be accurate

Specified by:

getCurrentUsers in interface SharedHttpClient

Returns:

A set of the current users of the client. Note that by the time this returns the set may no longer be accurate

closeUnderlyingResources

protected abstract void closeUnderlyingResources()
                                          throws java.io.IOException

Method called to close any resources when no more references are held to this object. This method should only be called once during the lifetime of the object

Throws:

java.io.IOException - On error closing the resources

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object