You are viewing a plain text version of this content. The canonical link for it is here.
Posted to slide-dev@jakarta.apache.org by cm...@apache.org on 2001/08/20 18:25:48 UTC
cvs commit: jakarta-slide/src/share/org/apache/slide/structure StructureImpl.java package.html
cmlenz 01/08/20 09:25:48
Modified: src/share/org/apache/slide/structure StructureImpl.java
package.html
Log:
- Let StructureImpl inherit the docs from Structure
- Some corrections for the structure package comments
Revision Changes Path
1.22 +4 -125 jakarta-slide/src/share/org/apache/slide/structure/StructureImpl.java
Index: StructureImpl.java
===================================================================
RCS file: /home/cvs/jakarta-slide/src/share/org/apache/slide/structure/StructureImpl.java,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- StructureImpl.java 2001/07/11 17:18:10 1.21
+++ StructureImpl.java 2001/08/20 16:25:48 1.22
@@ -1,7 +1,7 @@
/*
- * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/structure/StructureImpl.java,v 1.21 2001/07/11 17:18:10 remm Exp $
- * $Revision: 1.21 $
- * $Date: 2001/07/11 17:18:10 $
+ * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/structure/StructureImpl.java,v 1.22 2001/08/20 16:25:48 cmlenz Exp $
+ * $Revision: 1.22 $
+ * $Date: 2001/08/20 16:25:48 $
*
* ====================================================================
*
@@ -78,7 +78,7 @@
* Data helper class.
*
* @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
- * @version $Revision: 1.21 $
+ * @version $Revision: 1.22 $
*/
public final class StructureImpl implements Structure {
@@ -132,17 +132,6 @@
// ------------------------------------------------------ Structure Methods
- /**
- * Get object's children.
- *
- * @param token Credentials token
- * @param object Slide object
- * @return Enumeration Enumeration of children objects
- * @exception ServiceAccessException Low level service access exception
- * @exception ObjectNotFoundException One of the children specified by
- * the object were not found
- * @exception LinkedObjectNotFoundException Cannot happen
- */
public Enumeration getChildren(SlideToken token, ObjectNode object)
throws ServiceAccessException, ObjectNotFoundException,
LinkedObjectNotFoundException {
@@ -160,21 +149,6 @@
}
- /**
- * Get object's parent.
- *
- * @param token Credentials token
- * @param object Slide object
- * @return ObjectNode Object's parent; null if the object specified
- * if the root node of the namespace
- * @exception ServiceAccessException Low level service access exception
- * @exception ObjectNotFoundException The parent object specified by
- * the object was not found
- * @exception LinkedObjectNotFoundException Cannot happen : a link cannot
- * have children
- * @exception AccessDeniedException Credentials token does not have
- * permission to perform the action
- */
public ObjectNode getParent(SlideToken token, ObjectNode object)
throws ServiceAccessException, ObjectNotFoundException,
LinkedObjectNotFoundException, AccessDeniedException {
@@ -189,20 +163,6 @@
}
- /**
- * Get an object, following any link.
- *
- * @param token Credentials token
- * @param strUri Object uri
- * @return ObjectNode Object specified by the Uri
- * @exception ServiceAccessException Low level service access exception
- * @exception ObjectNotFoundException The given Uri doesn't have
- * any matching ObjectNode
- * @exception LinkedObjectNotFoundException A link object encountered
- * during Uri resolution doesn't have a valid target
- * @exception AccessDeniedException Credentials token does not have
- * permission to perform the action
- */
public ObjectNode retrieve(SlideToken token, String strUri)
throws ServiceAccessException, ObjectNotFoundException,
LinkedObjectNotFoundException, AccessDeniedException {
@@ -210,22 +170,6 @@
}
- /**
- * Get an object, following any link.
- *
- * @param token Credentials token
- * @param strUri Object uri
- * @param translateLastUriElement If set to true and if the uri
- * is associated with a link, the function will return the linked object.
- * Otherwise, the link object is returned
- * @exception ServiceAccessException Low level service access exception
- * @exception ObjectNotFoundException The given Uri doesn't have any
- * matching ObjectNode
- * @exception LinkedObjectNotFoundException A link object encountered
- * during Uri resolution doesn't have a valid target
- * @exception AccessDeniedException Credentials token does not have
- * permission to perform the action
- */
public ObjectNode retrieve(SlideToken token, String strUri,
boolean translateLastUriElement)
throws ServiceAccessException, ObjectNotFoundException,
@@ -331,23 +275,6 @@
}
- /**
- * Create an object.
- *
- * @param token Credentials token
- * @param object Object we want to create
- * @param uri Location in the namespace where we want to create the object
- * @exception ServiceAccessException Low level service access exception
- * @exception ObjectAlreadyExistException An object already exist at
- * the specified Uri
- * @exception ObjectNotFoundException Update of the parent object
- * failed because the parent object does no longer exist. Should not
- * happen, and indicate a critical error
- * @exception LinkedObjectNotFoundException Retrieval of a link target
- * failed during Uri resolution
- * @exception AccessDeniedException Credentials token does not have
- * permission to perform the action
- */
public void create(SlideToken token, ObjectNode object,
String strUri)
throws ServiceAccessException, ObjectAlreadyExistsException,
@@ -551,25 +478,6 @@
}
- /**
- * Create a link.
- *
- * @param token Credentials token
- * @param link Link object we want to create
- * @param linkUri Location in the namespace where we want to create
- * the object
- * @param linkedObject Link target
- * @exception ServiceAccessException Low level service access exception
- * @exception ObjectAlreadyExistException An object already exist at
- * the specified Uri
- * @exception ObjectNotFoundException Update of the parent object
- * failed because the parent object does no longer exist. Should not
- * happen, and indicate a critical error
- * @exception LinkedObjectNotFoundException Retrieval of a link target
- * failed during Uri resolution
- * @exception AccessDeniedException Credentials token does not have
- * permission to perform the action
- */
public void createLink(SlideToken token, LinkNode link,
String linkUri, ObjectNode linkedObject)
throws ServiceAccessException, ObjectAlreadyExistsException,
@@ -580,20 +488,6 @@
}
- /**
- * Store (ie, update) an object.
- *
- * @param token Credentials token
- * @param object Object to update
- * @param updatePermissions True to update permissions
- * @exception ServiceAccessException Low level service access exception
- * @exception ObjectNotFoundException The update failed because one
- * object was not found during Uri resolution
- * @exception LinkedObjectNotFoundException Retrieval of a link target
- * failed during Uri resolution
- * @exception AccessDeniedException Credentials token does not have
- * permission to perform the action
- */
public void store(SlideToken token, ObjectNode object)
throws ServiceAccessException, ObjectNotFoundException,
AccessDeniedException, LinkedObjectNotFoundException {
@@ -624,21 +518,6 @@
}
- /**
- * Remove an object.
- *
- * @param token Credentials token
- * @param object Slide object to remove
- * @exception ServiceAccessException Low level service access exception
- * @exception ObjectNotFoundException The update failed because
- * one object was not found during Uri resolution
- * @exception ObjectHasChildrenException Removal failed because object
- * has children
- * @exception LinkedObjectNotFoundException Retrieval of a link target
- * failed during Uri resolution
- * @exception AccessDeniedException Credentials token does not have
- * permission to perform the action
- */
public void remove(SlideToken token, ObjectNode object)
throws ServiceAccessException, ObjectNotFoundException,
ObjectHasChildrenException, AccessDeniedException,
1.2 +28 -32 jakarta-slide/src/share/org/apache/slide/structure/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/jakarta-slide/src/share/org/apache/slide/structure/package.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 2001/08/20 15:47:44 1.1
+++ package.html 2001/08/20 16:25:48 1.2
@@ -4,9 +4,9 @@
<head>
<!--
- $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/structure/package.html,v 1.1 2001/08/20 15:47:44 cmlenz Exp $
- $Revision: 1.1 $
- $Date: 2001/08/20 15:47:44 $
+ $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/structure/package.html,v 1.2 2001/08/20 16:25:48 cmlenz Exp $
+ $Revision: 1.2 $
+ $Date: 2001/08/20 16:25:48 $
====================================================================
@@ -69,7 +69,7 @@
<body>
<p>
- Provides classes for navigating and manipulating the hierarchy of nodes
+ Contains classes for navigating and manipulating the hierarchy of nodes
in a namespace.
</p>
<h3>Nodes</h3>
@@ -78,32 +78,28 @@
children (called sub-nodes). Just like in a filesystem, nodes have
different types.
{@link org.apache.slide.structure.ObjectNode ObjectNode} is an abstract
- data type that represents a node in the namespace structure. A node can
- be either of the following concrete types:
- </p>
- <ul>
- <li>
- {@link org.apache.slide.structure.SubjectNode SubjectNode} is a type
- for storing most Slide information. A subject can be a file, a
- directory or a principal.
- </li>
- <li>
- {@link org.apache.slide.structure.GroupNode GroupNode} is a type used
- to define groups of nodes, usually groups of users.
- </li>
- <li>
- {@link org.apache.slide.structure.LinkNode LinkNode} represents a node
- that is a link to another node in the same namespace.
- </li>
- <li>
- {@link org.apache.slide.structure.ActionNode ActionNode} is a type for
- defining available actions on Slide objects. In Slide, actions can be
- dynamically placed in the namespace to provide flexible security
- policy definition.
- </li>
- </ul>
- <p>
- The type of the node determines which roles the node has. See the
+ data type that can represent any node in the namespace structure. In
+ addition, every node must be of either of the following concrete types:
+ <ul>
+ <li>
+ {@link org.apache.slide.structure.SubjectNode SubjectNode} is the most
+ common type of node used in a namespace. A subject can be a file, a
+ directory or a principal.
+ </li>
+ <li>
+ {@link org.apache.slide.structure.LinkNode LinkNode} represents a node
+ that is a link to another node in the same namespace.
+ </li>
+ <li>
+ {@link org.apache.slide.structure.GroupNode GroupNode} is used to
+ define a group of nodes (usually of users).
+ </li>
+ <li>
+ {@link org.apache.slide.structure.ActionNode ActionNode} is a type for
+ defining available actions on nodes.
+ </li>
+ </ul>
+ The type of a node determines which roles that node has. See the
{@link org.apache.slide.security Security} package for more information
on roles.
</p>
@@ -112,9 +108,9 @@
The central point in this package is the
{@link org.apache.slide.structure.Structure Structure}
interface, also referred to as the Structure Helper, which you can
- access by calling
+ access using the
{@link org.apache.slide.common.NamespaceAccessToken#getStructureHelper()
- NamespaceAccessToken.getStructureHelper()}.
+ NamespaceAccessToken.getStructureHelper()} method.
It provides all the methods required to access and manipulate the node
hierarchy of a namespace.
</p>