com.sapportals.portal.prt.util

Class AbstractURI

java.lang.Object
  com.sapportals.portal.prt.util.AbstractURI

public class AbstractURI
extends Object

AbstractURL is a convenience class for manipulation of URLs based on the W3C RFC 2396 (see the World Wide Web Consortium pages). In general a URI consists of the parts

• scheme, e.g. http, https, ftp,...etc
• user info
• host
• port
• path
• query
• fragment

concatenated as <scheme>://<user info>@<host>:<port><path>?<query>#<fragment> Many combinations are admissable. Examples

1. <scheme>:/<path>#<fragment>
2. <scheme>://<user info>@<host>/<path>
3. <scheme>://<user info>@<host>:<port>?<query>

Constructor Summary

AbstractURI()
Constructor.

AbstractURI(String uri)
Constructor with initial URL.

Method Summary

void	addParameter(String name, String value) Adds a parameter with value to the query part.
String	getFragment() Gets the scheme of the current URI.
String	getHost() Gets the Host of the current URI.
String[]	getParameters() Gets all parameters of the query part.
Enumeration	getParametersEnumeration() Gets all parameters of the query part in an Enumeration
String	getParameterValue(String name) Gets the lone value assigned to a parameter from the query part.
String[]	getParameterValues(String name) Gets all values assigned to a parameter from the query part.
Iterator	getParameterValuesIterator(String name) Gets all values assigned to a parameter from the query part as an Iteration.
String	getPath() Gets the path of the current URI.
String	getPort() Gets the port of the current URI.
String	getQuery() Gets the query String.
String	getScheme() Gets the scheme of the current URI.
String	getUserInfo() Gets the UserInfo of the current URI.
boolean	isAbsolute() Gets wether this URI is absolute.
protected void	parse(String uri) parse a given URI
void	removeParameter(String name) Removes the specified parameter from the query part.
void	removeParameter(String name, String value) Removes the specified name-value pair from the query part.
void	removeParameters() Removes all parameters from the query part.
void	setFragment(String fragment) Sets the fragment of the URI
void	setHost(String host) Sets the Host of the URI
void	setPath(String path) Sets the path of the URI
void	setPort(String port) Sets the port of the URI
void	setScheme(String scheme) Sets the scheme of the URI, e.g. http, https, file, ftp, ...etc.
void	setURI(String uri) Sets the URI handled by this instance.
void	setUserInfo(String userInfo) Sets the User-info of the URI
String	toString() Gets a string representation of the URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractURI

public AbstractURI()

Constructor.

AbstractURI

public AbstractURI(String uri)

Constructor with initial URL.

Parameters:

uri - The URI to hanlde.

Method Detail

setURI

public void setURI(String uri)

Sets the URI handled by this instance.

Parameters:

uri -

parse

protected void parse(String uri)

parse a given URI

Parameters:

uri -

setScheme

public void setScheme(String scheme)

Sets the scheme of the URI, e.g. http, https, file, ftp, ...etc.

Parameters:

scheme -

getScheme

public String getScheme()

Gets the scheme of the current URI.

isAbsolute

public boolean isAbsolute()

Gets wether this URI is absolute.

setFragment

public void setFragment(String fragment)

Sets the fragment of the URI

Parameters:

fragment -

getFragment

public String getFragment()

Gets the scheme of the current URI.

setUserInfo

public void setUserInfo(String userInfo)

Sets the User-info of the URI

Parameters:

userInfo -

getUserInfo

public String getUserInfo()

Gets the UserInfo of the current URI.

setHost

public void setHost(String host)

Sets the Host of the URI

Parameters:

host -

getHost

public String getHost()

Gets the Host of the current URI.

setPort

public void setPort(String port)

Sets the port of the URI

Parameters:

port -

getPort

public String getPort()

Gets the port of the current URI.

setPath

public void setPath(String path)

Sets the path of the URI

Parameters:

path -

getPath

public String getPath()

Gets the path of the current URI.

removeParameters

public void removeParameters()

Removes all parameters from the query part.

removeParameter

public void removeParameter(String name)

Removes the specified parameter from the query part.

Parameters:

name - the name of the parameter to be removed

removeParameter

public void removeParameter(String name,
                            String value)

Removes the specified name-value pair from the query part.

Parameters:

name - the name of the parameter to be removed

value -

addParameter

public void addParameter(String name,
                         String value)

Adds a parameter with value to the query part.

Parameters:

name - the name of the parameter to add.

value - the value of the parameter to add.

getParameterValues

public String[] getParameterValues(String name)

Gets all values assigned to a parameter from the query part.

Parameters:

name - the name of the parameter to get the values of.

Returns:

a String Array containing all the values of the specified parameter.

getParameterValue

public String getParameterValue(String name)

Gets the lone value assigned to a parameter from the query part. If the parameter is multi-valued, the result can be any of the values.

Parameters:

name - the name of the parameter to get the values of.

Returns:

a String containing one value of the specified parameter.

getParameterValuesIterator

public Iterator getParameterValuesIterator(String name)

Gets all values assigned to a parameter from the query part as an Iteration.

Parameters:

name - the name of the parameter to get the values of.

Returns:

an Iterator of all values assigned to the specified parameter.

getParametersEnumeration

public Enumeration getParametersEnumeration()

Gets all parameters of the query part in an Enumeration

Returns:

An Enumeration of all parameters.

getParameters

public String[] getParameters()

Gets all parameters of the query part.

getQuery

public String getQuery()

Gets the query String.

Returns:

String representation of the query part of the URI

toString

public String toString()

Gets a string representation of the URI.

Overrides:

toString in class Object

Returns:

the URI as a String.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._apideprecated	default	EP-PIN-PRT
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN