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 application servlet paths.

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhotonPathMapper.PathEntry

Method Summary

Modifier and Type	Method and Description
static boolean	containsAnyMapping()
static String	getAjaxServletPathOfApplicationID(String sApplicationID) Get the ajax servlet path mapped to the specified application ID
static String	getAjaxServletPathOfApplicationIDOrDefault(String sApplicationID) Get the ajax servlet 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	getAjaxServletPathOfDefaultApplicationID() Get the ajax servlet path mapped to the default application ID
static String	getAPIServletPathOfApplicationID(String sApplicationID) Get the API servlet path mapped to the specified application ID
static String	getAPIServletPathOfApplicationIDOrDefault(String sApplicationID) Get the API servlet 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	getAPIServletPathOfDefaultApplicationID() Get the API servlet path mapped to the default application ID
static com.helger.commons.collection.ext.ICommonsMap<String,String>	getApplicationIDToAjaxServletPathMap()
static com.helger.commons.collection.ext.ICommonsMap<String,String>	getApplicationIDToAPIServletPathMap()
static com.helger.commons.collection.ext.ICommonsMap<String,String>	getApplicationIDToApplicationServletPathMap()
static com.helger.commons.collection.ext.ICommonsMap<String,PhotonPathMapper.PathEntry>	getApplicationIDToPathEntryMap()
static String	getApplicationServletPathOfApplicationID(String sApplicationID) Get the application servlet path mapped to the specified application ID
static String	getApplicationServletPathOfApplicationIDOrDefault(String sApplicationID) Get the application servlet 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	getApplicationServletPathOfDefaultApplicationID() Get the application servlet path mapped to the default application ID
static String	getDefaultApplicationID()
static com.helger.commons.state.EChange	removeAllPathMappings() Remove all contained path mappings (clearing).
static com.helger.commons.state.EChange	removePathMapping(String sApplicationID) Remove the all paths mapped to the specified application ID.
static void	setAjaxServletPathMapping(String sApplicationID, String sAjaxServletPath) Set an ajax servlet path mapping.
static void	setAPIServletPathMapping(String sApplicationID, String sAPIServletPath) Set an API servlet path mapping.
static void	setApplicationServletPathMapping(String sApplicationID, String sApplicationServletPath) Set an application servlet path mapping.
static void	setDefaultApplicationID(String sApplicationID) Set the default application ID.

Methods inherited from class java.lang.Object

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

Method Detail

setApplicationServletPathMapping

public static void setApplicationServletPathMapping(@Nonnull @Nonempty
                                                    String sApplicationID,
                                                    @Nonnull @Nonempty
                                                    String sApplicationServletPath)

Set an application servlet path mapping. This overwrites existing mappings.

Parameters:

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

sApplicationServletPath - 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

setAjaxServletPathMapping

public static void setAjaxServletPathMapping(@Nonnull @Nonempty
                                             String sApplicationID,
                                             @Nonnull @Nonempty
                                             String sAjaxServletPath)

Set an ajax servlet path mapping. This overwrites existing mappings.

Parameters:

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

sAjaxServletPath - 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. /publicajax

setAPIServletPathMapping

public static void setAPIServletPathMapping(@Nonnull @Nonempty
                                            String sApplicationID,
                                            @Nonnull @Nonempty
                                            String sAPIServletPath)

Set an API servlet path mapping. This overwrites existing mappings.

Parameters:

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

sAPIServletPath - 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. /publicapi

Since:

7.0.2

removePathMapping

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

Remove the all paths 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.

getApplicationServletPathOfApplicationID

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

Get the application servlet 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.

getAjaxServletPathOfApplicationID

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

Get the ajax servlet 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.

getAPIServletPathOfApplicationID

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

Get the API servlet 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.

Since:

7.0.2

containsAnyMapping

public static boolean containsAnyMapping()

Returns:

true if mappings are already defined, false otherwise.

getApplicationIDToPathEntryMap

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.ext.ICommonsMap<String,PhotonPathMapper.PathEntry> getApplicationIDToPathEntryMap()

Returns:

A copy of all contained application servlet mapping entries. Never null.

getApplicationIDToApplicationServletPathMap

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.ext.ICommonsMap<String,String> getApplicationIDToApplicationServletPathMap()

Returns:

A copy of all contained application servlet mapping entries. Never null.

getApplicationIDToAjaxServletPathMap

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.ext.ICommonsMap<String,String> getApplicationIDToAjaxServletPathMap()

Returns:

A copy of all contained ajax servlet mapping entries. Never null.

getApplicationIDToAPIServletPathMap

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.ext.ICommonsMap<String,String> getApplicationIDToAPIServletPathMap()

Returns:

A copy of all contained API servlet mapping entries. Never null.

Since:

7.0.2

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:

setApplicationServletPathMapping(String, String), getDefaultApplicationID()

getDefaultApplicationID

@Nullable
public static String getDefaultApplicationID()

Returns:

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

See Also:

setDefaultApplicationID(String)

getApplicationServletPathOfDefaultApplicationID

@Nullable
public static String getApplicationServletPathOfDefaultApplicationID()

Get the application servlet 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()

getAjaxServletPathOfDefaultApplicationID

@Nullable
public static String getAjaxServletPathOfDefaultApplicationID()

Get the ajax servlet 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()

getAPIServletPathOfDefaultApplicationID

@Nullable
public static String getAPIServletPathOfDefaultApplicationID()

Get the API servlet 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.

Since:

7.0.2

See Also:

getDefaultApplicationID()

getApplicationServletPathOfApplicationIDOrDefault

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

Get the application servlet 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:

getApplicationServletPathOfApplicationID(String), getApplicationServletPathOfDefaultApplicationID()

getAjaxServletPathOfApplicationIDOrDefault

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

Get the ajax servlet 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:

getAjaxServletPathOfApplicationID(String), getAjaxServletPathOfDefaultApplicationID()

getAPIServletPathOfApplicationIDOrDefault

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

Get the API servlet 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.

Since:

7.0.2

See Also:

getAPIServletPathOfApplicationID(String), getAPIServletPathOfDefaultApplicationID()