|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IdentityBuilder
Converts between DocumentId's and ReST URIs
Method Summary | |
---|---|
boolean |
isRestURI(java.net.URI uri)
Determine if the provided URI is a valid ReST URI. |
RestURI |
toRestURI(DocumentId<?> id)
Converts the given document id into a canonical form of the ReST URI for the same item. |
RestURI |
toRestURI(java.net.URI restUri)
Converts a java.net.URI that refers to a WCM item
into a RestURI for the same item. |
Method Detail |
---|
RestURI toRestURI(DocumentId<?> id) throws IdentityCreationException, java.net.URISyntaxException
An example canonical URI is;
wcmrest:Content/1234-1234-1234-1234
The ReST representation of an item can be retrieved using the canonical representation
by issuing a GET request of the form;
http://myserver.com/wps/mypoc?uri=wcmrest:Content/1234-1234-1234-1234&mode=download
Alternatively, the expanded URI can be determined by issuing a GET request of the form
http://myserver.com/wps/mypoc?uri=wcmrest:Content/1234-1234-1234-1234&mode=lookup
This will return XML specifying the expanded URI.
id
- the document id to convert
IdentityCreationException
- if there is an error during conversion
java.net.URISyntaxException
- if there is a syntax error with the generated URI
java.lang.IllegalArgumentException
- if the provided DocumentId
is nullRestURI toRestURI(java.net.URI restUri) throws IdentityCreationException
java.net.URI
that refers to a WCM item
into a RestURI
for the same item.
restUri
- the ReST URI
com.ibm.workplace.wcm.api.exceptions.DocumentIdCreationException
- if there is an error during conversion
IdentityCreationException
- if there is an error during conversion
java.lang.IllegalArgumentException
- if the provided URI
is null, or not a valid rest URIboolean isRestURI(java.net.URI uri)
#toDocumentId(URI)
with the URI
will not result in an exception being thrown.
uri
- the URI to check
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |