com.aspc.remote.util.net

Class NetUtil

java.lang.Object

com.aspc.remote.util.net.NetUtil

public final class NetUtil
extends java.lang.Object

NetUtil
THREAD MODE: MULTI-THREADED

Since:

August 9, 1999, 5:21 PM

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.ThreadLocal<java.lang.String>	CACHE_PERIOD The default cache period to use when fetching files
static java.lang.String	KNOWN_INVALID_PASSWORD
static java.lang.String	LOCAL_HOST_NAME Local host name
static java.lang.String	NETCLIENT_MAX_ACTIVE The maximum number of connections per user/server
static java.lang.String	NETCLIENT_MAX_WAIT_MS Time in milliseconds to block for
static java.lang.String	NETCLIENT_TEST_IDLE_MS Time in milliseconds to check idle connections
static java.lang.ThreadLocal<java.lang.Boolean>	REPAIR_MODE
static java.util.concurrent.atomic.AtomicInteger	RETRY_ATTEMPTS the number of re-attempts on error

Method Summary

Modifier and Type	Method and Description
static NetClient	borrowClient(java.lang.String url) Borrow a Net client
static int	borrowedClientCount() The number of clients that are currently borrowed.
static boolean	canConnect(java.lang.String uri) Checks that we can connect to the server specified in the uri
static int	clientPoolSize() number of clients in the pool
static boolean	exists(java.lang.String uri, java.lang.String path) Checks if the file denoted by the given URI physically exists.
static java.io.File	fetchData(java.lang.String URLs, java.lang.String path, boolean haMode, java.lang.String checksum) fetch the file from the following location
static int	getMaxWaitTime()
static void	invalidateClient(NetClient client) Invalidate this Net client
static void	removeData(java.lang.String URLs, java.lang.String path) remove the data from the locations specified.
static void	renameData(java.lang.String URLs, java.lang.String originalPath, java.lang.String newPath) rename the original file to the new name/location
static void	retrieveData(java.lang.String URLs, java.lang.String path, java.io.File targetFile, boolean haMode, java.lang.String checksum) Retrieve a file from a list of locations.
static java.lang.String[]	retrieveFileList(java.lang.String url) Retrieve a list of file names from a URL passed.
static void	returnClient(NetClient client) return the Net client to the pool
static void	sendData(java.io.File rawFile, java.lang.String URLs, java.lang.String path) Send the raw file to the locations listed.
static void	setProgressListener(ProgressListener listener) set the progress listener

Methods inherited from class java.lang.Object

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

Field Detail

NETCLIENT_MAX_ACTIVE

public static final java.lang.String NETCLIENT_MAX_ACTIVE

The maximum number of connections per user/server

See Also:

Constant Field Values

NETCLIENT_MAX_WAIT_MS

public static final java.lang.String NETCLIENT_MAX_WAIT_MS

Time in milliseconds to block for

See Also:

Constant Field Values

NETCLIENT_TEST_IDLE_MS

public static final java.lang.String NETCLIENT_TEST_IDLE_MS

Time in milliseconds to check idle connections

See Also:

Constant Field Values

RETRY_ATTEMPTS

public static final java.util.concurrent.atomic.AtomicInteger RETRY_ATTEMPTS

the number of re-attempts on error

KNOWN_INVALID_PASSWORD

public static final java.lang.String KNOWN_INVALID_PASSWORD

See Also:

Constant Field Values

CACHE_PERIOD

public static final java.lang.ThreadLocal<java.lang.String> CACHE_PERIOD

The default cache period to use when fetching files

LOCAL_HOST_NAME

public static final java.lang.String LOCAL_HOST_NAME

Local host name

REPAIR_MODE

public static final java.lang.ThreadLocal<java.lang.Boolean> REPAIR_MODE

Method Detail

sendData

public static void sendData(@Nonnull
                            java.io.File rawFile,
                            @Nonnull
                            java.lang.String URLs,
                            @Nonnull
                            java.lang.String path)
                     throws java.lang.Exception

Send the raw file to the locations listed.

Parameters:

rawFile - The raw file to send

URLs - The list of URLs

path - The path to store the file.

Throws:

java.lang.Exception - A serious problem

removeData

public static void removeData(@Nonnull
                              java.lang.String URLs,
                              @Nonnull
                              java.lang.String path)
                       throws java.lang.Exception

remove the data from the locations specified.

Parameters:

URLs - The URLs for the file to be removed from.

path - The path of the file to be removed.

Throws:

java.lang.Exception - A serious problem

fetchData

@CheckReturnValue
 @Nonnull
public static java.io.File fetchData(@Nonnull
                                                                 java.lang.String URLs,
                                                                 @Nonnull
                                                                 java.lang.String path,
                                                                 boolean haMode,
                                                                 @Nullable
                                                                 java.lang.String checksum)
                                                          throws java.lang.Exception

fetch the file from the following location

Parameters:

checksum - the check sum

URLs - The locations to search

path - The file path

haMode - If in HA mode then if a file is missing we will sync between locations.

Returns:

The file

Throws:

java.lang.Exception - A serious problem

retrieveData

public static void retrieveData(@Nonnull
                                java.lang.String URLs,
                                @Nonnull
                                java.lang.String path,
                                @Nonnull
                                java.io.File targetFile,
                                boolean haMode,
                                @Nullable
                                java.lang.String checksum)
                         throws java.lang.Exception

Retrieve a file from a list of locations. No checks are done to determine if file already exists at the destination location

Parameters:

targetFile - the target file to receive to

checksum - the checksum

URLs - The locations to search

path - The file path

haMode - If in HA ( High Availability) mode then we ensure that volumes that have multiple urls have the file on all urls if it is found on one and not the others. This should not happen as files are placed at all locations in a volume when the file is uploaded.

Throws:

java.lang.Exception - A serious problem

renameData

public static void renameData(@Nonnull
                              java.lang.String URLs,
                              @Nonnull
                              java.lang.String originalPath,
                              @Nonnull
                              java.lang.String newPath)
                       throws java.lang.Exception

rename the original file to the new name/location

Parameters:

URLs - the locations to rename the file at

originalPath - the path of the file to be renamed

newPath - the path to rename to

Throws:

java.lang.Exception - a serious problem

exists

@CheckReturnValue
public static boolean exists(@Nonnull
                                               java.lang.String uri,
                                               @Nonnull
                                               java.lang.String path)
                                        throws java.lang.Exception

Checks if the file denoted by the given URI physically exists.

Parameters:

path - the file path

uri - the full uri to the file

Returns:

boolean true if the file exists

Throws:

java.lang.Exception - failure to perform check

canConnect

@CheckReturnValue
public static boolean canConnect(@Nonnull
                                                   java.lang.String uri)
                                            throws java.lang.Exception

Checks that we can connect to the server specified in the uri

Parameters:

uri - the full uri to the file

Returns:

boolean true if the server can be reached

Throws:

java.lang.Exception - failure to perform check

borrowClient

@CheckReturnValue
 @Nonnull
public static NetClient borrowClient(@Nonnull
                                                                 java.lang.String url)
                                                          throws java.lang.Exception

Borrow a Net client

Parameters:

url - The URL to connect to

Returns:

The Net Client

Throws:

java.lang.Exception - could not create connection

borrowedClientCount

@CheckReturnValue
 @Nonnegative
public static int borrowedClientCount()

The number of clients that are currently borrowed.

Returns:

The count of borrowed clients ( checked out but not back in yet)

clientPoolSize

@CheckReturnValue
 @Nonnegative
public static int clientPoolSize()
                                                          throws java.lang.Exception

number of clients in the pool

Returns:

int number

Throws:

java.lang.Exception - doesn't support exception

returnClient

public static void returnClient(@Nullable
                                NetClient client)
                         throws java.lang.Exception

return the Net client to the pool

Parameters:

client - The borrowed client

Throws:

java.lang.Exception - client not borrowed.

getMaxWaitTime

@CheckReturnValue
 @Nonnegative
public static int getMaxWaitTime()

Returns:

the max wait time.

invalidateClient

public static void invalidateClient(@Nullable
                                    NetClient client)
                             throws java.lang.Exception

Invalidate this Net client

Parameters:

client - The borrowed Net client

Throws:

java.lang.Exception - A serious problem

setProgressListener

public static void setProgressListener(@Nullable
                                       ProgressListener listener)

set the progress listener

Parameters:

listener - the listener

retrieveFileList

@CheckReturnValue
 @Nonnull
public static java.lang.String[] retrieveFileList(@Nonnull
                                                                              java.lang.String url)
                                                                       throws java.lang.Exception

Retrieve a list of file names from a URL passed.

Parameters:

url - the URL

Returns:

the file list

Throws:

java.lang.Exception - A serious problem