com.aspc.remote.rest.internal

Class ReSTUtil

java.lang.Object

com.aspc.remote.rest.internal.ReSTUtil

public final class ReSTUtil
extends java.lang.Object

ReST client which will cache requests for a given period.

Optimizations

• Requests that are for data that we have an existing result less than the cache period will return immediately.
• Requests that are for data that are half the age of the cache period will result in a "pre-fetch" request being made in the background.
• Multiple requests for the same URL will result in only one request to the web server. All requests will get the same result when returned.

THREAD MODE: MULTI-THREADED

Since:

Jan 9, 2014

Author:

Lei Gao

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HEADER_AUTHORIZATION Authorization header
static long	MAX_SAFE_INTEGER https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
static int	MAX_SAFE_URL_LENGTH Maximum URL length is 2,083 characters in Internet Explorer.
static long	MIN_SAFE_INTEGER https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MIN_SAFE_INTEGER

Method Summary

Modifier and Type	Method and Description
static void	checkURL(java.lang.String url) Check the URL is valid for a ReST call.
static void	checkURL(java.lang.String url, boolean checkUrlLength) Check the URL is valid for a ReST call.
static JSONObject	getGeoIp(java.lang.String ip) get json includes locations information for the given ip address
static java.lang.String	getLocationCity(java.lang.String ip)
static java.lang.String	getLocationCoordinates(java.lang.String ip)
static java.lang.String	getLocationCountryCode(java.lang.String ip)
static java.lang.String	getLocationRegion(java.lang.String ip)
static java.lang.String	getLocationZipCode(java.lang.String ip)
static java.lang.String	makeFileName(java.net.URL url, ReSTPlugin plugin, java.lang.String agent) Make a file name
static boolean	validateURL(java.lang.String url) Check the URL is valid for a ReST call.
static boolean	validateURL(java.lang.String url, boolean checkUrlLength) Check the URL is valid for a ReST call.
static boolean	validateURL(java.net.URL url) Check the URL is valid for a ReST call.
static boolean	validateURL(java.net.URL url, boolean checkUrlLength) Check the URL is valid for a ReST call.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SAFE_INTEGER

public static final long MAX_SAFE_INTEGER

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER

MIN_SAFE_INTEGER

public static final long MIN_SAFE_INTEGER

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MIN_SAFE_INTEGER

HEADER_AUTHORIZATION

public static final java.lang.String HEADER_AUTHORIZATION

Authorization header

See Also:

Constant Field Values

MAX_SAFE_URL_LENGTH

public static final int MAX_SAFE_URL_LENGTH

Maximum URL length is 2,083 characters in Internet Explorer. https://support.microsoft.com/en-us/kb/208427

See Also:

Constant Field Values

Method Detail

checkURL

public static void checkURL(@Nonnull
                            java.lang.String url)
                     throws java.lang.IllegalArgumentException

Check the URL is valid for a ReST call.

Parameters:

url - the URL to check

Throws:

java.lang.IllegalArgumentException

checkURL

public static void checkURL(@Nonnull
                            java.lang.String url,
                            boolean checkUrlLength)
                     throws java.lang.IllegalArgumentException

Check the URL is valid for a ReST call. https://perishablepress.com/stop-using-unsafe-characters-in-urls/

Parameters:

url - the URL to check

checkUrlLength - check the URL is less than the maximum safe length ( 2048)

Throws:

java.lang.IllegalArgumentException

validateURL

@CheckReturnValue
public static boolean validateURL(@Nonnull
                                                    java.lang.String url)

Check the URL is valid for a ReST call.

Parameters:

url - the URL to check

Returns:

true if valid

validateURL

@CheckReturnValue
public static boolean validateURL(@Nonnull
                                                    java.lang.String url,
                                                    boolean checkUrlLength)

Check the URL is valid for a ReST call.

Parameters:

url - the URL to check

checkUrlLength -

Returns:

true if valid

validateURL

@CheckReturnValue
public static boolean validateURL(@Nonnull
                                                    java.net.URL url)

Check the URL is valid for a ReST call.

Parameters:

url - the URL to check

Returns:

true if valid

validateURL

@CheckReturnValue
public static boolean validateURL(@Nonnull
                                                    java.net.URL url,
                                                    boolean checkUrlLength)

Check the URL is valid for a ReST call.

Parameters:

url - the URL to check

checkUrlLength -

Returns:

true if valid

makeFileName

@CheckReturnValue
 @Nonnull
public static java.lang.String makeFileName(@Nonnull
                                                                        java.net.URL url,
                                                                        @Nullable
                                                                        ReSTPlugin plugin,
                                                                        @Nullable
                                                                        java.lang.String agent)

Make a file name

Parameters:

url - the URL

plugin - the authorization

agent - the browser agent

Returns:

a simple name

getGeoIp

@CheckReturnValue
 @Nullable
public static JSONObject getGeoIp(@Nonnull
                                                               java.lang.String ip)
                                                        throws java.lang.Exception

get json includes locations information for the given ip address

Parameters:

ip -

Returns:

json or null

Throws:

java.lang.Exception

getLocationCity

@CheckReturnValue
 @Nonnull
public static java.lang.String getLocationCity(@Nonnull
                                                                           java.lang.String ip)
                                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getLocationCoordinates

@CheckReturnValue
 @Nonnull
public static java.lang.String getLocationCoordinates(@Nonnull
                                                                                  java.lang.String ip)
                                                                           throws java.lang.Exception

Throws:

java.lang.Exception

getLocationCountryCode

@CheckReturnValue
 @Nonnull
public static java.lang.String getLocationCountryCode(@Nonnull
                                                                                  java.lang.String ip)
                                                                           throws java.lang.Exception

Throws:

java.lang.Exception

getLocationRegion

@CheckReturnValue
 @Nonnull
public static java.lang.String getLocationRegion(@Nonnull
                                                                             java.lang.String ip)
                                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getLocationZipCode

@CheckReturnValue
 @Nonnull
public static java.lang.String getLocationZipCode(@Nonnull
                                                                              java.lang.String ip)
                                                                       throws java.lang.Exception

Throws:

java.lang.Exception