com.helger.photon.basic.app

Class PhotonPathMapper

java.lang.Object

com.helger.photon.basic.app.PhotonPathMapper

@ThreadSafe
public final class PhotonPathMapper
extends Object

Global mapper between application ID and the respective servlet paths.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static boolean	containsMappings()
static Map<String,String>	getApplicationIDToPathMap()
static String	getDefaultApplicationID()
static String	getPathOfApplicationID(String sApplicationID) Get the path mapped to the specified application ID
static String	getPathOfApplicationIDOrDefault(String sApplicationID) Get the path mapped to the specified application ID or (if no such application ID is present) return the path of the default application ID
static String	getPathOfDefaultApplicationID() Get the path mapped to the default application ID
static com.helger.commons.state.EChange	removeAllPathMappings() Remove all contained path mappings (clearing).
static com.helger.commons.state.EChange	removePathMapping(String sApplicationID) Remove the path mapped to the specified application ID.
static void	setDefaultApplicationID(String sApplicationID) Set the default application ID.
static void	setPathMapping(String sApplicationID, String sPath) Set a path mapping.

Methods inherited from class java.lang.Object

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

Method Detail

setPathMapping

public static void setPathMapping(@Nonnull @Nonempty
                                  String sApplicationID,
                                  @Nonnull @Nonempty
                                  String sPath)

Set a path mapping.

Parameters:

sApplicationID - Application ID to use. May neither be null nor empty.

sPath - The path to use. May neither be null nor empty. Must start with a "slash" but may not end with a slash. Valid example is e.g. /public

removePathMapping

@Nonnull
public static com.helger.commons.state.EChange removePathMapping(@Nullable
                                                                           String sApplicationID)

Remove the path mapped to the specified application ID. If the specified application ID is the default one, the default application ID is set to null.

Parameters:

sApplicationID - Application ID to be removed. May be null.

Returns:

EChange.CHANGED if the path was successfully removed

removeAllPathMappings

@Nonnull
public static com.helger.commons.state.EChange removeAllPathMappings()

Remove all contained path mappings (clearing).

Returns:

EChange.CHANGED if at least one path was removed, EChange.UNCHANGED otherwise.

getPathOfApplicationID

@Nullable
public static String getPathOfApplicationID(@Nullable
                                                       String sApplicationID)

Get the path mapped to the specified application ID

Parameters:

sApplicationID - Application ID to check. May be null.

Returns:

null if no mapping was found. A path starting with a slash but not ending with a slash otherwise.

getApplicationIDToPathMap

@Nonnull
 @ReturnsMutableCopy
public static Map<String,String> getApplicationIDToPathMap()

Returns:

A copy of all contained mapping entries. Never null.

containsMappings

public static boolean containsMappings()

Returns:

true if mappings are already defined, false otherwise.

setDefaultApplicationID

public static void setDefaultApplicationID(@Nonnull @Nonempty
                                           String sApplicationID)

Set the default application ID. This must be called AFTER the path mapping was registered.

Parameters:

sApplicationID - The application ID to set as the default. May neither be null nor empty.

See Also:

setPathMapping(String, String), getDefaultApplicationID()

getDefaultApplicationID

@Nullable
public static String getDefaultApplicationID()

Returns:

The default application ID. May be null if not set.

See Also:

setDefaultApplicationID(String)

getPathOfDefaultApplicationID

@Nullable
public static String getPathOfDefaultApplicationID()

Get the path mapped to the default application ID

Returns:

null if no default application ID is set. A path starting with a slash but not ending with a slash otherwise.

See Also:

getDefaultApplicationID()

getPathOfApplicationIDOrDefault

@Nullable
public static String getPathOfApplicationIDOrDefault(@Nullable
                                                                String sApplicationID)

Get the path mapped to the specified application ID or (if no such application ID is present) return the path of the default application ID

Parameters:

sApplicationID - Application ID to check. May be null.

Returns:

null if no mapping was found and no default path is specified. A path starting with a slash but not ending with a slash otherwise.

See Also:

getPathOfApplicationID(String), getPathOfDefaultApplicationID()