FileDocCategorySizeDatePackage
GenericValidator.javaAPI DocGlassfish v2 API18669Fri May 04 22:24:36 BST 2007com.sun.enterprise.config.serverbeans.validation

GenericValidator

public class GenericValidator extends Object implements DomainCheck
Class which validates all attributes in the validation descriptor xml file. All custom tests use this as the base class
author
Srinivas Krishnan
version
2.0

Fields Summary
protected static final Logger
_logger
protected com.sun.enterprise.util.LocalStringManagerImpl
smh
ValidationDescriptor
desc
Constructors Summary
public GenericValidator(ValidationDescriptor desc)

    
       
        this.desc = desc;
//        try {
            StringManagerHelper.setLocalStringsManager(DomainXmlVerifier.class);
            smh = StringManagerHelper.getLocalStringsManager();
//        }
//        catch (ClassNotFoundException e) {
//           _logger.log(Level.FINE, "domainxmlverifier.class_notfound_exception", e);
//        }
Methods Summary
protected static java.lang.StringgetBeanElementName(com.sun.enterprise.config.ConfigBean bean)

        String[] tokens = XPathHelper.extractTokens(bean.getAbsoluteXPath(""));
        if(tokens.length<1)
            return null;
        String last = tokens[tokens.length-1];
        int idx = last.indexOf('[");
        if(idx>0)
            return last.substring(0, idx);
        else
            return last;
static java.lang.StringgetConfigElementPrintName(ValidationContext valCtx, java.lang.String xpath, boolean bIncludingKey, boolean bReplaceRefByParentElem)

      return valCtx.validationDescriptor.domainMgr.getMBeanRegistry().
               getConfigElementPrintName(xpath, bIncludingKey, bReplaceRefByParentElem);
java.lang.StringgetConfigElementPrintName(java.lang.String xpath, boolean bIncludingKey, boolean bReplaceRefByParentElem)

      return desc.domainMgr.getMBeanRegistry().
               getConfigElementPrintName(xpath, bIncludingKey, bReplaceRefByParentElem);
protected static java.lang.StringgetFutureXPath(com.sun.enterprise.config.ConfigBean childBean, com.sun.enterprise.config.ConfigBean parentBean)

        String[] tokens = XPathHelper.extractTokens(childBean.getAbsoluteXPath(""));
        if(parentBean==null) //root
        {
            return "/" + tokens[tokens.length-1];
        }
        return (parentBean.getXPath() + "/" + tokens[tokens.length-1]);
static java.lang.StringgetTargetElementPrintName(ValidationContext valCtx, boolean bIncludingKey, boolean bReplaceRefByParentElem)

        ConfigBean targetBean = valCtx.getTargetBean();
        if(targetBean==null)
            return null;
        ConfigBean parentBean = valCtx.getParentBean();
        return getConfigElementPrintName( valCtx, 
                getFutureXPath(targetBean, parentBean),
                bIncludingKey, bReplaceRefByParentElem);
public ValidationContextinitialize(com.sun.enterprise.config.ConfigContextEvent cce)

        ValidationContext valCtx = new ValidationContext(new Result(), cce.getObject(), cce.getClassObject(), 
                                        cce.getBeanName(), cce.getConfigContext(), cce.getName(), cce.getChoice(), 
                                        desc.getKey(), smh, desc);
        String key = desc.getKey();
        String element = desc.getElementName();
        if(valCtx.value instanceof ConfigBean) {
            valCtx.result.setAssertion(element);
            try {
                valCtx.result.setTestName(smh.getLocalString(GenericValidator.class.getName() + ".Elementkeyvalue",
                "{0} = {1}", new Object[]{key, ((ConfigBean)valCtx.value).getAttributeValue(key) }));
            } catch(Exception e) {
                _logger.log(Level.FINE, "domainxmlverifier.keynotfound", e);
            }
        }
        valCtx.result.setStatus(0);
        //set operation name
        if(!valCtx.isVALIDATE())
        {
            String elementName = getTargetElementPrintName(valCtx, true, false);
            String strLocalTag;
            String strDefault;
            if(valCtx.isADD() || valCtx.isSET()) {
                strLocalTag = "add_operation_descr";
                strDefault = "Creation config element for {0}";
            } else if(valCtx.isDELETE()) {
                strLocalTag = "delete_operation_descr";
                strDefault = "Deletion of config element for {0}";
            } else {
                strLocalTag = "update_operation_descr";
                strDefault = "Update of config element for {0}";
            }
            valCtx.result.setOperationPrintName(valCtx.smh.getLocalString(
                   strLocalTag, strDefault, new Object[] {elementName}));
        }
        return valCtx;
public static voidreportValidationError(ValidationContext valCtx, java.lang.String msgNameSuffix, java.lang.String defaultMsg, java.lang.Object[] values)
reports validation error

        ReportHelper.reportValidationError(valCtx, 
                        msgNameSuffix, defaultMsg, values);
public Resultvalidate(com.sun.enterprise.config.ConfigContextEvent cce)

        ValidationContext valCtx = initialize(cce);
        _logger.log(Level.CONFIG, "GenericValidator processing choice: "+valCtx.choice);
        validate(valCtx);
                
        return valCtx.result;
public voidvalidate(ValidationContext valCtx)

        
        //validate element (without attributes) 
        validateElement(valCtx);
        
        //ask parent to confirm change   
        ConfigBean parentBean = valCtx.getParentBean();
        if(parentBean!=null)
        {
           //validate changes by Parent 
           GenericValidator parentValidator = 
                   desc.domainMgr.findConfigBeanValidator((ConfigBean)parentBean);
           if(parentValidator!=null)
           {
               parentValidator.validateAsParent(valCtx);
           }
        }
        
        Vector attrs = desc.getAttributes();
        //Attributes validation    
        for(int i=0; i<attrs.size(); i++) 
        {
            try {
                validateAttribute((AttrType) attrs.get(i), valCtx);
            } catch(IllegalArgumentException e) {
                valCtx.result.failed(e.getMessage());
            } catch(Exception e) {
                _logger.log(Level.WARNING, "domainxmlverifier.errorinvokingmethod", e);
            }
        }
public voidvalidateAsParent(ValidationContext valCtx)

     if(valCtx.isADD() || valCtx.isSET()) 
     {
        ConfigBean newChildBean = (ConfigBean)valCtx.value;
        String newChildBeanName = getBeanElementName(newChildBean);
        ConfigBean parentBean = (ConfigBean)valCtx.classObject;

        String[] names = desc.exclusiveChildren;
        //first, let's be sure that newChildBean in exclusive list
        boolean bNewChildIsInList = false;
        if(names!=null)
        {
            for(int i=0; i<names.length; i++)
            {
               if(newChildBeanName.equals(names[i]))
               {
                   bNewChildIsInList = true;
                   break;
               }
            }
        }
        //now find out if any othjers are there too
        if(bNewChildIsInList)
        {
            for(int i=0; i<names.length; i++)
            {
                String childName = names[i];
                if(childName.equals(newChildBeanName))
                    continue;
                childName = XPathHelper.convertName(childName);
                ConfigBean[] beans = parentBean.getChildBeansByName(childName);
                if (beans!=null && beans.length>0)
                {
                    String printParentName = getConfigElementPrintName(
                        parentBean.getXPath(), false, false);
                    valCtx.result.failed(valCtx.smh.getLocalString(
                            GenericValidator.class.getName() + ".childrenCanExistTogether",
                            "{0} can not contain both sub-elements {1} and {2} in the same time.", 
                            new Object[] {printParentName, 
                                    newChildBeanName, names[i]}));
                }
            }
        }
     }
     else if(valCtx.isDELETE())
     {
        //Check for existence of required sub-elements
        ConfigBean childBean = (ConfigBean)valCtx.value;
        ConfigBean parentBean = (ConfigBean)valCtx.classObject;
        String childBeanName = XPathHelper.convertName(getBeanElementName(childBean));
        ConfigBean[] beans = parentBean.getChildBeansByName(childBeanName);
        if (beans!=null && beans.length==1)
        {  //LAST ELEM DELETION
            ValidationDescriptor parentDescr = desc;
            String[] names = null;
            if(parentDescr!=null)
                names = parentDescr.requiredChildren;
            String compareTo = getBeanElementName(childBean);
            String compareTo2 = compareTo+'*";
            for(int i=0; names!=null && i<names.length; i++)
            {
                if(compareTo.equals(names[i]))
                {
                    String printParentName = getConfigElementPrintName(
                        parentBean.getXPath(), false, false);
                    String printChildName = getConfigElementPrintName(
                        childBean.getXPath(), false, false);
                    valCtx.result.failed(valCtx.smh.getLocalString(
                        GenericValidator.class.getName() + ".requiredElemDelete",
                        "Required element {0} can not be deleted from {1}", 
                        new Object[] {printChildName, printParentName}));
                    break;
                }
                else if(compareTo2.equals(names[i]))
                {
                    String printParentName = getConfigElementPrintName(
                        parentBean.getXPath(), false, false);
                    String printChildName = getConfigElementPrintName(
                        childBean.getXPath(), false, false);
                    valCtx.result.failed(valCtx.smh.getLocalString(
                        GenericValidator.class.getName() + ".lastRequiredElemDelete",
                        "At least one required {0} should be present in {1}."+
                        " Deletion rejected.", 
                        new Object[] {printChildName, printParentName}));
                    break;
                }
            }
        }

     }
     
     if(valCtx.getTargetBean() instanceof ElementProperty)
        validatePropertyChanges(valCtx);
private voidvalidateAttribute(AttrType attr, ValidationContext valCtx)

        if(valCtx.choice == null)
            return;
        String attrName = attr.getName();
        Object value = null;
        ConfigBean ownerBean = null;
        if(valCtx.isADD() || valCtx.isVALIDATE() ||  valCtx.isSET() || valCtx.isDELETE()) 
        {
            ownerBean = (ConfigBean)valCtx.value;
            value = ((ConfigBean)valCtx.value).getAttributeValue(attrName);
            
        }
        else if(valCtx.isUPDATE())
        {
           if(attr.getName().equals(valCtx.name))
           {
                ownerBean = (ConfigBean)valCtx.classObject;
                value = valCtx.value;
//              _logger.log(Level.WARNING, "setting attribute: "+attr.getName()+" to: " +valCtx.value);
           }
        }

       
        if(ownerBean!=null /*&& value!=null*/)
        {
            //-----------set current validation state in valCtx
            valCtx.setAttrName(attrName);
            valCtx.attrValue = value;
            //valCtx.ownerBean = ownerBean;
            // and now - call attributes validation method for element
            validateAttribute(ownerBean, attr, value, valCtx);   
        }
public voidvalidateAttribute(com.sun.enterprise.config.ConfigBean ownerBean, AttrType attr, java.lang.Object value, ValidationContext valCtx)

        if (/*value!=null &&*/ !StaticTest.valueContainsTokenExpression((String) value))
        {
            //generic validation of attribute
            attr.validate(value, valCtx);
        }
public voidvalidateElement(ValidationContext valCtx)

     String key = desc.getKey();
     String element = desc.getElementName();
     if(valCtx.isADD() || valCtx.isSET()) 
     {
        ConfigBean thisBean = (ConfigBean)valCtx.value;
        ConfigBean parentBean = (ConfigBean)valCtx.classObject;
        String[] names = desc.requiredChildren;
        for(int i=0; names!=null && i<names.length; i++)
        {
            String childName = names[i];
            if(names[i].endsWith("*"))
                childName = names[i].substring(0, names[i].length()-1);
            childName = XPathHelper.convertName(childName);
            ConfigBean[] beans = thisBean.getChildBeansByName(childName);
            if (beans==null || beans.length==0)
            {
                if(names[i].endsWith("*"))
                {
                    String printParentName = getConfigElementPrintName(
                        getFutureXPath(thisBean, parentBean), false, false);
                    valCtx.result.failed(valCtx.smh.getLocalString(
                        GenericValidator.class.getName() + ".multipleRequiredElemAbsent",
                        "At least one required element {0} should be present in created {1}", 
                        new Object[] {names[i].substring(0, names[i].length()-1),
                                printParentName}));
                }
                else
                {
                    String printParentName = getConfigElementPrintName(
                        getFutureXPath(thisBean, parentBean), false, false);
                    valCtx.result.failed(valCtx.smh.getLocalString(
                        GenericValidator.class.getName() + ".requiredElemAbsent",
                        "Required element {0} should be present in created {1}", 
                        new Object[] {names[i], printParentName}));
                }
            }
        }
        names = desc.exclusiveChildren;
        String alreadyFound = null;
        for(int i=0; names!=null && i<names.length; i++)
        {
            String childName = names[i];
            childName = XPathHelper.convertName(childName);
            ConfigBean[] beans = thisBean.getChildBeansByName(childName);
            if (beans==null || beans.length==0)
                continue;
            if(alreadyFound==null)
            {
                alreadyFound = names[i];
            }
            else
            {
                String printParentName = getConfigElementPrintName(
                    getFutureXPath(thisBean, parentBean), false, false);
                valCtx.result.failed(valCtx.smh.getLocalString(
                        GenericValidator.class.getName() + ".childrenCanExistTogether",
                        "{0} can not contain both sub-elements {1} and {2} in the same time.", 
                        new Object[] {printParentName, alreadyFound, names[i]}));
            }
        }
     }
public voidvalidatePropertyChanges(ValidationContext valCtx)

       return;