com.sap.portal.pcm.admin

Class PcmUri

java.lang.Object
  com.sap.portal.pcm.admin.PcmUri

All Implemented Interfaces:

Serializable, Cloneable

public class PcmUri
extends Object
implements Cloneable, Serializable

The class that represents a URL of a portal object or resource.

The URL (location) can be one of the following types:

• Absolute URL - specifies the full path to the object/resource
• JNDI URL - the object can be found through a JNDI lookup
• Application resource URL - the URL of the resource refers to the location of an application

See Also:

Serialized Form

Field Summary

protected String	m_application The application that contains the resource.
protected String	m_queryString The query part of the URL.
protected String	m_url The URL of the resource.
protected int	m_urlType The URL type.
static int	URL_TYPE_ABSOLUTE A constant that represents an absolute URL of a resource.
static int	URL_TYPE_APPLICATION_RESOURCE A constant that represents a URL of an application resource.
static int	URL_TYPE_JNDI_URL A constant that represents a JNDI URL of a resource.

Constructor Summary

PcmUri()
Constructs an empty PcmUri.

PcmUri(String url, int type)
Constructs a PcmUri object with a URL of the specified type.

Method Summary

Object	clone()
String	getApplication() Gets the name of the application that contains the resource.
String	getQueryString() Gets the URL query string.
int	getUrlType() Gets the URL type.
void	setApplication(String app) Sets the application containing the resource represented by this object.
void	setQueryString(String queryString) Sets the URL query string.
void	setUrlType(int urlType) Sets the URL type.
String	toString() Gets a string representation of the URL.

Methods inherited from class java.lang.Object

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

Field Detail

m_url

protected String m_url

The URL of the resource.

m_application

protected String m_application

The application that contains the resource.

m_urlType

protected int m_urlType

The URL type.

m_queryString

protected String m_queryString

The query part of the URL.

URL_TYPE_ABSOLUTE

public static final int URL_TYPE_ABSOLUTE

A constant that represents an absolute URL of a resource.

See Also:

Constant Field Values

URL_TYPE_JNDI_URL

public static final int URL_TYPE_JNDI_URL

A constant that represents a JNDI URL of a resource.

The resource can be found using JNDI lookup.

See Also:

Constant Field Values

URL_TYPE_APPLICATION_RESOURCE

public static final int URL_TYPE_APPLICATION_RESOURCE

A constant that represents a URL of an application resource.

In this case, the URL is relative to the location of the application.

See Also:

Constant Field Values

Constructor Detail

PcmUri

public PcmUri()

Constructs an empty PcmUri.

PcmUri

public PcmUri(String url,
              int type)

Constructs a PcmUri object with a URL of the specified type.

Parameters:

url - the URL

type - the URL type

Method Detail

toString

public String toString()

Gets a string representation of the URL.

Overrides:

toString in class Object

Returns:

the URL of the resource

setQueryString

public void setQueryString(String queryString)

Sets the URL query string.

Parameters:

queryString - the query string of the URL, without the '?'

getQueryString

public String getQueryString()

Gets the URL query string.

Returns:

the query string of the URL, without the '?'

setUrlType

public void setUrlType(int urlType)

Sets the URL type.

Parameters:

urlType - a constant that represents the URL type

See Also:

URL_TYPE_ABSOLUTE, URL_TYPE_JNDI_URL, URL_TYPE_APPLICATION_RESOURCE

getUrlType

public int getUrlType()

Gets the URL type.

Returns:

the URL type

See Also:

URL_TYPE_ABSOLUTE, URL_TYPE_JNDI_URL, URL_TYPE_APPLICATION_RESOURCE

setApplication

public void setApplication(String app)

Sets the application containing the resource represented by this object.

Parameters:

app - the name of the application that contains the resource

getApplication

public String getApplication()

Gets the name of the application that contains the resource.

Returns:

the application name

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

See Also:

Object.clone()

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/pcm/admin/public/api	api	EP-PIN
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM