com.phloc.commons.url

Class URLProtocolRegistry

java.lang.Object

com.phloc.commons.url.URLProtocolRegistry

@Immutable
public final class URLProtocolRegistry
extends Object

A central registry for supported URL protocols. By default, the registry will include all protocols contained in EURLProtocol, but it may be extended by custom protocols

Author:

Boris Gregorcic, Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static Collection<IURLProtocol>	getAllProtocols()
static IURLProtocol	getProtocol(IURLData aURL) Try to evaluate the matching URL protocol from the passed URL
static IURLProtocol	getProtocol(String sURL) Try to evaluate the matching URL protocol from the passed URL
static String	getWithoutProtocol(String sURL) Return the passed URL where the protocol has been stripped (if known)
static boolean	hasKnownProtocol(IURLData aURL) Check if the passed URL has any known protocol
static boolean	hasKnownProtocol(String sURL) Check if the passed URL has any known protocol
static void	registerProtocol(IURLProtocol aProtocol) Registers a new protocol
static void	reinitialize() Reinitialize all protocols.

Methods inherited from class java.lang.Object

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

Method Detail

reinitialize

public static void reinitialize()

Reinitialize all protocols. Adds all EURLProtocol values and invokes all SPI implementations.

registerProtocol

public static void registerProtocol(@Nonnull
                    IURLProtocol aProtocol)

Registers a new protocol

Parameters:

aProtocol - The protocol to be registered. May not be null.

Throws:

IllegalArgumentException - If another handler for this protocol is already installed.

getAllProtocols

@Nonnull
@ReturnsMutableCopy
public static Collection<IURLProtocol> getAllProtocols()

Returns:

All registered protocols

getProtocol

@Nullable
public static IURLProtocol getProtocol(@Nullable
                                String sURL)

Try to evaluate the matching URL protocol from the passed URL

Parameters:

sURL - The URL to get the protocol from

Returns:

The corresponding URL protocol or null if unresolved

getProtocol

@Nullable
public static IURLProtocol getProtocol(@Nullable
                                IURLData aURL)

Try to evaluate the matching URL protocol from the passed URL

Parameters:

aURL - The URL data

Returns:

The corresponding URL protocol or null if unresolved

hasKnownProtocol

public static boolean hasKnownProtocol(@Nullable
                       String sURL)

Check if the passed URL has any known protocol

Parameters:

sURL - The URL to analyze

Returns:

true if the protocol is known, false otherwise

hasKnownProtocol

public static boolean hasKnownProtocol(@Nullable
                       IURLData aURL)

Check if the passed URL has any known protocol

Parameters:

aURL - The URL to analyze

Returns:

true if the protocol is known, false otherwise

getWithoutProtocol

@Nullable
public static String getWithoutProtocol(@Nullable
                                 String sURL)

Return the passed URL where the protocol has been stripped (if known)

Parameters:

sURL - The URL to strip the protocol from. May be null.

Returns:

The passed URL where any known protocol has been stripped