uPortal 2.4.1
API Documentation

org.jasig.portal.car
Class ProcessIfTagHandler

java.lang.Object
  extended byorg.xml.sax.helpers.DefaultHandler
      extended byorg.jasig.portal.car.ProcessIfTagHandler
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class ProcessIfTagHandler
extends org.xml.sax.helpers.DefaultHandler

Handles a "processIf" tag looking for the following attributes and blocking SAX events from reaching nested tags if the specified requirements are not met.

  fname = the functional name whose version is to be checked
  version = value is one of lessThan, greaterThan, lessThanOrEqual,
    greaterThanOrEqual, equalTo, or notEqualTo.
  major = the revision level major part
  minor = the revision level minor part
  micro = the revision level micro part
  setMajor = optional, the new revision level major part
  setMinor = optional, the new revision level minor part
  setMicro = optional, the new revision level micro part
 
The contents of the processIf tag are only processed if the version of the specified fname matches the requirements as specified in the version, major, minor, and micro attributes. If the setMajor, setMinor, and setMicro attributes are specified then and additional test is performed to determine if processing will occur. This test involves attempting to set the version of the fname to that specified. If unable to then processing will be skipped for this block. This is done to allow the same CAR to be deployed on all servers in a multi-server deployment but only have on of the servers perform the processing of the block and affect the database. There is no limit on the number of processIf blocks that can occur in a deployment descriptor. All other nested tags are supported within the processIf tag. The processIf tag can not be nested inside of itself.

Version:
$Revision: 1.1 $
Author:
Mark Boyd

Method Summary
 void characters(char[] ch, int start, int length)
           
 void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
           
 void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
           
 
Methods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

uPortal 2.4.1
API Documentation