|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Structure helper. Provides methods to manage and navigate the hierarchy of nodes in a namespace.
Method Summary | |
void |
addBinding(SlideToken token,
ObjectNode collectionNode,
java.lang.String segment,
ObjectNode sourceNode)
Modifies the collection identified by collectionNode, by adding a new binding from the specified segment to the resource identified by sourceNode. |
void |
create(SlideToken token,
ObjectNode object,
java.lang.String strUri)
Creates a new node in the namespace. |
void |
createLink(SlideToken token,
LinkNode link,
java.lang.String linkUri,
ObjectNode linkedObject)
Creates a link to another node in the namespace. |
java.util.Enumeration |
getChildren(SlideToken token,
ObjectNode object)
Returns the children of a node. |
ObjectNode |
getParent(SlideToken token,
ObjectNode object)
Returns the parent of a node. |
java.util.List |
getParents(SlideToken token,
ObjectNode object,
boolean pathOnly,
boolean storeOnly,
boolean includeSelf)
Return all parents of this object node. |
void |
remove(SlideToken token,
ObjectNode object)
Removes a node from the namespace. |
void |
removeBinding(SlideToken token,
ObjectNode collectionNode,
java.lang.String segment)
Modifies the collection identified by collectionNode, by removing the binding for the specified segment. |
ObjectNode |
retrieve(SlideToken token,
java.lang.String strUri)
Retrieves a node by URI, following any links. |
ObjectNode |
retrieve(SlideToken token,
java.lang.String strUri,
boolean translateLastUriElement)
Retrieves a node by URI. |
void |
store(SlideToken token,
ObjectNode object)
Stores/updates an object. |
Method Detail |
public java.util.Enumeration getChildren(SlideToken token, ObjectNode object) throws ServiceAccessException, ObjectNotFoundException, LinkedObjectNotFoundException
token
- the slide tokenobject
- the node
ServiceAccessException
- low level service access exception
ObjectNotFoundException
- one of the children specified
by the object was not found
LinkedObjectNotFoundException
- cannot happenObjectNode.enumerateChildren()
public ObjectNode getParent(SlideToken token, ObjectNode object) throws ServiceAccessException, ObjectNotFoundException, LinkedObjectNotFoundException, AccessDeniedException
token
- the slide tokenobject
- the node
null
if the object specified
is the root node of the namespace
ServiceAccessException
- low level service access exception
ObjectNotFoundException
- the parent object specified
by the object was not found
LinkedObjectNotFoundException
- cannot happen (a link
cannot have children)
AccessDeniedException
- credentials token does not
have permission to perform the actionObjectNode.enumerateChildren()
public java.util.List getParents(SlideToken token, ObjectNode object, boolean pathOnly, boolean storeOnly, boolean includeSelf) throws ServiceAccessException, ObjectNotFoundException, LinkedObjectNotFoundException, AccessDeniedException
token
- a SlideTokenobject
- an ObjectNodepathOnly
- if true, only parents on the path of the specified
ObjectNode are returned, all parents (binding!)
otherwisestoreOnly
- if true, only parents within the scope of the store
in charge of the specified ObjectNode are returned,
parents up to the root ObjectNode (uri="/") otherwiseincludeSelf
- if true, the ObjectNode specified by object is included,
otherwise, it is excluded
ServiceAccessException
ObjectNotFoundException
LinkedObjectNotFoundException
AccessDeniedException
public ObjectNode retrieve(SlideToken token, java.lang.String strUri) throws ServiceAccessException, ObjectNotFoundException, LinkedObjectNotFoundException, AccessDeniedException
token
- the slide tokenstrUri
- the URI of the object to retrieve
ServiceAccessException
- low level service access exception
ObjectNotFoundException
- if no node exists at the URI
LinkedObjectNotFoundException
- A link object encountered
during URI resolution doesn't have a valid target
AccessDeniedException
- credentials token does not have
permission to perform the actionpublic ObjectNode retrieve(SlideToken token, java.lang.String strUri, boolean translateLastUriElement) throws ServiceAccessException, ObjectNotFoundException, LinkedObjectNotFoundException, AccessDeniedException
token
- the slide tokenstrUri
- the URI of the object to retrievetranslateLastUriElement
- if set to true and the URI is
associated with a link, this method will return the target of
the link, otherwise the link itself is returned
translateLastUriElement
is true
ServiceAccessException
- low level service access exception
ObjectNotFoundException
- if no node exists at the URI
LinkedObjectNotFoundException
- A link object encountered
during URI resolution doesn't have a valid target
AccessDeniedException
- credentials token does not have
permission to perform the actionpublic void create(SlideToken token, ObjectNode object, java.lang.String strUri) throws ServiceAccessException, ObjectAlreadyExistsException, ObjectNotFoundException, LinkedObjectNotFoundException, AccessDeniedException, ObjectLockedException
token
- the slide tokenobject
- the object that should be createdstrUri
- location in the namespace where we the object should be
created
ServiceAccessException
- low level service access exception
ObjectAlreadyExistException
- an object already exists
at the specified URI
ObjectNotFoundException
- Update of the parent object
failed because the parent object does no longer exist.
Should not happen, and indicates a critical error if it does
LinkedObjectNotFoundException
- retrieval of a link target
failed during URI resolution
AccessDeniedException
- credentials token does not have
permission to perform the action
ObjectAlreadyExistsException
ObjectLockedException
public void createLink(SlideToken token, LinkNode link, java.lang.String linkUri, ObjectNode linkedObject) throws ServiceAccessException, ObjectAlreadyExistsException, ObjectNotFoundException, LinkedObjectNotFoundException, AccessDeniedException, ObjectLockedException
token
- the slide tokenlink
- the link object that should be createdlinkUri
- location in the namespace where the link object should
be createdlinkedObject
- target object of the link
ServiceAccessException
- Low level service access exception
ObjectAlreadyExistException
- An object already exist
at the specified URI
ObjectNotFoundException
- Update of the parent object
failed because the parent object does no longer exist.
Should not happen, and indicate a critical error if it does
LinkedObjectNotFoundException
- Retrieval of a link target
failed during Uri resolution
AccessDeniedException
- credentials token does not have
permission to perform the action
ObjectAlreadyExistsException
ObjectLockedException
public void store(SlideToken token, ObjectNode object) throws ServiceAccessException, ObjectNotFoundException, AccessDeniedException, LinkedObjectNotFoundException
token
- the slide tokenobject
- the object to update
ServiceAccessException
- low level service access exception
ObjectNotFoundException
- the update failed because one
object was not found during URI resolution
LinkedObjectNotFoundException
- retrieval of a link target
failed during URI resolution
AccessDeniedException
- credentials token does not have
permission to perform the actionpublic void remove(SlideToken token, ObjectNode object) throws ServiceAccessException, ObjectNotFoundException, ObjectHasChildrenException, AccessDeniedException, LinkedObjectNotFoundException, ObjectLockedException
token
- the slide tokenobject
- the node to remove
ServiceAccessException
- low level service access exception
ObjectNotFoundException
- the update failed because an
object was not found during URI resolution
ObjectHasChildrenException
- removal failed because object
has children
LinkedObjectNotFoundException
- retrieval of a link target
failed during URI resolution
AccessDeniedException
- credentials token does not have
permission to perform the action
ObjectLockedException
public void addBinding(SlideToken token, ObjectNode collectionNode, java.lang.String segment, ObjectNode sourceNode) throws ServiceAccessException, ObjectNotFoundException, AccessDeniedException, LinkedObjectNotFoundException, ObjectLockedException, CrossServerBindingException
token
- a SlideTokencollectionNode
- an ObjectNodesegment
- a StringsourceNode
- an ObjectNode
ServiceAccessException
ObjectNotFoundException
AccessDeniedException
LinkedObjectNotFoundException
ObjectLockedException
CrossServerBindingException
public void removeBinding(SlideToken token, ObjectNode collectionNode, java.lang.String segment) throws ServiceAccessException, ObjectNotFoundException, AccessDeniedException, LinkedObjectNotFoundException, ObjectLockedException
token
- a SlideTokencollectionNode
- an ObjectNodesegment
- a String
ServiceAccessException
ObjectNotFoundException
AccessDeniedException
LinkedObjectNotFoundException
ObjectLockedException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |