org.dataone.service.util

Class D1Url

java.lang.Object

org.dataone.service.util.D1Url

public class D1Url
extends Object

Constructor Summary

Constructors

Constructor and Description
D1Url()
D1Url(String baseUrl)
D1Url(String baseUrl, String resource)

Method Summary

Modifier and Type	Method and Description
void	addDateParamPair(String key, Date dateLocalTime) convenience method for adding date object to query parameters.
void	addNextPathElement(String pathElement) adds the next path element to the path portion of the URL, encoding unsafe characters.
void	addNonEmptyParam(String param) adds a single parameter to the query portion of the URL (not a key-value pair) encoding unsafe characters.
void	addNonEmptyParamPair(String key, Integer integer) adds a key value pair to the query portion of the URL, placing '=' character between them, and encoding unsafe characters.
void	addNonEmptyParamPair(String key, String value) adds a key value pair to the query portion of the URL, placing '=' character between them, and encoding unsafe characters.
void	addPreEncodedNonEmptyQueryParams(String param) Method for adding query params that bypasses encoding.
protected void	assembleUrl()
String	getAssembledQueryString()
String	getBaseUrl()
String	getResource()
String	getUrl()
protected String	joinToUrlWith(String joiner, String string) use this method to avoid inadvertent duplication of the joining character The most common case is when a baseUrl contains a trailing slash and you want to append another path elements.
void	setBaseUrl(String baseUrl)
void	setResource(String res)
String	toString()
protected static String	trimAndValidateString(String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

D1Url

public D1Url(String baseUrl,
             String resource)
      throws IllegalArgumentException

Throws:

IllegalArgumentException

D1Url

public D1Url(String baseUrl)
      throws IllegalArgumentException

Throws:

IllegalArgumentException

D1Url

public D1Url()

Method Detail

setBaseUrl

public void setBaseUrl(String baseUrl)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

getBaseUrl

public String getBaseUrl()

setResource

public void setResource(String res)

getResource

public String getResource()

addNextPathElement

public void addNextPathElement(String pathElement)
                        throws IllegalArgumentException

adds the next path element to the path portion of the URL, encoding unsafe characters. Empty values to the pathElement parameter throws an exception

Parameters:

pathElement -

Throws:

IllegalArgumentException - - if pathElement is null or empty

addNonEmptyParam

public void addNonEmptyParam(String param)

adds a single parameter to the query portion of the URL (not a key-value pair) encoding unsafe characters. If param is empty or null, nothing is added.

Parameters:

param -

addNonEmptyParamPair

public void addNonEmptyParamPair(String key,
                                 String value)

adds a key value pair to the query portion of the URL, placing '=' character between them, and encoding unsafe characters. If either key or value is empty or null, quietly does not add anything to the url.

Parameters:

key -

value -

addDateParamPair

public void addDateParamPair(String key,
                             Date dateLocalTime)

convenience method for adding date object to query parameters. The date is converted to GMT and serialized as a string. If date is null, nothing is added to the URL.

Parameters:

key -

date -

Throws:

IllegalArgumentException

addNonEmptyParamPair

public void addNonEmptyParamPair(String key,
                                 Integer integer)

adds a key value pair to the query portion of the URL, placing '=' character between them, and encoding unsafe characters. If either key or value is empty or null, quietly does not add anything to the url.

Parameters:

key -

integer -

addPreEncodedNonEmptyQueryParams

public void addPreEncodedNonEmptyQueryParams(String param)

Method for adding query params that bypasses encoding. Use sparingly, as it is a bit unsafe, but useful if the choice of params is too much to put in a method signature.

Parameters:

param -

getUrl

public String getUrl()

toString

public String toString()

Overrides:

toString in class Object

assembleUrl

protected void assembleUrl()

getAssembledQueryString

public String getAssembledQueryString()

trimAndValidateString

protected static String trimAndValidateString(String s)
                                       throws IllegalArgumentException

Throws:

IllegalArgumentException

joinToUrlWith

protected String joinToUrlWith(String joiner,
                               String string)

use this method to avoid inadvertent duplication of the joining character The most common case is when a baseUrl contains a trailing slash and you want to append another path elements.

Parameters:

joiner -

string -

Returns: