com.sap.netweaver.bc.rf.common

Class UriReference

java.lang.Object
  com.sap.netweaver.bc.rf.common.UriReference

All Implemented Interfaces:

IUriReference

public class UriReference
extends Object
implements IUriReference

A RFC2396 reference implementation.

Copyright (c) SAP AG 2001-2003

Constructor Summary

UriReference(IAbsoluteUri uri, String fragmentIdentifier)
Construct new absolute uri reference.

UriReference(IUriReference reference, String fragmentIdentifier)
Construct object of class UriReference.

UriReference(String path, String query, String fragment)
Construct new relative uri reference without authority and scheme.

UriReference(String authority, String path, String query, String fragment)
Construct new relative uri reference without scheme.

UriReference(String scheme, String authority, String path, String query, String fragment)
Construct new relative uri reference with scheme.

Method Summary

IUriReference	appendPath(String path) TBD: Description of the Method.
boolean	equals(IUriReference other)
boolean	equals(Object other)
boolean	equals(UriReference other)
String	getAuthority() Get the authority of the reference
String	getFragmentIdentifier() Get the fragment identifier (without '#') of the uri
String	getPath() Get the path of the reference
String	getQuery() Get the query of the reference
String	getScheme() Get the scheme of the reference
IAbsoluteUri	getUri() Get the uri if the reference is absolute
int	hashCode() TBD: Description of the Method.
boolean	isAbsolute() Determine if the reference is absolute
IUriReference	resolveWith(IAbsoluteUri base) With base Uri, resolve this reference to an absolute reference.
IUriReference	setQuery(String query) Set the query attribute of the UriReference object.
String	toExternalForm() TBD: Description of the Method.
String	toString() TBD: Description of the Method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UriReference

public UriReference(IAbsoluteUri uri,
                    String fragmentIdentifier)

Construct new absolute uri reference.

Parameters:

uri - the absolute uri

fragmentIdentifier - the fragment of the uri reference

UriReference

public UriReference(String path,
                    String query,
                    String fragment)

Construct new relative uri reference without authority and scheme.

Parameters:

path - the path of the reference or empty

fragment - used in reference of null

query - TBD: Description of the incoming method parameter

UriReference

public UriReference(String authority,
                    String path,
                    String query,
                    String fragment)

Construct new relative uri reference without scheme.

Parameters:

authority - of the relative uri reference

path - the path of the reference or empty

fragment - used in reference of null

query - TBD: Description of the incoming method parameter

UriReference

public UriReference(String scheme,
                    String authority,
                    String path,
                    String query,
                    String fragment)
             throws IllegalArgumentException

Construct new relative uri reference with scheme. This constructor is used for a degenerate case as described in RFC 2396, page 32. The construction of relative uri references with scheme is discouraged. Note that either scheme or authority must be null.

Parameters:

scheme - of the relative uri reference

authority - of the relative uri reference

path - the path of the reference or empty

fragment - used in reference of null

query - TBD: Description of the incoming method parameter

Throws:

IllegalArgumentException - Exception raised in failure situation

java.lang.ArgumentNotValidException - if both scheme and authority are not null

UriReference

public UriReference(IUriReference reference,
                    String fragmentIdentifier)

Construct object of class UriReference.

Parameters:

reference - TBD: Description of the incoming method parameter

fragmentIdentifier - TBD: Description of the incoming method parameter

Method Detail

appendPath

public IUriReference appendPath(String path)

TBD: Description of the Method.

Specified by:

appendPath in interface IUriReference

Parameters:

path - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

setQuery

public IUriReference setQuery(String query)

Set the query attribute of the UriReference object.

Specified by:

setQuery in interface IUriReference

Parameters:

query - The new query value

Returns:

TBD: Description of the outgoing return value

equals

public boolean equals(Object other)

Overrides:

equals in class Object

equals

public boolean equals(IUriReference other)

equals

public boolean equals(UriReference other)

hashCode

public int hashCode()

TBD: Description of the Method.

Overrides:

hashCode in class Object

Returns:

TBD: Description of the outgoing return value

toExternalForm

public String toExternalForm()

TBD: Description of the Method.

Specified by:

toExternalForm in interface IUriReference

Returns:

TBD: Description of the outgoing return value

toString

public String toString()

TBD: Description of the Method.

Overrides:

toString in class Object

Returns:

TBD: Description of the outgoing return value

getFragmentIdentifier

public String getFragmentIdentifier()

Get the fragment identifier (without '#') of the uri

Specified by:

getFragmentIdentifier in interface IUriReference

Returns:

fragment identifier or emtpy String

getScheme

public String getScheme()

Get the scheme of the reference

Specified by:

getScheme in interface IUriReference

Returns:

scheme of reference or null

getAuthority

public String getAuthority()

Get the authority of the reference

Specified by:

getAuthority in interface IUriReference

Returns:

authority of reference or null

getPath

public String getPath()

Get the path of the reference

Specified by:

getPath in interface IUriReference

Returns:

path of reference or empty string

getQuery

public String getQuery()

Get the query of the reference

Specified by:

getQuery in interface IUriReference

Returns:

query of reference or null

getUri

public IAbsoluteUri getUri()

Get the uri if the reference is absolute

Specified by:

getUri in interface IUriReference

Returns:

uri of reference or null

isAbsolute

public boolean isAbsolute()

Determine if the reference is absolute

Specified by:

isAbsolute in interface IUriReference

Returns:

if reference is absolute

resolveWith

public IUriReference resolveWith(IAbsoluteUri base)

With base Uri, resolve this reference to an absolute reference. If this reference is already absolute, this is the identity operation.

Specified by:

resolveWith in interface IUriReference

Parameters:

base - uri to resolve this reference with

Returns:

absolute uri reference

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM