/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. 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.html
* or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [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.enterprise.tools.verifier.tests.web;
import com.sun.enterprise.tools.verifier.tests.TagLibTest;
import com.sun.enterprise.tools.verifier.tests.ComponentNameConstructor;
import com.sun.enterprise.tools.verifier.Result;
import com.sun.enterprise.tools.verifier.Context;
import com.sun.enterprise.tools.verifier.TagLibDescriptor;
import com.sun.enterprise.tools.verifier.web.FunctionDescriptor;
import com.sun.enterprise.deployment.WebBundleDescriptor;
/**
* The function-signature must be specified using a fully-qualified return type
* followed by the method name, followed by the fully-qualified argument types
* in parenthesis, separated by commas.
*
* @author Sudipto Ghosh
*/
public class TaglibFunctionSignatureIsValid extends TagLibTest implements WebCheck {
public Result check(WebBundleDescriptor descriptor) {
ComponentNameConstructor compName =
getVerifierContext().getComponentNameConstructor();
Result result = getInitializedResult();
Context context = getVerifierContext();
TagLibDescriptor tlds[] = context.getTagLibDescriptors();
FunctionDescriptor[] fnDesc = null;
if (tlds == null) {
addGoodDetails(result, compName);
result.passed(smh.getLocalString
(getClass().getName() + ".passed",
"No tag lib files are specified"));
return result;
}
for (TagLibDescriptor tld : tlds) {
if (tld.getSpecVersion().compareTo("2.0") >= 0) {
fnDesc = tld.getFunctionDescriptors();
if (fnDesc != null)
for (FunctionDescriptor fd : fnDesc)
checkSignature(result, fd, tld, compName);
}
}
if (result.getStatus() != Result.FAILED) {
addGoodDetails(result, compName);
result.passed(smh.getLocalString(getClass()
.getName() +
".passed", "function-signature element of the tag lib " +
"descriptor are properly defined."));
}
return result;
}
/**
* Checks the validity of the signature string contained in function-signature
* object
* @param result
* @param fnDesc
* @param tld
* @param compName
*/
private void checkSignature(Result result, FunctionDescriptor fnDesc,
TagLibDescriptor tld,
ComponentNameConstructor compName) {
String signature = fnDesc.getFunctionSignature();
ClassLoader cl = getVerifierContext().getClassLoader();
String retType = getRetType(signature);
String[] parameter = getParameters(signature);
if (checkIfPrimitive(retType) == null && !checkValidRType(retType)) {
addErrorDetails(result, compName);
result.failed(smh.getLocalString(getClass().getName() +
".failed",
"ERROR: In the tld [ {0} ] return type is not specified correctly in " +
"this signature [ {1} ]",
new Object[]{tld.getUri(), signature}));
}
//parameter is a basic type or fully qualified Type
if(!checkParamTypeClass(parameter, cl)) {
addErrorDetails(result, compName);
result.failed(smh.getLocalString(getClass().getName() +
".failed1",
"ERROR: In the tld [ {0} ] parameters are not specified correctly in " +
"this signature [ {1} ]",
new Object[]{tld.getUri(), signature}));
}
}
/**
*
* @param retType
* @return true if the return type is specified correctly, false otherwise
*/
private boolean checkValidRType(String retType) {
boolean valid = true;
try {
Class.forName(retType);
} catch (ClassNotFoundException e) {
return valid=false;
}
return valid;
}
/**
* return true, if all the parameters specified by par String[] are correctly
* specified, false otherwise.
* @param par
* @param cl
* @return
*/
private boolean checkParamTypeClass(String[] par, ClassLoader cl) {
for(String s : par) {
Class c = checkIfPrimitive(s);
if (c == null)
try {
c = Class.forName(s, false, cl);
} catch (ClassNotFoundException e) {
return false;
}
}
return true;
}
}