com.neurosys.utils

Class UrlUtils

java.lang.Object

com.neurosys.utils.UrlUtils

public class UrlUtils
extends Object

URL based Utils for URL manipulation & extraction

Author:

Arjun Dhar

Constructor Summary

Constructors

Constructor and Description
UrlUtils()

Method Summary

Modifier and Type	Method and Description
static String	appendParamToUrl(String url, String paramStr) Convenience method to append a paramString.
static String	createPageLink(List<String> paramInclude, List<String> paramIgnore, String baseUrl, Map<String,String[]> paramMap, String suffix) Re-Create a link with specific params only; cleans by recreating link with required params only
static String	deriveAlternatePath(String originalPathURL, boolean addPortIfNotExist, Integer portNum, String protocol) Used to derive an alternate URL path.
static String	filterPathName(String filePath, boolean includeExtension, boolean fullPath) File Name filtering Utility
static String	getCDNLocationForResource(String relLocation)
static Class	getClassForName(String name, Class defaultClass) Filters out the class representing the Page.
static String	getExtension(String filePath) Returns the extension (including .) at the end of the path else return a blank String
static org.apache.wicket.PageParameters	getPageParameters(String name) Filters out any additional page parameters (extracts all URL query values after ?)
static List<String>	getPathParams(String url, Consumer<String> paramEvent) Read path params separated by '/', upto '?' OR end of path.
static String	getQueryString(String name) Gets the Query String (after ?).
static String	removeQueryString(String str) Removes the String after ?..

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlUtils

public UrlUtils()

Method Detail

getExtension

public static String getExtension(String filePath)

Returns the extension (including .) at the end of the path else return a blank String

Parameters:

filePath -

Returns:

String @nullable false

removeQueryString

public static String removeQueryString(String str)

Removes the String after ?.. in a URL Query String, including the "?"

Returns:

filterPathName

public static String filterPathName(String filePath,
                                    boolean includeExtension,
                                    boolean fullPath)

File Name filtering Utility

Parameters:

filePath - as the file path to be filtered

includeExtension - to include the file extension or not

fullPath - : if false will filter from last folder delimiter ('/')

Returns:

String as filtered path TODO: Add Unit Test

appendParamToUrl

public static String appendParamToUrl(String url,
                                      String paramStr)

Convenience method to append a paramString. No writing if code for '?' or '&'

Parameters:

url -

paramStr -

Returns:

getQueryString

public static String getQueryString(String name)

Gets the Query String (after ?). If no Query string exists then blank string is returned. Assumes QueryStringUrlCodingStrategy has been used to load page.

Parameters:

name -

Returns:

PageParameters @nullable true

getPageParameters

public static org.apache.wicket.PageParameters getPageParameters(String name)

Filters out any additional page parameters
(extracts all URL query values after ?)

Parameters:

name -

Returns:

PageParameters @nullable true

getPathParams

public static List<String> getPathParams(String url,
                                         Consumer<String> paramEvent)

Read path params separated by '/', upto '?' OR end of path.

Parameters:

url - as String (usually relative URL)

paramEvent - as a Consumer of each path param

Returns:

getClassForName

public static Class getClassForName(String name,
                                    Class defaultClass)

Filters out the class representing the Page.

Parameters:

name -

defaultClass -

Returns:

deriveAlternatePath

public static String deriveAlternatePath(String originalPathURL,
                                         boolean addPortIfNotExist,
                                         Integer portNum,
                                         String protocol)
                                  throws Exception

Used to derive an alternate URL path. Example: Switch from SSL to Non-SSL and via versa

Parameters:

originalPathURL - as String

addPortIfNotExist - as boolean
add = true; means if :xxxx port is NOT supplied for Non-SSL then it will ADD :port# with the site.server.ssl.port.
If false, then, it will use the port number to only replace existing port. If no port in Non-SSL then it will ignore.)

portNum - as Integer (the port to be added/replacer in the new path)
@nullable true. If null then it assumes original port number (if it exists). -1 will remove any port.

protocol - as String (protocol of the derived path, will replace original path protocol)
@nullable true. If null then it uses original path protocol

Returns:

String

Throws:

Exception

getCDNLocationForResource

public static String getCDNLocationForResource(String relLocation)

createPageLink

public static String createPageLink(List<String> paramInclude,
                                    List<String> paramIgnore,
                                    String baseUrl,
                                    Map<String,String[]> paramMap,
                                    String suffix)

Re-Create a link with specific params only; cleans by recreating link with required params only

Parameters:

paramInclude - as List of String params from request

paramIgnore - as List of String params from request (will override if in conflict with included params)

prefix - as the Opening tag details to this link

baseUrl - as String

paramMap - as Map of String to String[] values

suffix - as suffix ending tag details to this link

Returns:

String as link