UrlSupport (Opencast :: common 8.9 API)

java.lang.Object
- org.opencastproject.util.UrlSupport

public final class UrlSupport
extends Object

UrlSupport is a helper class to deal with urls.

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_BASE_URL

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_BASE_URL`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`concat(List<String> parts)` Concatenates the urls with respect to leading and trailing slashes.
`static String`	`concat(String... parts)` Concatenates the urls with respect to leading and trailing slashes.
`static String`	`concat(String prefix, String suffix)` Concatenates the two urls with respect to leading and trailing slashes.
`static String`	`concat(String prefix, String suffix, boolean close)` Concatenates the two urls with respect to leading and trailing slashes.
`static String`	`getExtension(String url)` Returns the extension that is encoded into the url.
`static String`	`getExtension(String prefix, String url)` Returns the url extension that `url` defines over `prefix`.
`static Character`	`getInvalidCharacter(String url)` Returns `null` if the url is valid, that is, if it contains only allowed characters.
`static boolean`	`isExtendedPrefix(String a, String b)` Returns `true` if url `a` is a prefix of url `b`.
`static boolean`	`isPrefix(String a, String b)` Returns `true` if url `a` is a direct prefix of url `b`.
`static boolean`	`isValid(String url)` Returns `true` if the url is valid, that is, if it contains only allowed characters.
`static String`	`removeDoubleSeparator(String path)` Removes any occurrence of double separators ("//") and replaces it with "/".
`static String[]`	`sort(String[] urls)` Sorts the given urls by path.
`static String`	`stripExtension(String url)` Strips off the extension and returns the pure url.
`static String`	`trim(String url)` Returns the trimmed url.
`static URI`	`uri(Object... parts)` Create a URI from the given parts.
`static URI`	`uri(String uri)` URI constructor function without checked exceptions.
`static URL`	`url(String url)` URL constructor function without checked exceptions.
`static URL`	`url(String protocol, String host, int port)` URL constructor function without checked exceptions.
`static URL`	`url(URL context, String spec)` URL constructor function without checked exceptions.

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

- Field Detail
  - DEFAULT_BASE_URL
```
public static final String DEFAULT_BASE_URL
```
    See Also:
    
    Constant Field Values
- Method Detail
  - uri
```
public static URI uri(String uri)
```
    URI constructor function without checked exceptions.
  - url
```
public static URL url(String url)
```
    URL constructor function without checked exceptions.
  - url
```
public static URL url(String protocol,
                      String host,
                      int port)
```
    URL constructor function without checked exceptions.
  - url
```
public static URL url(URL context,
                      String spec)
```
    URL constructor function without checked exceptions.
    
    See Also:
    
    URL
  - sort
```
public static String[] sort(String[] urls)
```
    Sorts the given urls by path.
    
    Parameters:
    
    urls - the urls to sort
    
    Returns:
    
    the sorted urls
  - concat
```
public static String concat(String prefix,
                            String suffix)
```
    Concatenates the two urls with respect to leading and trailing slashes.
    Note that returned path will only end with a slash if suffix does. If you need a trailing slash, see concat(String, String, boolean).
    
    Returns:
    
    the concatenated url of the two arguments
  - concat
```
public static String concat(String prefix,
                            String suffix,
                            boolean close)
```
    Concatenates the two urls with respect to leading and trailing slashes. The path will always end with a trailing slash.
    
    Returns:
    
    the concatenated url of the two arguments
  - concat
```
public static String concat(String... parts)
```
    Concatenates the urls with respect to leading and trailing slashes.
    
    Parameters:
    
    parts - the parts to concat
    
    Returns:
    
    the concatenated url
  - concat
```
public static String concat(List<String> parts)
```
    Concatenates the urls with respect to leading and trailing slashes.
    
    Parameters:
    
    parts - the parts to concat
    
    Returns:
    
    the concatenated url
  - uri
```
public static URI uri(Object... parts)
```
    Create a URI from the given parts.
  - trim
```
public static String trim(String url)
```
    Returns the trimmed url. Trimmed means that the url is free from leading or trailing whitespace characters, and that a directory url like /news/ is closed by a slash (/).
    
    Parameters:
    
    url - the url to trim
    
    Returns:
    
    the trimmed url
  - removeDoubleSeparator
```
public static String removeDoubleSeparator(String path)
```
    Removes any occurrence of double separators ("//") and replaces it with "/". Any double separators right after the protocol part are left untouched so that, e.g. http://localhost stays http://localhost
    
    Parameters:
    
    path - the path to check
    
    Returns:
    
    the corrected path
  - isPrefix
```
public static boolean isPrefix(String a,
                               String b)
```
    Returns true if url a is a direct prefix of url b. For example, /news is the parent of /news/today.
    Note that a is also an extended prefix of b if a and b are equal.
    
    Parameters:
    
    a - the first url
    
    b - the second url
    
    Returns:
    
    true if a is the direct prefix of b
  - isExtendedPrefix
```
public static boolean isExtendedPrefix(String a,
                                       String b)
```
    Returns true if url a is a prefix of url b. For example, /news is an ancestor of /news/today/morning.
    Note that a is also an extended prefix of b if a and b are equal.
    
    Parameters:
    
    a - the first url
    
    b - the second url
    
    Returns:
    
    true if a is a prefix of b
  - getExtension
```
public static String getExtension(String prefix,
                                  String url)
```
    Returns the url extension that url defines over prefix. For example, the extension of url /news/today and prefix /news is today.
    If prefix is not a prefix of url, this method returns null, if url and prefix match, the empty string is returned.
    
    Parameters:
    
    prefix - the url prefix
    
    url - the url
    
    Returns:
    
    the url extension over the prefix
  - getExtension
```
public static String getExtension(String url)
```
    Returns the extension that is encoded into the url. Possible extensions are:
    - /*
    - /**
    - null
    Parameters:
    
    url - the url with extension
    
    Returns:
    
    the url extension or null if no extension can be found
  - stripExtension
```
public static String stripExtension(String url)
```
    Strips off the extension and returns the pure url.
    
    Parameters:
    
    url - the url with extension
    
    Returns:
    
    the url
  - isValid
```
public static boolean isValid(String url)
```
    Returns true if the url is valid, that is, if it contains only allowed characters.
    
    Returns:
    
    true or the invalid character
  - getInvalidCharacter
```
public static Character getInvalidCharacter(String url)
```
    Returns null if the url is valid, that is, if it contains only allowed characters. Otherwhise, the invalid character is returned.
    
    Returns:
    
    null or the invalid character

Class UrlSupport

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BASE_URL

Method Detail

uri

url

url

url

sort

concat

concat

concat

concat

uri

trim

removeDoubleSeparator

isPrefix

isExtendedPrefix

getExtension

getExtension

stripExtension

isValid

getInvalidCharacter