com.sun.faces.taglib.jsf_core.CoreValidator Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.faces.taglib.jsf_core;
import com.sun.faces.taglib.FacesValidator;
import com.sun.faces.taglib.ValidatorInfo;
import org.xml.sax.Attributes;
import org.xml.sax.helpers.DefaultHandler;
/**
* A TagLibrary Validator class to allow a TLD to mandate that
* JSF tag must have an id if it is a child or sibling of a JSTL
* conditional or iteration tag
*
* @author Justyna Horwat
*/
public class CoreValidator extends FacesValidator {
//*********************************************************************
// Constants
//*********************************************************************
// Validation and configuration state (protected)
private ValidatorInfo validatorInfo;
private IdTagParserImpl idTagParser;
private CoreTagParserImpl coreTagParser;
//*********************************************************************
// Constructor and lifecycle management
/**
* CoreValidator constructor
*/
public CoreValidator() {
super();
init();
}
/**
* Initialize state
*/
protected void init() {
super.init();
failed = false;
validatorInfo = new ValidatorInfo();
idTagParser = new IdTagParserImpl();
idTagParser.setValidatorInfo(validatorInfo);
coreTagParser = new CoreTagParserImpl();
coreTagParser.setValidatorInfo(validatorInfo);
}
/**
* Release and re-initialize state
*/
public void release() {
super.release();
init();
}
//
// Superclass overrides.
//
/**
* Get the validator handler
*/
protected DefaultHandler getSAXHandler() {
if (java.beans.Beans.isDesignTime()) {
return null;
}
return new CoreValidatorHandler();
}
/**
* Create failure message from any failed validations
*
* @param prefix Tag library prefix
* @param uri Tag library uri
*/
protected String getFailureMessage(String prefix, String uri) {
// we should only get called if this Validator failed
StringBuffer result = new StringBuffer();
if (idTagParser.getMessage() != null) {
result.append(idTagParser.getMessage());
}
if (coreTagParser.getMessage() != null) {
result.append(coreTagParser.getMessage());
}
return result.toString();
}
//*********************************************************************
// SAX handler
/**
* The handler that provides the base of the TLV implementation.
*/
private class CoreValidatorHandler extends DefaultHandler {
/**
* Parse the starting element. If it is a specific JSTL tag
* make sure that the nested JSF tags have IDs.
*
* @param ns Element name space.
* @param ln Element local name.
* @param qn Element QName.
* @param attrs Element's Attribute list.
*/
public void startElement(String ns,
String ln,
String qn,
Attributes attrs) {
maybeSnagTLPrefixes(qn, attrs);
validatorInfo.setNameSpace(ns);
validatorInfo.setLocalName(ln);
validatorInfo.setQName(qn);
validatorInfo.setAttributes(attrs);
validatorInfo.setValidator(CoreValidator.this);
idTagParser.parseStartElement();
if (idTagParser.hasFailed()) {
failed = true;
}
coreTagParser.parseStartElement();
if (coreTagParser.hasFailed()) {
failed = true;
}
}
/**
* Parse the ending element. If it is a specific JSTL tag
* make sure that the nested count is decreased.
*
* @param ns Element name space.
* @param ln Element local name.
* @param qn Element QName.
*/
public void endElement(String ns, String ln, String qn) {
validatorInfo.setNameSpace(ns);
validatorInfo.setLocalName(ln);
validatorInfo.setQName(qn);
idTagParser.parseEndElement();
coreTagParser.parseEndElement();
}
}
}