UrlUtil (JDFLibJ 2.1.4a.76 API)

java.lang.Object
- org.cip4.jdflib.util.UrlUtil

Direct Known Subclasses:

MimeUtil
```
public class UrlUtil
extends Object
```
collection of helper routines to convert urls

Author:

prosirai

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UrlUtil.HTTPDetails` helper class to set mime details
`static class`	`UrlUtil.URLProtocol` rough classification of protocol type

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APPLICATION_PDF` pdf, duh...
`static String`	`APPLICATION_PS` ps, duh...
`static String`	`APPLICATION_XML` the preferred value for XML!
`static String`	`APPLICATION_XZIP` zip, maybe?
`static String`	`APPLICATION_ZIP` zip, maybe?
`static String`	`BASE64`
`static String`	`BINARY`
`static String`	`CLOSE`
`static String`	`CONTENT_ID`
`static String`	`CONTENT_LENGTH` more commonly used strings
`static String`	`CONTENT_TRANSFER_ENCODING`
`static String`	`CONTENT_TYPE` more commonly used strings
`static String`	`GET` http get method
`static String`	`HEAD` http head method
`static String`	`KEEPALIVE`
`static String`	`m_UNCEscape` strings that must be escaped in uncs
`static String`	`m_URIEscape` strings that must be escaped in urls
`static String`	`POST` http post method
`static String`	`TEXT_CSV`
`static String`	`TEXT_HTML`
`static String`	`TEXT_PLAIN`
`static String`	`TEXT_UNKNOWN`
`static String`	`TEXT_XML`
`static String`	`VND_JDF`
`static String`	`VND_JMF`

Constructor Summary

Constructors
Constructor and Description

UrlUtil()

Constructors
Constructor and Description
`UrlUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`addParameter(String baseUrl, String key, String val)` adds a parameter to a given url using either ? or &
`static String`	`addPath(String baseUrl, String path)` adds a path to a given url , keeping the parameters
`static String`	`cleanDots(String url)` remove any internal "../" "./" and "//" from a url
`static String`	`cleanHttpURL(String url)` create a "real" url from a user input url add http://
`static String`	`createHttpUrl(boolean bSecure, String host, int port, String path)` get a prinect url for this host and path
`static String`	`escape(String toEscape, boolean bEscape128)` standard url escaping
`static String`	`extension(String pathName)` get the filename extension of pathName excluding the '.' if no '.' is found, returns null if trailing .
`static String`	`fileToUrl(File f, boolean bEscape128)` Convert a File to a valid file URL or IRL note that some internal functions use network protocol and therefor performance may be non-optimal
`static byte[]`	`getBytesFromIP(String ip)` get the ip address as a set of bytes with the left byte at pos 0
`static InputStream`	`getCidURLStream(String url, javax.mail.Multipart multipart)` get a readable inputstream from the CID url
`static File`	`getCreateDirectory(String newDir)` Deprecated. use FileUtil.getCreateDirectory(newDir);
`static String`	`getExtensionFromMimeType(String contentType)` generates the correct extension for a given mime content type
`static String`	`getFileName(String url, javax.mail.Multipart mp)` get the file name for a url.
`static String`	`getIPFromBytes(byte[] ip)` get the ip address as a string with the left byte at pos 0
`static String`	`getLocalURL(String directory, String url)` get the local url without directory schemes in the base url are case insensitive, all others are case sensitive
`static String`	`getMimeTypeFromURL(String url)` generates the correct MIMEType for a given URL and sets it
`static String`	`getParentDirectory(String url)` get the parent directory of a file or url
`static UrlUtil.URLProtocol`	`getProtocol(String url)` returns the general protocol type of a url
`static String`	`getRelativePath(File f, File fCWD)` returns the relative URL of a file relative to the current working directory this includes escaping of %20 etc.
`static String`	`getRelativeURL(File f, File baseDir, boolean bEscape128)` returns the relative URL of a file relative to the current working directory
`static InputStream`	`getURLInputStream(String urlString)`
`static InputStream`	`getURLInputStream(String urlString, javax.mail.BodyPart bodyPart)` get the opened input stream for a given url string
`static UrlPart[]`	`getURLParts(HttpURLConnection connection)` get an array of urlparts, regardless of whether this was mime or not if the stream is mime/multipart get also extract that
`static String`	`getURLWithDirectory(String directory, String url)` concatenate directory and url to a single path IF and only IF url is a relative url relative urls MUST NOT have a scheme (e.g.
`static boolean`	`isCID(String url)` test whether a given url is a cid (cid:)
`static boolean`	`isEscaped(String url)` test whether a given url is escaped as utf-8
`static boolean`	`isFile(String url)` is this a valid file url
`static boolean`	`isFileOK(File f)` checks whether there is a remote chance that the file is useful for reading
`static boolean`	`isHttp(String url)` test whether a given url is an http url (excluding https - @see isHttps)
`static boolean`	`isHttps(String url)` test whether a given url is an https url
`static boolean`	`isIRL(String val)`
`static boolean`	`isMIME(File file)` check whether a file is a mime file only check extensions TODO sniff file rather than check extensions
`static boolean`	`isMIMEExtenstension(String lower)` check whether a file is a mime file
`static boolean`	`isNotCID(String url)` test whether a given url is NOT a cid this may be a local identifier
`static boolean`	`isRelativeURL(String url)` if true this url is relative
`static boolean`	`isUNC(String pathName)` test whether a given url is a unc path
`static boolean`	`isURL(String val)`
`static boolean`	`isWindowsLocalPath(String pathName)`
`static boolean`	`isXMLType(String contentType)` check whether the mime type is a known xml dialect
`static boolean`	`isZIPType(String contentType)` check whether the mime type is a known zip dialect
`static File`	`moveToDir(IURLSetter parent, File dir, boolean overWrite)` Deprecated. use moveToDir(parent, dir, null, overWrite);
`static File`	`moveToDir(IURLSetter parent, File dir, String cwd, boolean overWrite)` physically store the file at the location specified in dir and also modify this to reflect the new location
`static String`	`newExtension(String strWork, String newExt)` replace the .extension of a file name
`static String`	`normalize(String urlString)` normalize a url string by grinding it through url
`static String`	`prefix(String strWork)` inverse of extension
`static String`	`removeExtension(String pathName)` Deprecated. use prefix(pathName)
`static String`	`removeProtocol(String url)` remove athe protocol part of a url, if it is specified
`static URL`	`stringToURL(String urlString)` Create a URL for any url string using heuristics and escaping
`static String`	`uncToUrl(String unc, boolean escape128)`
`static String`	`unEscape(String toEscape)` standard url unescaping
`static File`	`urlToFile(String urlString)` Retrieve a file for a relative or absolute file url
`static String`	`urlToFileName(String urlString)`
`static String`	`urlToString(URL url)` null safe url to string converter
`static String`	`urlToUNC(String urlString)` Retrieve a UNC path for a relative or absolute file url, any of '/'or "\\" is assumed a path separator
`static UrlPart`	`writeToURL(String strUrl, InputStream stream, String method, String contentType, UrlUtil.HTTPDetails details)` write a Stream to an output URL File: and http: are currently supported Use HttpURLConnection.getInputStream() to retrieve the http response

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

- Field Detail
  - POST
```
public static final String POST
```
    http post method
    
    See Also:
    Constant Field Values
  - GET
```
public static final String GET
```
    http get method
    
    See Also:
    Constant Field Values
  - HEAD
```
public static final String HEAD
```
    http head method
    
    See Also:
    Constant Field Values
  - KEEPALIVE
```
public static final String KEEPALIVE
```
    See Also:
    Constant Field Values
  - CLOSE
```
public static final String CLOSE
```
    See Also:
    Constant Field Values
  - CONTENT_TRANSFER_ENCODING
```
public static final String CONTENT_TRANSFER_ENCODING
```
    See Also:
    Constant Field Values
  - m_URIEscape
```
public static final String m_URIEscape
```
    strings that must be escaped in urls
    
    See Also:
    Constant Field Values
  - m_UNCEscape
```
public static final String m_UNCEscape
```
    strings that must be escaped in uncs
    
    See Also:
    Constant Field Values
  - TEXT_HTML
```
public static final String TEXT_HTML
```
    See Also:
    Constant Field Values
  - TEXT_PLAIN
```
public static final String TEXT_PLAIN
```
    See Also:
    Constant Field Values
  - TEXT_UNKNOWN
```
public static final String TEXT_UNKNOWN
```
    See Also:
    Constant Field Values
  - APPLICATION_XML
```
public static final String APPLICATION_XML
```
    the preferred value for XML!
    
    See Also:
    Constant Field Values
  - APPLICATION_ZIP
```
public static final String APPLICATION_ZIP
```
    zip, maybe?
    
    See Also:
    Constant Field Values
  - APPLICATION_XZIP
```
public static final String APPLICATION_XZIP
```
    zip, maybe?
    
    See Also:
    Constant Field Values
  - APPLICATION_PDF
```
public static final String APPLICATION_PDF
```
    pdf, duh...
    
    See Also:
    Constant Field Values
  - APPLICATION_PS
```
public static final String APPLICATION_PS
```
    ps, duh...
    
    See Also:
    Constant Field Values
  - TEXT_XML
```
public static final String TEXT_XML
```
    See Also:
    Constant Field Values
  - TEXT_CSV
```
public static final String TEXT_CSV
```
    See Also:
    Constant Field Values
  - VND_JDF
```
public static final String VND_JDF
```
    See Also:
    Constant Field Values
  - VND_JMF
```
public static final String VND_JMF
```
    See Also:
    Constant Field Values
  - CONTENT_ID
```
public static final String CONTENT_ID
```
    See Also:
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    more commonly used strings
    
    See Also:
    Constant Field Values
  - CONTENT_LENGTH
```
public static final String CONTENT_LENGTH
```
    more commonly used strings
    
    See Also:
    Constant Field Values
  - BASE64
```
public static final String BASE64
```
    See Also:
    Constant Field Values
  - BINARY
```
public static final String BINARY
```
    See Also:
    Constant Field Values
- Constructor Detail
  - UrlUtil
```
public UrlUtil()
```
- Method Detail
  - getRelativeURL
```
public static String getRelativeURL(File f,
                    File baseDir,
                    boolean bEscape128)
```
    returns the relative URL of a file relative to the current working directory
    
    Parameters:
    f - the file to get the relative url for
    baseDir - the file that describes cwd, if null cwd is calculated
    bEscape128 - if true, escape > 128 (URL), else retain (IRL)
    
    Returns:
  - createHttpUrl
```
public static String createHttpUrl(boolean bSecure,
                   String host,
                   int port,
                   String path)
```
    get a prinect url for this host and path
    
    Parameters:
    bSecure - if true, make https
    host - hostname
    port - the port, duh
    path - may be null
    
    Returns:
  - getRelativePath
```
public static String getRelativePath(File f,
                     File fCWD)
```
    returns the relative URL of a file relative to the current working directory
    this includes escaping of %20 etc.
    
    Parameters:
    f - the file to get the relative path for
    fCWD - the file that describes cwd, if null cwd is calculated from user.dir
    
    Returns:
  - getFileName
```
public static String getFileName(String url,
                 javax.mail.Multipart mp)
```
    get the file name for a url. extract it from a mime package, if appropriate
    
    Parameters:
    url -
    mp -
    
    Returns:
  - getCidURLStream
```
public static InputStream getCidURLStream(String url,
                          javax.mail.Multipart multipart)
```
    get a readable inputstream from the CID url
    
    Parameters:
    url - the url to get a stream for
    multipart - the multipart mime to which the cid refers
    
    Returns:
    InputStream - the readable input stream that this filespec refers to, null if broken or non-existent
  - extension
```
public static String extension(String pathName)
```
    get the filename extension of pathName excluding the '.' if no '.' is found, returns null if trailing . is found, returns ""
    
    Parameters:
    pathName - the pathName to get the extension for
    
    Returns:
    String - the filename extension
  - removeExtension
```
@Deprecated
public static String removeExtension(String pathName)
```
    Deprecated. use prefix(pathName)
    
    get the path name without extension of pathName
    
    Parameters:
    pathName - the pathName to get the extension for
    
    Returns:
    String - the filename without extension
  - getURLParts
```
public static UrlPart[] getURLParts(HttpURLConnection connection)
```
    get an array of urlparts, regardless of whether this was mime or not if the stream is mime/multipart get also extract that
    
    Parameters:
    connection -
    
    Returns:
    the array of body parts input stream
  - getURLInputStream
```
public static InputStream getURLInputStream(String urlString,
                            javax.mail.BodyPart bodyPart)
```
    get the opened input stream for a given url string
    
    Parameters:
    urlString -
    bodyPart -
    
    Returns:
  - getURLInputStream
```
public static InputStream getURLInputStream(String urlString)
```
    Parameters:
    urlString -
    
    Returns:
  - getCreateDirectory
```
@Deprecated
public static File getCreateDirectory(String newDir)
```
    Deprecated. use FileUtil.getCreateDirectory(newDir);
    
    create a new directory and return null if the directory could not be created
    
    Parameters:
    newDir - the path or URL of the new directory
    
    Returns:
  - fileToUrl
```
public static String fileToUrl(File f,
               boolean bEscape128)
```
    Convert a File to a valid file URL or IRL
    note that some internal functions use network protocol and therefor performance may be non-optimal
    
    Parameters:
    f - the File to parse,
    bEscape128 - if true, escape non -ascii chars (URI), if false, don't (IRI)
    
    Returns:
    the URL string
  - urlToFileName
```
public static String urlToFileName(String urlString)
```
    Parameters:
    urlString - the string to parse for a file name
    
    Returns:
    the filename
  - urlToFile
```
public static File urlToFile(String urlString)
```
    Retrieve a file for a relative or absolute file url
    
    Parameters:
    urlString - the file url to retrieve a file for
    
    Returns:
    the file located at url
  - urlToUNC
```
public static String urlToUNC(String urlString)
```
    Retrieve a UNC path for a relative or absolute file url, any of '/'or "\\" is assumed a path separator
    
    Parameters:
    urlString - the file url to retrieve a UNC path for
    
    Returns:
    the UNC
  - uncToUrl
```
public static String uncToUrl(String unc,
              boolean escape128)
```
    Parameters:
    unc -
    escape128 - if true escape chars>128
    
    Returns:
  - urlToString
```
public static String urlToString(URL url)
```
    null safe url to string converter
    
    Parameters:
    url -
    
    Returns:
  - addParameter
```
public static String addParameter(String baseUrl,
                  String key,
                  String val)
```
    adds a parameter to a given url using either ? or &
    
    Parameters:
    baseUrl - the base url - already escaped and ready to go
    key - the key to add - NOT escaped
    val - the value to add - NOT escaped
    
    Returns:
    the escaped new url
  - addPath
```
public static String addPath(String baseUrl,
             String path)
```
    adds a path to a given url , keeping the parameters
    
    Parameters:
    baseUrl - the base url - already escaped and ready to go
    path - the path to add
    
    Returns:
    the escaped new url
  - escape
```
public static String escape(String toEscape,
            boolean bEscape128)
```
    standard url escaping
    
    Parameters:
    toEscape - the string to escape
    bEscape128 - if true, also escape >128, else leave non-ascii7 as is
    
    Returns:
    the escaped string
  - unEscape
```
public static String unEscape(String toEscape)
```
    standard url unescaping
    
    Parameters:
    toEscape - the string to unescape
    
    Returns:
    the escaped string
  - stringToURL
```
public static URL stringToURL(String urlString)
```
    Create a URL for any url string using heuristics and escaping
    
    Parameters:
    urlString - the file url to retrieve a file for
    
    Returns:
  - isFileOK
```
public static boolean isFileOK(File f)
```
    checks whether there is a remote chance that the file is useful for reading
    
    Parameters:
    f - - File to check
    
    Returns:
    true if the file is ok
  - isEscaped
```
public static boolean isEscaped(String url)
```
    test whether a given url is escaped as utf-8
    
    Parameters:
    url - the url to test
    
    Returns:
  - getExtensionFromMimeType
```
public static String getExtensionFromMimeType(String contentType)
```
    generates the correct extension for a given mime content type
    
    Parameters:
    contentType -
    
    Returns:
  - getMimeTypeFromURL
```
public static String getMimeTypeFromURL(String url)
```
    generates the correct MIMEType for a given URL and sets it
    
    Parameters:
    url -
    
    Returns:
  - isCID
```
public static boolean isCID(String url)
```
    test whether a given url is a cid (cid:)
    
    Parameters:
    url - the url to test
    
    Returns:
  - isNotCID
```
public static boolean isNotCID(String url)
```
    test whether a given url is NOT a cid this may be a local identifier
    
    Parameters:
    url - the url to test
    
    Returns:
    true if we are either a cid or a local url
  - isFile
```
public static boolean isFile(String url)
```
    is this a valid file url
    
    Parameters:
    url -
    
    Returns:
  - isWindowsLocalPath
```
public static boolean isWindowsLocalPath(String pathName)
```
    Parameters:
    pathName -
    
    Returns:
  - isHttp
```
public static boolean isHttp(String url)
```
    test whether a given url is an http url (excluding https - @see isHttps)
    
    Parameters:
    url - the url to test
    
    Returns:
  - isHttps
```
public static boolean isHttps(String url)
```
    test whether a given url is an https url
    
    Parameters:
    url - the url to test
    
    Returns:
  - normalize
```
public static String normalize(String urlString)
```
    normalize a url string by grinding it through url
    
    Parameters:
    urlString -
    
    Returns:
    the normalized string, null if not a valid url
  - isUNC
```
public static boolean isUNC(String pathName)
```
    test whether a given url is a unc path
    
    Parameters:
    pathName -
    
    Returns:
  - isMIME
```
public static boolean isMIME(File file)
```
    check whether a file is a mime file only check extensions TODO sniff file rather than check extensions
    
    Parameters:
    file - the FILE to check
    
    Returns:
    true if the file is a MIME file
  - getProtocol
```
public static UrlUtil.URLProtocol getProtocol(String url)
```
    returns the general protocol type of a url
    
    Parameters:
    url -
    
    Returns:
  - getIPFromBytes
```
public static String getIPFromBytes(byte[] ip)
```
    get the ip address as a string with the left byte at pos 0
    
    Parameters:
    ip -
    
    Returns:
  - getBytesFromIP
```
public static byte[] getBytesFromIP(String ip)
```
    get the ip address as a set of bytes with the left byte at pos 0
    
    Parameters:
    ip -
    
    Returns:
  - isMIMEExtenstension
```
public static boolean isMIMEExtenstension(String lower)
```
    check whether a file is a mime file
    
    Parameters:
    lower -
    
    Returns:
  - isIRL
```
public static boolean isIRL(String val)
```
    Parameters:
    val -
    
    Returns:
  - removeProtocol
```
public static String removeProtocol(String url)
```
    remove athe protocol part of a url, if it is specified
    
    Parameters:
    url - the url string to work on
    
    Returns:
    the input string without the protocol and ":"
  - isURL
```
public static boolean isURL(String val)
```
    Parameters:
    val -
    
    Returns:
  - getLocalURL
```
public static String getLocalURL(String directory,
                 String url)
```
    get the local url without directory schemes in the base url are case insensitive, all others are case sensitive
    
    Parameters:
    directory - the url of the directory
    url - the absolute url
    
    Returns:
    String - the local URL of url after removing directory
  - getURLWithDirectory
```
public static String getURLWithDirectory(String directory,
                         String url)
```
    concatenate directory and url to a single path IF and only IF url is a relative url
    relative urls MUST NOT have a scheme (e.g. file:)
    
    Parameters:
    directory - the url of the directory
    url - the relative url of the file
    
    Returns:
    String - the concatenated URL of the directory + file
  - getParentDirectory
```
public static String getParentDirectory(String url)
```
    get the parent directory of a file or url
    
    Parameters:
    url -
    
    Returns:
  - cleanDots
```
public static String cleanDots(String url)
```
    remove any internal "../" "./" and "//" from a url
    
    Parameters:
    url - the url to clean
    
    Returns:
    String - the clean path
  - cleanHttpURL
```
public static String cleanHttpURL(String url)
```
    create a "real" url from a user input url add http://
    
    Parameters:
    url - the input url
    
    Returns:
    the - hopefully - usable url
  - writeToURL
```
public static UrlPart writeToURL(String strUrl,
                 InputStream stream,
                 String method,
                 String contentType,
                 UrlUtil.HTTPDetails details)
```
    write a Stream to an output URL File: and http: are currently supported Use HttpURLConnection.getInputStream() to retrieve the http response
    
    Parameters:
    strUrl - the URL to write to
    stream - the input stream to read from
    method - HEAD, GET or POST
    contentType - the contenttype to set, if NULL defaults to TEXT/UNKNOWN
    details -
    
    Returns:
    UrlPart the opened http connection, null in case of error
  - moveToDir
```
@Deprecated
public static File moveToDir(IURLSetter parent,
                        File dir,
                        boolean overWrite)
```
    Deprecated. use moveToDir(parent, dir, null, overWrite);
    
    physically store the file at the location specified in dir and also modify this to reflect the new location
    
    Parameters:
    parent - the parent element, trypically a filespec or preview
    dir - the directory to move to. dir is created if it does not exist. If dir exists and dir is not a directory, the call fails and null is returned
    overWrite - if true, zapp any old files with the same name
    
    Returns:
    the file that corresponds to the moved url reference, null if an error occurred
  - moveToDir
```
public static File moveToDir(IURLSetter parent,
             File dir,
             String cwd,
             boolean overWrite)
```
    physically store the file at the location specified in dir and also modify this to reflect the new location
    
    Parameters:
    parent - the parent element, trypically a filespec or preview
    dir - the directory to move to. dir is created if it does not exist. If dir exists and dir is not a directory, the call fails and null is returned
    cwd - the current working dir for local urls
    overWrite - if true, zapp any old files with the same name
    
    Returns:
    the file that corresponds to the moved url reference, null if an error occurred
  - isRelativeURL
```
public static boolean isRelativeURL(String url)
```
    if true this url is relative
    
    Parameters:
    url - the url string to test
    
    Returns:
    true if relative
  - isXMLType
```
public static boolean isXMLType(String contentType)
```
    check whether the mime type is a known xml dialect
    
    Parameters:
    contentType -
    
    Returns:
  - isZIPType
```
public static boolean isZIPType(String contentType)
```
    check whether the mime type is a known zip dialect
    
    Parameters:
    contentType -
    
    Returns:
  - newExtension
```
public static String newExtension(String strWork,
                  String newExt)
```
    replace the .extension of a file name
    
    Parameters:
    strWork - the file path
    newExt - the new extension (works with or without the initial "."
    
    Returns:
    the strWork with a replaced extension
  - prefix
```
public static String prefix(String strWork)
```
    inverse of extension
    
    Parameters:
    strWork - the string to work on
    
    Returns:
    the prefix

Class UrlUtil

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POST

GET

HEAD

KEEPALIVE

CLOSE

CONTENT_TRANSFER_ENCODING

m_URIEscape

m_UNCEscape

TEXT_HTML

TEXT_PLAIN

TEXT_UNKNOWN

APPLICATION_XML

APPLICATION_ZIP

APPLICATION_XZIP

APPLICATION_PDF

APPLICATION_PS

TEXT_XML

TEXT_CSV

VND_JDF

VND_JMF

CONTENT_ID

CONTENT_TYPE

CONTENT_LENGTH

BASE64

BINARY

Constructor Detail

UrlUtil

Method Detail

getRelativeURL

createHttpUrl

getRelativePath

getFileName

getCidURLStream

extension

removeExtension

getURLParts

getURLInputStream

getURLInputStream

getCreateDirectory

fileToUrl

urlToFileName

urlToFile

urlToUNC

uncToUrl

urlToString

addParameter

addPath

escape

unEscape

stringToURL

isFileOK

isEscaped

getExtensionFromMimeType

getMimeTypeFromURL

isCID

isNotCID

isFile

isWindowsLocalPath

isHttp

isHttps

normalize

isUNC

isMIME

getProtocol

getIPFromBytes

getBytesFromIP

isMIMEExtenstension

isIRL

removeProtocol

isURL

getLocalURL

getURLWithDirectory

getParentDirectory