|
||||||||||
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.spa.data.SpaURI
public class SpaURI
URI that allows to address static resources inside a ZIP file that is associated to a static page
Field Summary |
---|
Fields inherited from class com.ibm.portal.resolver.uri.BaseURI |
---|
LOG_LEVEL, NULL_FACTORY |
Fields inherited from interface com.ibm.portal.spa.data.Constants |
---|
KEY_DEVICE_CLASS, KEY_LOCALE, SCHEME_SPA_URI, SCHEME_ZIP_URI, SPA_HTTP_EQUIV_URI |
Fields inherited from interface com.ibm.portal.resolver.uri.Constants |
---|
ESCAPE_CHAR, ESCAPE_STRG |
Constructor Summary | |
---|---|
SpaURI(java.lang.String uri,
Identification idSvc,
PocURIFactory uriFct)
Parses the URI based on a string representation |
|
SpaURI(java.net.URI uri,
Identification idSvc)
Parses the URI and provides the parts of this URI as objects |
Method Summary | |
---|---|
SpaURI |
clone()
|
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getFileName()
Filename of the file inside the ZIP that is addressed by this URI. |
java.lang.String |
getMarkup()
The markup identifier. |
ObjectID |
getObjectID()
Returns the object ID of the resource that implements the Identifiable
interface. |
java.lang.String |
getPathName()
Returns the path portion after the page ID, this path name will start with a slash character if it exists |
int |
hashCode()
|
boolean |
isDirectory()
Checks if the addressed file is a folder. |
boolean |
isFile()
Checks if the addressed file is a file. |
boolean |
isPath()
Checks if the resource either specifies a file or directory |
static java.net.URI |
newInstance(ObjectID pageID,
Identification idSvc,
PocURIFactory pocService)
Creates a URI that only addresses the static page, but not a resource inside this page |
static java.net.URI |
newInstance(ObjectID pageID,
java.lang.String markup,
Identification idSvc)
Deprecated. use newInstance(ObjectID, String, Identification, PocService)
instead |
static java.net.URI |
newInstance(ObjectID pageID,
java.lang.String markup,
Identification idSvc,
PocService pocService)
Deprecated. |
static java.net.URI |
newInstance(ObjectID pageID,
java.lang.String markup,
Identification idSvc,
PocURIFactory pocService)
Creates a URI that only addresses the static page, but not a resource inside this page |
static java.net.URI |
newInstance(ObjectID pageID,
java.lang.String markup,
java.lang.String fileName,
Identification idSvc)
Deprecated. use newInstance(ObjectID, String, String, Identification, PocService)
instead |
static java.net.URI |
newInstance(ObjectID pageID,
java.lang.String markup,
java.lang.String fileName,
Identification idSvc,
PocService pocService)
Deprecated. |
static java.net.URI |
newInstance(ObjectID pageID,
java.lang.String markup,
java.lang.String fileName,
Identification idSvc,
PocURIFactory pocService)
Constructs a new URI based on the pageID and the filename inside the ZIP file. |
static java.net.URI |
newInstance(java.lang.String pageName,
java.lang.String markup)
Deprecated. use newInstance(String, String, PocService) instead |
static java.net.URI |
newInstance(java.lang.String pageName,
java.lang.String markup,
PocService pocService)
Deprecated. |
static java.net.URI |
newInstance(java.lang.String pageName,
java.lang.String markup,
PocURIFactory pocService)
Creates a URI that only addresses the static page, but not a resource inside this page |
static java.net.URI |
newInstance(java.lang.String pageName,
java.lang.String markup,
java.lang.String fileName)
Deprecated. use #newInstance(String, String, String, PocService)
instead |
static java.net.URI |
newInstance(java.lang.String pageName,
java.lang.String markup,
java.lang.String fileName,
PocURIFactory pocService)
Constructs a new URI based on the serialized form of the page and the filename inside the ZIP file. |
java.lang.String |
toString()
|
java.net.URI |
toURI()
Returns the URI object this SPA URI was constructed from |
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 |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SpaURI(java.lang.String uri, Identification idSvc, PocURIFactory uriFct) throws SerializationException, java.net.URISyntaxException, java.io.IOException
uri
- the SPA URIidSvc
- the identification service
java.net.MalformedURLException
SerializationException
java.net.URISyntaxException
java.io.IOException
public SpaURI(java.net.URI uri, Identification idSvc) throws java.net.MalformedURLException, SerializationException
uri
- the SPA URIidSvc
- the identification service
java.net.MalformedURLException
SerializationException
Method Detail |
---|
public static java.net.URI newInstance(ObjectID pageID, Identification idSvc, PocURIFactory pocService) throws SerializationException, java.net.URISyntaxException
pageID
- the ObjectID
of the pageidSvc
- the identification service used to serialize the ID
SerializationException
java.net.URISyntaxException
@Deprecated public static java.net.URI newInstance(ObjectID pageID, java.lang.String markup, Identification idSvc) throws SerializationException
newInstance(ObjectID, String, Identification, PocService)
instead
pageID
- the ObjectID
of the pagemarkup
- the markup nameidSvc
- the identification service used to serialize the ID
SerializationException
@Deprecated public static java.net.URI newInstance(ObjectID pageID, java.lang.String markup, Identification idSvc, PocService pocService) throws SerializationException, java.net.URISyntaxException
pageID
- the ObjectID
of the pagemarkup
- the markup nameidSvc
- the identification service used to serialize the ID
SerializationException
java.net.URISyntaxException
public static java.net.URI newInstance(ObjectID pageID, java.lang.String markup, Identification idSvc, PocURIFactory pocService) throws SerializationException, java.net.URISyntaxException
pageID
- the ObjectID
of the pagemarkup
- the markup nameidSvc
- the identification service used to serialize the ID
SerializationException
java.net.URISyntaxException
@Deprecated public static java.net.URI newInstance(ObjectID pageID, java.lang.String markup, java.lang.String fileName, Identification idSvc) throws SerializationException
newInstance(ObjectID, String, String, Identification, PocService)
instead
pageID
- the ObjectID
of the pagemarkup
- the markup namefileName
- the filename inside the ZIPidSvc
- the identification service used to serialize the ID
SerializationException
@Deprecated public static java.net.URI newInstance(ObjectID pageID, java.lang.String markup, java.lang.String fileName, Identification idSvc, PocService pocService) throws SerializationException, java.net.URISyntaxException
pageID
- the ObjectID
of the pagemarkup
- the markup namefileName
- the filename inside the ZIPidSvc
- the identification service used to serialize the ID
SerializationException
java.net.URISyntaxException
public static java.net.URI newInstance(ObjectID pageID, java.lang.String markup, java.lang.String fileName, Identification idSvc, PocURIFactory pocService) throws SerializationException, java.net.URISyntaxException
pageID
- the ObjectID
of the pagemarkup
- the markup namefileName
- the filename inside the ZIPidSvc
- the identification service used to serialize the ID
SerializationException
java.net.URISyntaxException
@Deprecated public static java.net.URI newInstance(java.lang.String pageName, java.lang.String markup)
newInstance(String, String, PocService)
instead
pageName
- the page name (OID or unique namemarkup
- the markup name
@Deprecated public static java.net.URI newInstance(java.lang.String pageName, java.lang.String markup, PocService pocService) throws java.net.URISyntaxException
pageName
- the page name (OID or unique namemarkup
- the markup name
java.net.URISyntaxException
public static java.net.URI newInstance(java.lang.String pageName, java.lang.String markup, PocURIFactory pocService) throws java.net.URISyntaxException
pageName
- the page name (OID or unique namemarkup
- the markup name
java.net.URISyntaxException
@Deprecated public static java.net.URI newInstance(java.lang.String pageName, java.lang.String markup, java.lang.String fileName)
#newInstance(String, String, String, PocService)
instead
pageName
- serialized form of the page IDmarkup
- the markup namefileName
- the filename inside the ZIP file
public static java.net.URI newInstance(java.lang.String pageName, java.lang.String markup, java.lang.String fileName, PocURIFactory pocService) throws java.net.URISyntaxException
pageName
- serialized form of the page IDmarkup
- the markup namefileName
- the filename inside the ZIP file
java.net.URISyntaxException
public SpaURI clone()
clone
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String getFileName()
spa:OID/MARKUP
). It is the empty string if the URI addresses
the root folder (i.e. spa:OID/MARKUP/
). Use
isDirectory()
or isFile()
to distinguish between these
cases.
null
or the empty stringpublic java.lang.String getMarkup()
null
if the URI only addresses
the page (i.e. spa:OID
).
null
public ObjectID getObjectID()
Identifiable
Identifiable
interface.
getObjectID
in interface Identifiable
null
public java.lang.String getPathName()
null
public int hashCode()
hashCode
in class java.lang.Object
public boolean isDirectory()
true
if the addressed resource is a folder, else
false
public boolean isFile()
true
if the addressed resource is a file, else
false
public boolean isPath()
true
if either isFile()
or
isDirectory()
return true
, else
false
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 |