## Uses of Class
edu.ucsb.nceas.metacat.McdbException

- Packages that use McdbException
  Package | Description
  --- | ---
  edu.ucsb.nceas.metacat |
  edu.ucsb.nceas.metacat.accesscontrol |
  edu.ucsb.nceas.metacat.dataone |
  edu.ucsb.nceas.metacat.replication |

- - ### Uses of McdbException in edu.ucsb.nceas.metacat

    Subclasses of McdbException in edu.ucsb.nceas.metacat
    Modifier and Type | Class and Description
    --- | ---
    `class` | `McdbDocNotFoundException` Exception thrown when an error occurs because a document with a given ID could not be found in the metacat database.

    Methods in edu.ucsb.nceas.metacat that throw McdbException
    Modifier and Type | Method and Description
    --- | ---
    `void` | AssociateAccessPolicy.`associateAccess()` Associate the access policy of dataset to the docid which the data set id mapped
    `void` | DocumentImpl.`buildIndex()` Build the index records for this document.
    `boolean` | Eml200SAXHandler.`compareInlineDataFiles(java.lang.String oldFileName, java.lang.String newFileName)`
    `static void` | DocumentImpl.`deleteFromFileSystem(java.lang.String accNumber, boolean isXml)` Deletes a doc or data file from the filesystem using the accession number.
    `static java.util.Hashtable<java.lang.String,java.lang.String>` | PermissionController.`getUnReadableInlineDataIdList(java.lang.String docid, java.lang.String user, java.lang.String[] groups)` A static method to get Hashtable which cointains a inlinedata object list that user can't read it.
    `java.util.zip.ZipOutputStream` | DBQuery.`getZippedPackage(java.lang.String docIdString, javax.servlet.ServletOutputStream out, java.lang.String user, java.lang.String[] groups, java.lang.String passWord)` put a data packadge into a zip output stream
    `boolean` | PermissionController.`hasPermissionForSubTreeNode(java.lang.String user, java.lang.String[] groups, java.lang.String myPermission, long nodeId)` The method to determine of a node can be access by a user just by subtree access control
    `static boolean` | DocumentImpl.`hasReadPermission(java.lang.String user, java.lang.String[] groups, java.lang.String docId)` Check for "READ" permission base on docid, user and group
    `java.util.Hashtable` | PermissionController.`hasUnaccessableSubTree(java.lang.String user, java.lang.String[] groups, java.lang.String myPermission)` This method will return a hasTable of subtree which user doesn't has the permssion to access
    `static java.io.InputStream` | MetacatHandler.`read(java.lang.String docid)` Read a document from metacat and return the InputStream.
    `static java.io.InputStream` | MetacatHandler.`read(java.lang.String docid, java.lang.String dataType)` Read a document from metacat and return the InputStream.
    `java.io.InputStream` | DocumentImpl.`readFromFileSystem(java.io.OutputStream out, java.lang.String user, java.lang.String[] groups, java.lang.String documentPath)` Read the XML document from the file system and write to a Writer.
    `void` | MetacatHandler.`readFromMetacat(java.lang.String ipAddress, java.lang.String userAgent, javax.servlet.http.HttpServletResponse response, java.io.OutputStream out, java.lang.String docid, java.lang.String qformat, java.lang.String user, java.lang.String[] groups, boolean withInlineData, java.util.Hashtable<java.lang.String,java.lang.String[]> params)` read metadata or data from Metacat
    `static java.io.Reader` | Eml200SAXHandler.`readInlineDataFromFileSystem(java.lang.String fileName, java.lang.String encoding)`
    `java.lang.String` | DocumentImpl.`readUsingSlowAlgorithm()` Get a text representation of the XML document as a string This older algorithm uses a recursive tree of Objects to represent the nodes of the tree.
    `java.io.InputStream` | DocumentImpl.`toXml(java.io.OutputStream out, java.lang.String user, java.lang.String[] groups, boolean withInLineData)` Print a text representation of the XML document to a Writer
    `void` | DocumentImpl.`toXmlFromDb(java.io.OutputStream outputStream, java.lang.String user, java.lang.String[] groups, boolean withInLineData)` Print a text representation of the XML document to a Writer

    Constructors in edu.ucsb.nceas.metacat that throw McdbException
    Constructor and Description
    `DocumentImpl(java.lang.String docid)` Constructor, creates document from database connection, used for reading the document
    `DocumentImpl(java.lang.String accNum, boolean readNodes)` Constructor used to create a document and read the document information from the database.
    `PermissionController(java.lang.String myDocid)` Constructor for PermissionController
    `RelationHandler(java.lang.String docid, java.lang.String doctype, DBConnection conn, edu.ucsb.nceas.utilities.triple.TripleCollection list)` Constructor for this class.

  - ### Uses of McdbException in edu.ucsb.nceas.metacat.accesscontrol

    Constructors in edu.ucsb.nceas.metacat.accesscontrol that throw McdbException
    Constructor and Description
    `AccessControlList(DBConnection conn, java.lang.String aclid, int rev, java.lang.String user, java.lang.String[] groups, int serverCode)` Construct an instance of the AccessControlList class.

  - ### Uses of McdbException in edu.ucsb.nceas.metacat.dataone

    Methods in edu.ucsb.nceas.metacat.dataone that throw McdbException
    Modifier and Type | Method and Description
    --- | ---
    `static org.dataone.service.types.v2.SystemMetadata` | SystemMetadataFactory.`createSystemMetadata(boolean indexDataFile, java.lang.String localId, boolean includeORE, boolean downloadData)` Creates a system metadata object for insertion into metacat
    `static org.dataone.service.types.v2.SystemMetadata` | SystemMetadataFactory.`createSystemMetadata(java.lang.String localId, boolean includeORE, boolean downloadData)` Create a system metadata object for insertion into metacat
    `static void` | SystemMetadataFactory.`generateSystemMetadata(java.util.List<java.lang.String> idList, boolean includeOre, boolean downloadData)` Generate SystemMetadata for any object in the object store that does not already have it.

  - ### Uses of McdbException in edu.ucsb.nceas.metacat.replication

    Methods in edu.ucsb.nceas.metacat.replication that throw McdbException
    Modifier and Type | Method and Description
    --- | ---
    `static java.lang.String` | ReplicationService.`getDocumentInfo(java.lang.String docid)` Gets a docInfo XML snippet for the replication API
    `static java.util.Hashtable<java.lang.String,java.lang.String>` | ReplicationService.`getDocumentInfoMap(java.lang.String docid)`

Copyright © 2023 Regents of the University of California. All Rights Reserved.