/ - Diff - Metacat - Ecoinformatics Redmine

« Previous | Next »

Revision 5115

Added by daigle over 14 years ago

Format and add comments.

     /**
      * Exception thrown when an error occurs in a configuration administrative
      * class
      * Exception thrown when an error occurs during access control
      */
     public class AccessControlException extends BaseException {
     	private static final long serialVersionUID = -8436697355629175917L;
     	private static final long serialVersionUID = 6685974477000997612L;
     	/**
     	 * Create a new AccessControlException.
+    	 *

     					"must be specified when selecting xml_access record");
+    		}
     		// first get the job from the db and put it into a DAO
     		// first get the xml access from the db and put it into a DAO list
     		PreparedStatement pstmt = null;
     		DBConnection conn = null;
     		int serialNumber = -1;
-...
     				XMLAccessDAO xmlAccessDAO = populateDAO(resultSet);
     				xmlAccessList.add(xmlAccessDAO);
+    			}
     			// make sure permission orders do not conflict in the database
     			validateDocXMLAccessList(xmlAccessList);
     			return xmlAccessList;
-...
     					"must be specified when selecting xml_access record");
+    		}
     		// first get the job from the db and put it into a DAO
     		// first get the xml access for this principal from the db and put it into a DAO list
     		PreparedStatement pstmt = null;
     		DBConnection conn = null;
     		int serialNumber = -1;
-...
     				xmlAccessList.add(xmlAccessDAO);
+    			}
     			// make sure permission orders do not conflict in the database
     			validatePrincipalXMLAccessList(xmlAccessList);
     			return xmlAccessList;
-...
+    	}
     	/**
     	 * Get all xml access for a principal for a certain document
     	 * Get all xml access for a principal/permType/permOrder for a certain document
+    	 *
     	 * @param docId
     	 *            the id of the document
-...
     					"must be specified when selecting xml_access record");
+    		}
     		// first get the job from the db and put it into a DAO
     		// first get the xml access for this principal from the db and put it into a DAO list
     		PreparedStatement pstmt = null;
     		DBConnection conn = null;
     		int serialNumber = -1;
-...
+    	}
     	/**
     	 * Delete xml access.  This removes all access records from the database for a principal
     	 * for a given document, perm type and perm order
     	 * Checks to see if there is a permission order conflict for a given document.  Each
     	 * document is only allowed to have a single permission order
+    	 *
     	 * @param docId
     	 *            document id
     	 * @param principal
-...
     	/**
     	 * Delete xml access.  This removes all access records from the database for a principal
     	 * for a given document, perm type and perm order
+    	 *
     	 * @param docId
     	 *            document id
     	 * @param principal
-...
     	 * more than one record exists, delete the existing records, consolidate the
     	 * permissions insert the new record.
+    	 *
     	 * @param xmlAccessList
     	 * @throws AccessException
     	 * @param xmlAccessList the access dao list
     	 */
     	private void cleanupXMLAccessForPrincipal(Vector<XMLAccessDAO> xmlAccessList) throws AccessException{
-...
+    	}
     	/**
     	 * Make sure for a given list of access DAOs that only one perm order
     	 * exists. It is assumed that all the DAOs are for the same doc
+    	 *
     	 * @param xmlAccessList
     	 * @throws PermOrderException
     	 *            the access dao list
     	 */
     	private void validateDocXMLAccessList(Vector<XMLAccessDAO> xmlAccessList) throws PermOrderException {
     		String permOrder = null;
-...
+    		}
+    	}
     	/**
     	 * Check that only one permOrder exists for each principal.
     	 * TODO add check that one of each permType exists as well
+    	 *
     	 * @param xmlAccessList
     	 *            the access dao list
     	 */
     	private void validatePrincipalXMLAccessList(Vector<XMLAccessDAO> xmlAccessList)
     			throws PermOrderException {

       private Logger logMetacat = Logger.getLogger(AccessControlForSingleFile.class);
       /**
        * Construct an instance of the AccessControlForSingleFile class.
        * @param myAccessNumber  the docid or docid with dev will be controlled
        */
       public AccessControlForSingleFile(String accessionNumber) throws AccessControlException
+      {
           //Get rid of dev if myaccessNumber has one;
     	  _docId = DocumentUtil.getDocIdFromString(accessionNumber);
           if (_docId == null || _docId.equals(""))
+          {
             throw new AccessControlException("AccessControlForSingleFile() - Accession number " +
             		"can't be null in constructor");
+          }
           logMetacat.debug("AccessControlForSingleFile() - docid: " + _docId);
         /**
     	 * Construct an instance of the AccessControlForSingleFile class.  This
     	 * instance will represent one file only.
+    	 *
     	 * @param myAccessNumber
     	 *            the docid or docid with dev will be controlled
     	 */
     	public AccessControlForSingleFile(String accessionNumber)
     			throws AccessControlException {
+      }
     		// Get rid of dev if myaccessNumber has one;
     		_docId = DocumentUtil.getDocIdFromString(accessionNumber);
     		if (_docId == null || _docId.equals("")) {
     			throw new AccessControlException("AccessControlForSingleFile() - Accession number "
     							+ "can't be null in constructor");
+    		}
     		logMetacat.debug("AccessControlForSingleFile() - docid: " + _docId);
+    	}
       	/**
     	 * Insert a single access record into the database based on access DAO
-...
     	 * Insert a single access record into the database.
+    	 *
     	 * @param principalName
     	 *            the principal credentials
     	 * @param permission
     	 *            the permission
     	 * @param permType
     	 *            the permission type
     	 * @param permOrder
     	 * @throws AccessControlException
     	 *            the permission order
     	 */
     	public void insertPermissions(String principalName, Long permission, String permType, String permOrder)
     			throws AccessControlException, PermOrderException {
-...
     	 *            returned by the getdocumentinfo action in metacat.
     	 */
     	public void insertPermissions(String accessBlock) throws AccessControlException {
     		try {
     		try {
     			// use DocInfoHandler to parse the access section into DAO objects
     			XMLReader parser = null;
     			DocInfoHandler docInfoHandler = new DocInfoHandler(_docId);
     			ContentHandler chandler = docInfoHandler;
-...
     			parser.parse(new InputSource(new StringReader(accessBlock)));
     			XMLAccessAccess xmlAccessAccess = new XMLAccessAccess();
     			// replace all access on the document
     	        Vector<XMLAccessDAO> accessControlList = docInfoHandler.getAccessControlList();
     	        xmlAccessAccess.replaceAccess(_docId, accessControlList);
-...
+    	}
     	/**
     	 * Check if access control comination for
     	 * docid/principal/permission/permorder/permtype already exists.
+    	 *
     	 * @param xmlAccessDAO
     	 *            the dao object holding the access we want to check for.
     	 * @return true if the Access Control for this file already exists in the DB
     	 * @throws SQLException
     	 */
     	public boolean accessControlExists(XMLAccessDAO xmlAccessDAO) throws AccessControlException {
     		boolean exists = false;
-...
     	 * or Group should have permissions for reading access control information
     	 * for a document specified by
+    	 *
     	 * @docid.
     	 * @param docid
     	 *            document identifier which acl info to get
     	 * @param user
     	 *            name of user connected to Metacat system
     	 * @param groups
-...
     		boolean hasPermission = false;
     		try {
     			hasPermission = isOwned(_docId, user);
     			hasPermission = isOwned(user);
     			if (!hasPermission) {
     				PermissionController controller = new PermissionController(_docId);
     				hasPermission =
     					controller.hasPermission(user, groups, READSTRING);
+    			}
     			// if the user has permissions, get the access dao list for this doc and return
     			// it as a string.  Otherwise, get the string for an empty access dao list
     			// (which will return the access section with no allow or deny sections)
     			if (hasPermission) {
     				// Get a list of all access dao objects for this docid
     				XMLAccessAccess xmlAccessAccess = new XMLAccessAccess();
-...
+    		}
+    	}
     	/**
     	 * Get the access xml for all access on this docid
+    	 *
     	 * @return string representation of access
     	 */
     	public String getAccessString() throws AccessControlException {
     		Vector<XMLAccessDAO> xmlAccessDAOList = null;
-...
     		return getAccessString(xmlAccessDAOList);
+    	}
     	/**
     	 * Put together an xml representation of the objects in a given access dao list
     	 * @param xmlAccessDAOList list of xml access DAO objects
     	 * @return string representation of access
     	 */
     	public String getAccessString(Vector<XMLAccessDAO> xmlAccessDAOList) throws AccessControlException {
     		StringBuffer output = new StringBuffer();
-...
     		output.append(">\n");
     		if (xmlAccessDAOList.size() > 0) {
     			// Since there should only be one permission order allowed per document,
     			// we can just grab the order off of the first xml access dao object
     			permOrder = xmlAccessDAOList.get(0).getPermOrder();
+    		}
     		for (XMLAccessDAO xmlAccessDAO : xmlAccessDAOList) {
     			principal = xmlAccessDAO.getPrincipalName();
     			permission = xmlAccessDAO.getPermission().intValue();
-...
     		return output.toString();
+    	}
     	/* Check if @user is owner of @docid from db conn. */
     	private boolean isOwned(String docid, String user) throws SQLException {
     	/**
     	 * check if the docid represented in this class is owned by the user
+    	 *
     	 * @param user
     	 *            the user credentials
     	 * @return true if doc is owned by user, false otherwise
     	 */
     	private boolean isOwned(String user) throws SQLException {
     		PreparedStatement pstmt = null;
     		DBConnection conn = null;
     		int serialNumber = -1;
-...
     			serialNumber = conn.getCheckOutSerialNumber();
     			pstmt = conn.prepareStatement("SELECT 'x' FROM xml_documents "
     					+ "WHERE docid = ? " + "AND user_owner = ?");
     			pstmt.setString(1, docid);
     			pstmt.setString(1, _docId);
     			pstmt.setString(2, user);
     			pstmt.execute();
     			ResultSet rs = pstmt.getResultSet();

     /**
      *  '$RCSfile$'
      *    Purpose: An Exception thrown when an error occurs because an
      *             AccessionNumber was invalid or used incorrectly
      *  Copyright: 2008 Regents of the University of California and the
      *    Purpose: An Exception thrown when an error occurs because of a
      *             permission order conflict
      *  Copyright: 2009 Regents of the University of California and the
      *             National Center for Ecological Analysis and Synthesis
      *    Authors: Michael Daigle
+     *
-...
     /**
      * Exception thrown when an error occurs in a configuration administrative
      * class
      * Exception thrown when an error occurs with a permission order
      */
     public class PermOrderException extends BaseException {

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 5115

Added by daigle over 14 years ago