UrlUtilities (java-util 2.2.0 API)

java.lang.Object
- com.cedarsoftware.util.UrlUtilities

Deprecated.
```
@Deprecated
public final class UrlUtilities
extends Object
```
Useful utilities for working with UrlConnections and IO. Anyone using the deprecated api calls for proxying to urls should update to use the new suggested calls. To let the jvm proxy for you automatically, use the following -D parameters: http.proxyHost http.proxyPort (default: 80) http.nonProxyHosts (should always include localhost) https.proxyHost https.proxyPort Example: -Dhttp.proxyHost=proxy.example.org -Dhttp.proxyPort=8080 -Dhttps.proxyHost=proxy.example.org -Dhttps.proxyPort=8080 -Dhttp.nonProxyHosts=*.foo.com|localhost|*.td.afg

Author:

Ken Partlow, John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COOKIE` Deprecated.
`static String`	`COOKIE_VALUE_DELIMITER` Deprecated.
`static SafeSimpleDateFormat`	`DATE_FORMAT` Deprecated.
`static char`	`DOT` Deprecated.
`static String`	`EXPIRES` Deprecated.
`static TrustManager[]`	`NAIVE_TRUST_MANAGER` Deprecated.
`static HostnameVerifier`	`NAIVE_VERIFIER` Deprecated.
`protected static SSLSocketFactory`	`naiveSSLSocketFactory` Deprecated.
`static char`	`NAME_VALUE_SEPARATOR` Deprecated.
`static String`	`PATH` Deprecated.
`static ThreadLocal<String>`	`referrer` Deprecated.
`static String`	`SET_COOKIE` Deprecated.
`static String`	`SET_COOKIE_SEPARATOR` Deprecated.
`static ThreadLocal<String>`	`userAgent` Deprecated.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`clearGlobalReferrer()` Deprecated.
`static void`	`clearGlobalUserAgent()` Deprecated.
`static void`	`disconnect(HttpURLConnection c)` Deprecated.
`static URL`	`getActualUrl(String url)` Deprecated.
`static URLConnection`	`getConnection(String url, boolean input, boolean output, boolean cache)` Deprecated.
`static URLConnection`	`getConnection(URL url, boolean input, boolean output, boolean cache)` Deprecated.
`static URLConnection`	`getConnection(URL url, Map inCookies, boolean input, boolean output, boolean cache, boolean allowAllCerts)` Deprecated. Gets a connection from a url.
`static byte[]`	`getContentFromUrl(String url)` Deprecated. Get content from the passed in URL.
`static byte[]`	`getContentFromUrl(String url, Map inCookies, Map outCookies)` Deprecated. Get content from the passed in URL.
`static byte[]`	`getContentFromUrl(String url, Map inCookies, Map outCookies, boolean allowAllCerts)` Deprecated.
`static byte[]`	`getContentFromUrl(URL url, boolean allowAllCerts)` Deprecated. Get content from the passed in URL.
`static byte[]`	`getContentFromUrl(URL url, Map inCookies, Map outCookies, boolean allowAllCerts)` Deprecated. Get content from the passed in URL.
`static String`	`getContentFromUrlAsString(String url)` Deprecated. Get content from the passed in URL.
`static String`	`getContentFromUrlAsString(String url, Map inCookies, Map outCookies, boolean trustAllCerts)` Deprecated. Get content from the passed in URL.
`static String`	`getContentFromUrlAsString(URL url, boolean allowAllCerts)` Deprecated. Get content from the passed in URL.
`static String`	`getContentFromUrlAsString(URL url, Map inCookies, Map outCookies, boolean trustAllCerts)` Deprecated. Get content from the passed in URL.
`static String`	`getCookieDomainFromHost(String host)` Deprecated.
`static void`	`getCookies(URLConnection conn, Map store)` Deprecated. Retrieves and stores cookies returned by the host on the other side of the open java.net.URLConnection.
`static String`	`getReferrer()` Deprecated.
`static String`	`getUserAgent()` Deprecated.
`static void`	`readErrorResponse(URLConnection c)` Deprecated.
`static void`	`setCookies(URLConnection conn, Map store)` Deprecated. Prior to opening a URLConnection, calling this method will set all unexpired cookies that match the path or subpaths for thi underlying URL
`static void`	`setReferrer(String referer)` Deprecated.
`static void`	`setUserAgent(String agent)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - userAgent
```
public static final ThreadLocal<String> userAgent
```
    Deprecated.
  - referrer
```
public static final ThreadLocal<String> referrer
```
    Deprecated.
  - SET_COOKIE
```
public static final String SET_COOKIE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SET_COOKIE_SEPARATOR
```
public static final String SET_COOKIE_SEPARATOR
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - COOKIE
```
public static final String COOKIE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - COOKIE_VALUE_DELIMITER
```
public static final String COOKIE_VALUE_DELIMITER
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PATH
```
public static final String PATH
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - EXPIRES
```
public static final String EXPIRES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATE_FORMAT
```
public static final SafeSimpleDateFormat DATE_FORMAT
```
    Deprecated.
  - NAME_VALUE_SEPARATOR
```
public static final char NAME_VALUE_SEPARATOR
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DOT
```
public static final char DOT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - NAIVE_TRUST_MANAGER
```
public static final TrustManager[] NAIVE_TRUST_MANAGER
```
    Deprecated.
  - NAIVE_VERIFIER
```
public static final HostnameVerifier NAIVE_VERIFIER
```
    Deprecated.
  - naiveSSLSocketFactory
```
protected static SSLSocketFactory naiveSSLSocketFactory
```
    Deprecated.
- Method Detail
  - clearGlobalUserAgent
```
public static void clearGlobalUserAgent()
```
    Deprecated.
  - clearGlobalReferrer
```
public static void clearGlobalReferrer()
```
    Deprecated.
  - setReferrer
```
public static void setReferrer(String referer)
```
    Deprecated.
  - getReferrer
```
public static String getReferrer()
```
    Deprecated.
  - setUserAgent
```
public static void setUserAgent(String agent)
```
    Deprecated.
  - getUserAgent
```
public static String getUserAgent()
```
    Deprecated.
  - readErrorResponse
```
public static void readErrorResponse(URLConnection c)
```
    Deprecated.
  - disconnect
```
public static void disconnect(HttpURLConnection c)
```
    Deprecated.
  - getCookies
```
public static void getCookies(URLConnection conn,
                              Map store)
```
    Deprecated.
    
    Retrieves and stores cookies returned by the host on the other side of the open java.net.URLConnection.
    The connection MUST have been opened using the connect() method or a IOException will be thrown.
    
    Parameters:
    
    conn - a java.net.URLConnection - must be open, or IOException will be thrown
  - setCookies
```
public static void setCookies(URLConnection conn,
                              Map store)
                       throws IOException
```
    Deprecated.
    
    Prior to opening a URLConnection, calling this method will set all unexpired cookies that match the path or subpaths for thi underlying URL
    The connection MUST NOT have been opened method or an IOException will be thrown.
    
    Parameters:
    
    conn - a java.net.URLConnection - must NOT be open, or IOException will be thrown
    
    Throws:
    
    IOException - Thrown if conn has already been opened.
  - getCookieDomainFromHost
```
public static String getCookieDomainFromHost(String host)
```
    Deprecated.
  - getContentFromUrlAsString
```
public static String getContentFromUrlAsString(String url)
```
    Deprecated.
    
    Get content from the passed in URL. This code will open a connection to the passed in server, fetch the requested content, and return it as a String.
    
    Parameters:
    
    url - URL to hit
    
    Returns:
    
    UTF-8 String read from URL or null in the case of error.
  - getContentFromUrlAsString
```
public static String getContentFromUrlAsString(URL url,
                                               boolean allowAllCerts)
```
    Deprecated.
    
    Get content from the passed in URL. This code will open a connection to the passed in server, fetch the requested content, and return it as a String.
    
    Parameters:
    
    url - URL to hit
    
    allowAllCerts - true to not verify certificates
    
    Returns:
    
    UTF-8 String read from URL or null in the case of error.
  - getContentFromUrlAsString
```
public static String getContentFromUrlAsString(String url,
                                               Map inCookies,
                                               Map outCookies,
                                               boolean trustAllCerts)
```
    Deprecated.
    
    Get content from the passed in URL. This code will open a connection to the passed in server, fetch the requested content, and return it as a String.
    
    Parameters:
    
    url - URL to hit
    
    inCookies - Map of session cookies (or null if not needed)
    
    outCookies - Map of session cookies (or null if not needed)
    
    trustAllCerts - if true, SSL connection will always be trusted.
    
    Returns:
    
    String of content fetched from URL.
  - getContentFromUrlAsString
```
public static String getContentFromUrlAsString(URL url,
                                               Map inCookies,
                                               Map outCookies,
                                               boolean trustAllCerts)
```
    Deprecated.
    
    Get content from the passed in URL. This code will open a connection to the passed in server, fetch the requested content, and return it as a String.
    
    Parameters:
    
    url - URL to hit
    
    inCookies - Map of session cookies (or null if not needed)
    
    outCookies - Map of session cookies (or null if not needed)
    
    trustAllCerts - if true, SSL connection will always be trusted.
    
    Returns:
    
    String of content fetched from URL.
  - getContentFromUrl
```
public static byte[] getContentFromUrl(String url)
```
    Deprecated.
    
    Get content from the passed in URL. This code will open a connection to the passed in server, fetch the requested content, and return it as a byte[].
    
    Parameters:
    
    url - URL to hit
    
    Returns:
    
    byte[] read from URL or null in the case of error.
  - getContentFromUrl
```
public static byte[] getContentFromUrl(URL url,
                                       boolean allowAllCerts)
```
    Deprecated.
    
    Get content from the passed in URL. This code will open a connection to the passed in server, fetch the requested content, and return it as a byte[].
    
    Parameters:
    
    url - URL to hit
    
    Returns:
    
    byte[] read from URL or null in the case of error.
  - getContentFromUrl
```
public static byte[] getContentFromUrl(String url,
                                       Map inCookies,
                                       Map outCookies,
                                       boolean allowAllCerts)
```
    Deprecated.
  - getContentFromUrl
```
public static byte[] getContentFromUrl(URL url,
                                       Map inCookies,
                                       Map outCookies,
                                       boolean allowAllCerts)
```
    Deprecated.
    
    Get content from the passed in URL. This code will open a connection to the passed in server, fetch the requested content, and return it as a byte[].
    
    Parameters:
    
    url - URL to hit
    
    inCookies - Map of session cookies (or null if not needed)
    
    outCookies - Map of session cookies (or null if not needed)
    
    allowAllCerts - override certificate validation?
    
    Returns:
    
    byte[] of content fetched from URL.
  - getContentFromUrl
```
public static byte[] getContentFromUrl(String url,
                                       Map inCookies,
                                       Map outCookies)
```
    Deprecated.
    
    Get content from the passed in URL. This code will open a connection to the passed in server, fetch the requested content, and return it as a byte[].
    
    Parameters:
    
    url - URL to hit
    
    inCookies - Map of session cookies (or null if not needed)
    
    outCookies - Map of session cookies (or null if not needed)
    
    Returns:
    
    byte[] of content fetched from URL.
  - getConnection
```
public static URLConnection getConnection(String url,
                                          boolean input,
                                          boolean output,
                                          boolean cache)
                                   throws IOException
```
    Deprecated.
    
    Parameters:
    
    input - boolean indicating whether this connection will be used for input
    
    output - boolean indicating whether this connection will be used for output
    
    cache - boolean allow caching (be careful setting this to true for non-static retrievals).
    
    Returns:
    
    URLConnection established URL connection.
    
    Throws:
    
    IOException
  - getConnection
```
public static URLConnection getConnection(URL url,
                                          boolean input,
                                          boolean output,
                                          boolean cache)
                                   throws IOException
```
    Deprecated.
    
    Parameters:
    
    input - boolean indicating whether this connection will be used for input
    
    output - boolean indicating whether this connection will be used for output
    
    cache - boolean allow caching (be careful setting this to true for non-static retrievals).
    
    Returns:
    
    URLConnection established URL connection.
    
    Throws:
    
    IOException
  - getConnection
```
public static URLConnection getConnection(URL url,
                                          Map inCookies,
                                          boolean input,
                                          boolean output,
                                          boolean cache,
                                          boolean allowAllCerts)
                                   throws IOException
```
    Deprecated.
    
    Gets a connection from a url. All getConnection calls should go through this code.
    
    Parameters:
    
    inCookies - Supply cookie Map (received from prior setCookies calls from server)
    
    input - boolean indicating whether this connection will be used for input
    
    output - boolean indicating whether this connection will be used for output
    
    cache - boolean allow caching (be careful setting this to true for non-static retrievals).
    
    Returns:
    
    URLConnection established URL connection.
    
    Throws:
    
    IOException
  - getActualUrl
```
public static URL getActualUrl(String url)
                        throws MalformedURLException
```
    Deprecated.
    
    Throws:
    
    MalformedURLException

Class UrlUtilities

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

userAgent

referrer

SET_COOKIE

SET_COOKIE_SEPARATOR

COOKIE

COOKIE_VALUE_DELIMITER

PATH

EXPIRES

DATE_FORMAT

NAME_VALUE_SEPARATOR

DOT

NAIVE_TRUST_MANAGER

NAIVE_VERIFIER

naiveSSLSocketFactory

Method Detail

clearGlobalUserAgent

clearGlobalReferrer

setReferrer

getReferrer

setUserAgent

getUserAgent

readErrorResponse

disconnect

getCookies

setCookies

getCookieDomainFromHost

getContentFromUrlAsString

getContentFromUrlAsString

getContentFromUrlAsString

getContentFromUrlAsString

getContentFromUrl

getContentFromUrl

getContentFromUrl

getContentFromUrl

getContentFromUrl

getConnection

getConnection

getConnection

getActualUrl