|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.portal.resolver.uri.BaseURI com.ibm.portal.resolver.uri.PortletURI
public class PortletURI
Handles URIs of the format
portlet:<portletWindowID>[@<pageID>][/<pocURIScheme>/<pocURISchemeSpecificPart>]in case there are '@' signs in the
portletWindowID
or
pageID
they must be escaped using URL escaping.
pocURI
does not need to be escaped specifically. The IDs can
either be serialized objectIDs or unique names.
Field Summary |
---|
Fields inherited from class com.ibm.portal.resolver.uri.BaseURI |
---|
NULL_FACTORY |
Fields inherited from interface com.ibm.portal.resolver.data.Addressable |
---|
EMPTY_PARAMETERS |
Fields inherited from interface com.ibm.portal.resolver.uri.Constants |
---|
ESCAPE_CHAR, ESCAPE_STRG |
Constructor Summary | |
---|---|
PortletURI(java.net.URI portletURI,
Identification id)
Tokenizes the uri into the components that make up a portlet URI |
|
PortletURI(java.net.URI portletURI,
Identification id,
PocURIFactory uriFct)
Tokenizes the uri into the components that make up a portlet URI |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
ObjectID |
getObjectID()
Returns the object ID of the portlet window |
ObjectID |
getPageID()
Returns the objectID of the page |
java.util.Map<java.lang.String,java.lang.String[]> |
getParameters()
Returns an potentially unmodifiable version of the parameters used to address the object, never null , but potentially the empty
map. |
java.net.URI |
getPocURI()
|
ObjectID |
getPortletWindowID()
Deprecated. use getObjectID() instead, since the URI not always
contains portlet window IDs |
java.net.URI |
getURI()
Returns the unique identifier of the object. |
int |
hashCode()
|
static java.net.URI |
newInstance(Identifiable resourceID,
Identifiable pageID,
java.net.URI pocURI,
Identification id,
PocURIFactory uriFct)
Constructs a new URI that matches the pattern of a portlet URI. |
static java.net.URI |
newInstance(Identifiable resourceID,
java.net.URI pocURI,
Identification id,
PocURIFactory aFactory)
Constructs a new URI that matches the pattern of a portlet URI. |
static java.net.URI |
newInstance(ObjectID resourceID,
ObjectID pageID,
java.net.URI pocURI,
Identification id)
Constructs a new URI that matches the pattern of a portlet URI. |
static java.net.URI |
newInstance(ObjectID resourceID,
ObjectID pageID,
java.net.URI pocURI,
Identification id,
PocURIFactory uriFct)
Constructs a new URI that matches the pattern of a portlet URI. |
static java.net.URI |
newInstance(ObjectID resourceID,
java.net.URI pocURI,
Identification id)
Constructs a new URI that matches the pattern of a portlet URI. |
static java.net.URI |
newInstance(ObjectID resourceID,
java.net.URI pocURI,
Identification id,
PocURIFactory uriFct)
Constructs a new URI that matches the pattern of a portlet URI. |
java.net.URI |
newInstance(java.net.URI aPocURI)
Construct a portlet URI with the same portlet ID but a new POC URI |
java.lang.String |
toString()
|
java.net.URI |
toURI()
Returns the URI version of this portlet URI |
Methods inherited from class com.ibm.portal.resolver.uri.BaseURI |
---|
createURI, createURI, createURI, createURI, decode, decode, decode, decode, encode, encode, normalizeRawSchemeSpecificPart, normalizeRawSchemeSpecificPart |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PortletURI(java.net.URI portletURI, Identification id) throws SerializationException, java.net.URISyntaxException, java.io.IOException
portletURI
- uri to decodeid
- identification service used for string deserialization
SerializationException
- for errors during the serialization or deserialization of
object IDs.
java.net.URISyntaxException
- if a POCURI is available and if this URI is not a valid URI
java.io.IOException
- for errors during the decoding processpublic PortletURI(java.net.URI portletURI, Identification id, PocURIFactory uriFct) throws SerializationException, java.net.URISyntaxException, java.io.IOException
portletURI
- uri to decodeid
- identification service used for string deserialization
SerializationException
- for errors during the serialization or deserialization of
object IDs.
java.net.URISyntaxException
- if a POCURI is available and if this URI is not a valid URI
java.io.IOException
- for errors during the decoding processMethod Detail |
---|
public static final java.net.URI newInstance(Identifiable resourceID, Identifiable pageID, java.net.URI pocURI, Identification id, PocURIFactory uriFct) throws SerializationException, java.net.URISyntaxException, java.io.IOException
resourceID
- objectID to the portlet window, must not be null
pageID
- objectID of the page that contains the portlet window, may be
null
pocURI
- pocURI, potentially null
id
- identification service used for the serialization of the
objectIDs
SerializationException
SerializationException
java.net.URISyntaxException
java.net.URISyntaxException
java.io.IOException
java.io.IOException
public static final java.net.URI newInstance(Identifiable resourceID, java.net.URI pocURI, Identification id, PocURIFactory aFactory) throws SerializationException, java.net.URISyntaxException, java.io.IOException
resourceID
- objectID to the portlet window, must not be null
pocURI
- pocURI, potentially null
id
- identification service used for the serialization of the
objectIDs
SerializationException
java.net.URISyntaxException
java.io.IOException
public static final java.net.URI newInstance(ObjectID resourceID, ObjectID pageID, java.net.URI pocURI, Identification id) throws SerializationException, java.net.URISyntaxException, java.io.IOException
resourceID
- objectID to the portlet window, must not be null
pageID
- objectID of the page that contains the portlet window, may be
null
pocURI
- pocURI, potentially null
id
- identification service used for the serialization of the
objectIDs
SerializationException
SerializationException
java.net.URISyntaxException
java.net.URISyntaxException
java.io.IOException
java.io.IOException
public static final java.net.URI newInstance(ObjectID resourceID, ObjectID pageID, java.net.URI pocURI, Identification id, PocURIFactory uriFct) throws SerializationException, java.net.URISyntaxException, java.io.IOException
resourceID
- objectID to the portlet window, must not be null
pageID
- objectID of the page that contains the portlet window, may be
null
pocURI
- pocURI, potentially null
id
- identification service used for the serialization of the
objectIDs
SerializationException
SerializationException
java.net.URISyntaxException
java.net.URISyntaxException
java.io.IOException
java.io.IOException
public static final java.net.URI newInstance(ObjectID resourceID, java.net.URI pocURI, Identification id) throws SerializationException, java.net.URISyntaxException, java.io.IOException
resourceID
- objectID to the portlet window, must not be null
pocURI
- pocURI, potentially null
id
- identification service used for the serialization of the
objectIDs
SerializationException
java.net.URISyntaxException
java.io.IOException
public static final java.net.URI newInstance(ObjectID resourceID, java.net.URI pocURI, Identification id, PocURIFactory uriFct) throws SerializationException, java.net.URISyntaxException, java.io.IOException
resourceID
- objectID to the portlet window, must not be null
pocURI
- pocURI, potentially null
id
- identification service used for the serialization of the
objectIDs
SerializationException
java.net.URISyntaxException
java.io.IOException
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public ObjectID getObjectID()
getObjectID
in interface Identifiable
null
Identifiable.getObjectID()
public ObjectID getPageID()
null
public java.util.Map<java.lang.String,java.lang.String[]> getParameters()
Addressable
Returns an potentially unmodifiable version of the parameters used to
address the object, never null
, but potentially the empty
map.
The key is of type String
, the values of type
String[]
getParameters
in interface Addressable
public java.net.URI getPocURI()
null
@Deprecated public ObjectID getPortletWindowID()
getObjectID()
instead, since the URI not always
contains portlet window IDs
null
public java.net.URI getURI()
Addressable
getURI
in interface Addressable
null
.public int hashCode()
hashCode
in class java.lang.Object
public java.net.URI newInstance(java.net.URI aPocURI) throws SerializationException, java.net.URISyntaxException, java.io.IOException
aPocURI
- the new poc URI
java.net.URISyntaxException
SerializationException
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
public java.net.URI toURI()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |