Package edu.ucsb.nceas.metacat.accesscontrol

Class AccessControlList

java.lang.Object

org.xml.sax.helpers.DefaultHandler

edu.ucsb.nceas.metacat.accesscontrol.AccessControlList

All Implemented Interfaces:

edu.ucsb.nceas.utilities.access.AccessControlInterface, ContentHandler, DTDHandler, EntityResolver, ErrorHandler, LexicalHandler

public class AccessControlList
extends DefaultHandler
implements edu.ucsb.nceas.utilities.access.AccessControlInterface, LexicalHandler

A Class that loads eml-access.xml file containing ACL for a metadata document into relational DB. It extends DefaultHandler class to handle SAX parsing events when processing the XML stream.

Field Summary

Fields inherited from interface edu.ucsb.nceas.utilities.access.AccessControlInterface

ACCESS, ACLID, ALL, ALLOW, ALLOWFIRST, ALLSTRING, CHMOD, CHMODSTRING, DENY, DENYFIRST, ORDER, PERMISSION, PRINCIPAL, PUBLIC, READ, READSTRING, WRITE, WRITESTRING

Constructor Summary

Constructors

Constructor	Description
AccessControlList()

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)	Callback method used by the SAX Parser when the text sequences of an xml stream are detected.
void	comment(char[] ch, int start, int length)	SAX Handler that receives notification of comments in the DTD
void	endCDATA()	SAX Handler that receives notification of the end of CDATA sections
void	endDTD()	SAX Handler that receives notification of end of DTD
void	endElement(String uri, String localName, String qName)	Callback method used by the SAX Parser when the end tag of an element is detected.
void	endEntity(String name)	SAX Handler that receives notification of the end of entities.
String	getDocname()	Get the document name.
static int	intValue(String permission)
boolean	processingDTD()	Get the document processing state.
void	startCDATA()	SAX Handler that receives notification of the start of CDATA sections
void	startDocument()	Callback method used by the SAX Parser when beginning of the document
void	startDTD(String name, String publicId, String systemId)	SAX Handler that receives notification of DOCTYPE.
void	startElement(String uri, String localName, String qName, Attributes atts)	Callback method used by the SAX Parser when the start tag of an element is detected.
void	startEntity(String name)	SAX Handler that receives notification of the start of entities.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Constructor Details

AccessControlList

public AccessControlList()

Method Details

startDocument

public void startDocument()
                   throws SAXException

Callback method used by the SAX Parser when beginning of the document

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes atts)
                  throws SAXException

Callback method used by the SAX Parser when the start tag of an element is detected. Used in this context to parse and store the acl information in class variables.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Callback method used by the SAX Parser when the text sequences of an xml stream are detected. Used in this context to parse and store the acl information in class variables.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String qName)
                throws SAXException

Callback method used by the SAX Parser when the end tag of an element is detected. Used in this context to parse and store the acl information in class variables.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

startDTD

public void startDTD(String name,
 String publicId,
 String systemId)
              throws SAXException

SAX Handler that receives notification of DOCTYPE. Sets the DTD.

Specified by:

startDTD in interface LexicalHandler

Parameters:

name - name of the DTD

publicId - Public Identifier of the DTD

systemId - System Identifier of the DTD

Throws:

SAXException

endDTD

public void endDTD()
            throws SAXException

SAX Handler that receives notification of end of DTD

Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException

startEntity

public void startEntity(String name)
                 throws SAXException

SAX Handler that receives notification of the start of entities.

Specified by:

startEntity in interface LexicalHandler

Parameters:

name - name of the entity

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

SAX Handler that receives notification of the end of entities.

Specified by:

endEntity in interface LexicalHandler

Parameters:

name - name of the entity

Throws:

SAXException

getDocname

public String getDocname()

Get the document name.

processingDTD

public boolean processingDTD()

Get the document processing state.

intValue

public static int intValue(String permission)

comment

public void comment(char[] ch,
 int start,
 int length)
             throws SAXException

SAX Handler that receives notification of comments in the DTD

Specified by:

comment in interface LexicalHandler

Throws:

SAXException

startCDATA

public void startCDATA()

SAX Handler that receives notification of the start of CDATA sections

Specified by:

startCDATA in interface LexicalHandler

endCDATA

public void endCDATA()

SAX Handler that receives notification of the end of CDATA sections

Specified by:

endCDATA in interface LexicalHandler