org.miniauth.common

Class BaseURIInfo

java.lang.Object

org.miniauth.common.BaseURIInfo

public final class BaseURIInfo
extends Object

Note: Although this is in the auth.core package (and it can be used in a general context), its implementation is specifically tailored for OAuth (OAuth 1.0a). This is really a wrapper of java.net.URI. OAuth puts many small/messy requirements, and URI is no exception. BaseURIInfo encapsulates this requirement.

Constructor Summary

Constructors

Constructor and Description
BaseURIInfo()
BaseURIInfo(String uriScheme, String userInfo, String host, int port, String path)
BaseURIInfo(URI uri)

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildBaseURIString(String uriScheme, String userInfo, String host, int port, String path)
URI	buildURI() Builds the URI according to the OAuth the requirements.
URI	buildURI(Map<String,String[]> queryParams) Builds the URI according to the OAuth the requirements after adding the queryParams.
URI	buildURI(String query) Builds the URI according to the OAuth the requirements after adding the query string to the base URI.
URI	buildURI(String query, String fragment) Builds the URI according to the OAuth the requirements.
String	buildURIString() Builds a URL string.
String	buildURIString(Map<String,String[]> queryParams) Builds a URL string after appending the given query parameter.
String	buildURIString(Map<String,String[]> queryParams, String fragment) Builds a URL string after appending the given query parameter.
String	buildURIString(String query) Builds a URL string after appending the given query string.
String	buildURIString(String query, String fragment) Builds a URL string after adding the given query and fragment string.
URL	buildURL() Builds the URL according to the OAuth the requirements.
URL	buildURL(Map<String,String[]> queryParams) Builds the URL according to the OAuth the requirements after adding the queryParams.
URL	buildURL(Map<String,String[]> queryParams, String fragment) Builds the URL according to the OAuth the requirements after adding the queryParams.
URL	buildURL(String query) Builds the URL according to the OAuth the requirements after adding the query string to the base URI.
URL	buildURL(String query, String fragment) Builds the URL according to the OAuth the requirements.
static BaseURIInfo	create(URL url)
static URI	createBaseURI(URL url)
static URL	createURL(URI baseURI, Map<String,String[]> queryParams) Create URL from baseURI and queryParams.
static URL	createURL(URI baseURI, Map<String,String[]> queryParams, String fragment) Create URL from baseURI and queryParams.
static URL	createURL(URI baseURI, String query) Create URL from baseURI and query.
static URL	createURL(URI baseURI, String query, String fragment) Create URL from baseURI and query.
String	getHost()
String	getPath()
int	getPort()
String	getUriScheme()
String	getUserInfo()
void	setHost(String host)
void	setPath(String path)
void	setPort(int port)
void	setUriScheme(String uriScheme)
void	setUserInfo(String userInfo)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseURIInfo

public BaseURIInfo()

BaseURIInfo

public BaseURIInfo(URI uri)

BaseURIInfo

public BaseURIInfo(String uriScheme,
           String userInfo,
           String host,
           int port,
           String path)

Method Detail

create

public static BaseURIInfo create(URL url)
                          throws MiniAuthException

Throws:

MiniAuthException

createBaseURI

public static URI createBaseURI(URL url)
                         throws MiniAuthException

Throws:

MiniAuthException

getUriScheme

public String getUriScheme()

setUriScheme

public void setUriScheme(String uriScheme)

getUserInfo

public String getUserInfo()

setUserInfo

public void setUserInfo(String userInfo)

getHost

public String getHost()

setHost

public void setHost(String host)

getPort

public int getPort()

setPort

public void setPort(int port)

getPath

public String getPath()

setPath

public void setPath(String path)

buildBaseURIString

public static String buildBaseURIString(String uriScheme,
                        String userInfo,
                        String host,
                        int port,
                        String path)
                                 throws MiniAuthException

Throws:

MiniAuthException

buildURI

public URI buildURI()
             throws MiniAuthException

Builds the URI according to the OAuth the requirements.

Returns:

The URI equivalent to this BaseUriInfo object.

Throws:

MiniAuthException

buildURI

public URI buildURI(String query)
             throws MiniAuthException

Builds the URI according to the OAuth the requirements after adding the query string to the base URI.

Parameters:

query - Query string.

Returns:

The URI equivalent to this BaseUriInfo object.

Throws:

MiniAuthException

buildURI

public URI buildURI(Map<String,String[]> queryParams)
             throws MiniAuthException

Builds the URI according to the OAuth the requirements after adding the queryParams.

Parameters:

queryParams - Query params.

Returns:

The URI equivalent to this BaseUriInfo object.

Throws:

MiniAuthException

buildURI

public URI buildURI(String query,
           String fragment)
             throws MiniAuthException

Builds the URI according to the OAuth the requirements.

Parameters:

query - Query string.

fragment - URL fragment.

Returns:

The URI equivalent to this BaseUriInfo object.

Throws:

MiniAuthException

buildURIString

public String buildURIString()
                      throws MiniAuthException

Builds a URL string.

Returns:

The URL string representation of this object.

Throws:

MiniAuthException

buildURIString

public String buildURIString(String query)
                      throws MiniAuthException

Builds a URL string after appending the given query string.

Parameters:

query - QueryString.

Returns:

The URL string representation of this object.

Throws:

MiniAuthException

buildURIString

public String buildURIString(Map<String,String[]> queryParams)
                      throws MiniAuthException

Builds a URL string after appending the given query parameter.

Parameters:

queryParams - Map of query params.

Returns:

The URL string representation of this object.

Throws:

MiniAuthException

buildURIString

public String buildURIString(Map<String,String[]> queryParams,
                    String fragment)
                      throws MiniAuthException

Builds a URL string after appending the given query parameter.

Parameters:

queryParams - Map of query params.

fragment - Fragment.

Returns:

The URL string representation of this object.

Throws:

MiniAuthException

buildURIString

public String buildURIString(String query,
                    String fragment)
                      throws MiniAuthException

Builds a URL string after adding the given query and fragment string.

Parameters:

query - QueryString.

fragment - Fragment.

Returns:

The URL string representation of this object.

Throws:

MiniAuthException

buildURL

public URL buildURL()
             throws MiniAuthException

Builds the URL according to the OAuth the requirements.

Returns:

The URL equivalent to this BaseUriInfo object.

Throws:

MiniAuthException

buildURL

public URL buildURL(String query)
             throws MiniAuthException

Builds the URL according to the OAuth the requirements after adding the query string to the base URI.

Parameters:

query - Query string.

Returns:

The URL equivalent to this BaseUriInfo object.

Throws:

MiniAuthException

buildURL

public URL buildURL(Map<String,String[]> queryParams)
             throws MiniAuthException

Builds the URL according to the OAuth the requirements after adding the queryParams.

Parameters:

queryParams - Query params.

Returns:

The URL equivalent to this BaseUriInfo object.

Throws:

MiniAuthException

buildURL

public URL buildURL(Map<String,String[]> queryParams,
           String fragment)
             throws MiniAuthException

Builds the URL according to the OAuth the requirements after adding the queryParams.

Parameters:

queryParams - Query params.

fragment - URL fragment.

Returns:

The URL equivalent to this BaseUriInfo object.

Throws:

MiniAuthException

buildURL

public URL buildURL(String query,
           String fragment)
             throws MiniAuthException

Builds the URL according to the OAuth the requirements.

Parameters:

query - Query string.

fragment - URL fragment.

Returns:

The URL equivalent to this BaseUriInfo object.

Throws:

MiniAuthException

createURL

public static URL createURL(URI baseURI,
            Map<String,String[]> queryParams)
                     throws MiniAuthException

Create URL from baseURI and queryParams.

Parameters:

baseURI -

queryParams -

Returns:

URL with query params.

Throws:

MiniAuthException

createURL

public static URL createURL(URI baseURI,
            Map<String,String[]> queryParams,
            String fragment)
                     throws MiniAuthException

Create URL from baseURI and queryParams.

Parameters:

baseURI -

queryParams -

fragment - URL fragment.

Returns:

URL with query params.

Throws:

MiniAuthException

createURL

public static URL createURL(URI baseURI,
            String query)
                     throws MiniAuthException

Create URL from baseURI and query.

Parameters:

baseURI -

query -

Returns:

URL with query string.

Throws:

MiniAuthException

createURL

public static URL createURL(URI baseURI,
            String query,
            String fragment)
                     throws MiniAuthException

Create URL from baseURI and query.

Parameters:

baseURI -

query -

fragment - URL fragment.

Returns:

URL with query string.

Throws:

MiniAuthException

toString

public String toString()

Overrides:

toString in class Object