/*
* 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.ias;
import java.util.*;
import com.sun.enterprise.deployment.*;
import com.sun.enterprise.tools.verifier.*;
import com.sun.enterprise.tools.verifier.tests.*;
import com.sun.enterprise.deployment.ResourceReferenceDescriptor;
import com.sun.enterprise.deployment.WebBundleDescriptor;
import com.sun.enterprise.tools.verifier.tests.web.*;
import com.sun.enterprise.tools.common.dd.ResourceRef;
import com.sun.enterprise.tools.common.dd.webapp.*;
import com.sun.enterprise.tools.common.dd.DefaultResourcePrincipal;
//<addition author="irfan@sun.com" [bug/rfe]-id="4711198" >
/* Changed the result messages to reflect consistency between the result messages generated
* for the EJB test cases for SunONE specific deployment descriptors*/
//</addition>
public class ASResourceRefName extends WebTest implements WebCheck {
public Result check(WebBundleDescriptor descriptor) {
String resrefName;
Result result = getInitializedResult();
WebComponentNameConstructor compName = new WebComponentNameConstructor(descriptor);
//Start Bugid:4703107
DefaultResourcePrincipal defPrincipal;
boolean oneWarning = false;
//End Bugid:4703107
String jndiName;
boolean oneFailed = false;
boolean notApp = false;
ResourceRef[] resRefs = descriptor.getIasWebApp().getResourceRef();
//System.out.println(">>>>>>>>>>>>checking for res " +resRefs);
if (resRefs.length > 0) {
boolean isValidResRefName;
for (int rep=0; rep<resRefs.length; rep++ ) {
isValidResRefName=false;
resrefName = resRefs[rep].getResRefName();
jndiName = resRefs[rep].getJndiName();
//Start Bugid:4703107
defPrincipal = resRefs[rep].getDefaultResourcePrincipal();
//End Bugid:4703107
//System.out.println("checking for res ref : "+ resrefName+" jndiname : "+ jndiName);
if (validResRefName(resrefName,descriptor)) {
isValidResRefName=true;
result.passed(smh.getLocalString
(getClass().getName() + ".passed",
"PASSED [AS-WEB sun-web-app] resource-ref name [ {0} ] properly defined in the war file.",
new Object[] {resrefName}));
} else {
if (!oneFailed)
oneFailed = true;
result.failed(smh.getLocalString
(getClass().getName() + ".failed",
"FAILED [AS-WEB sun-web-app] resource-ref name [ {0} ] is not valid, either empty or not defined in web.xml.",
new Object[] {resrefName}));
}
if (isValidResRefName && validJndiName(jndiName, resrefName,descriptor)){
result.passed(smh.getLocalString
(getClass().getName() + ".passed1",
"PASSED [AS-WEB resource-ref] jndi-name [ {0} ] properly defined in the war file.",
new Object[] {jndiName}));
} else {
if (!oneFailed)
oneFailed = true;
result.failed(smh.getLocalString
(getClass().getName() + ".failed1",
"FAILED [AS-WEB resource-ref] jndi-name [ {0} ] is not valid, either empty or not starts according to its resource ref type entry defined in web.xml.",
new Object[] {jndiName}));
}
//Start Bugid:4703107
if(isValidResRefName){
if(defPrincipal != null){
String defaultname;
String defaultpassword;
boolean defResourcePrincipalValid = true;
defaultname = defPrincipal.getName();
defaultpassword = defPrincipal.getPassword();
if((defaultname == null)||(defaultname.length() == 0)){
oneWarning = true;
defResourcePrincipalValid = false;
result.warning(smh.getLocalString
(getClass().getName() + ".warning1",
"WARNING [AS-WEB resource-ref] name field in DefaultResourcePrincipal of ResourceRef [ {0} ] is not specified or is an empty string.",
new Object[] {resrefName}));
}
if((defaultpassword == null)||(defaultpassword.length() == 0)){
oneWarning = true;
defResourcePrincipalValid = false;
result.warning(smh.getLocalString
(getClass().getName() + ".warning2",
"WARNING [AS-WEB resource-ref] password field in DefaultResourcePrincipal of ResourceRef [ {0} ] is not specified or is an empty string.",
new Object[] {resrefName}));
}
if(defResourcePrincipalValid){
result.passed(smh.getLocalString
(getClass().getName() + ".passed3",
"PASSED [AS-WEB resource-ref] DefaultResourcePrincipal of ResourceRef [ {0} ] properly defined",
new Object[] {resrefName}));
}
}
}
//End Bugid:4703107
}
} else {
//System.out.println("There are no resource references defined within the ias-web archive");
notApp = true;
result.notApplicable(smh.getLocalString
(getClass().getName() + ".notApplicable",
"NOT APPLICABLE [AS-WEB sun-web-app] resource-ref element not defined in the web archive [ {0} ].",
new Object[] {descriptor.getName()}));
}
if (oneFailed) {
result.setStatus(Result.FAILED);
//Start Bugid:4703107
} else if(oneWarning) {
result.setStatus(Result.WARNING);
//End Bugid:4703107
} else if(notApp) {
result.setStatus(Result.NOT_APPLICABLE);
}else {
result.setStatus(Result.PASSED);
result.passed
(smh.getLocalString
(getClass().getName() + ".passed2",
"PASSED [AS-WEB sun-web-app] resource-ref element(s) are valid within the web archive [ {0} ] .",
new Object[] {descriptor.getName()} ));
}
return result;
}
boolean validResRefName(String name,WebBundleDescriptor descriptor){
boolean valid =true;
if(name !=null && name.length()!=0) {
try{
descriptor.getResourceReferenceByName(name);
}
catch(IllegalArgumentException e){
valid=false;
}
} else{
valid=false;
}
return valid;
}
boolean validJndiName(String refJndiName, String refName,WebBundleDescriptor descriptor){
boolean valid =true;
ResourceReferenceDescriptor resDesc;
if(refJndiName !=null && refJndiName.length()!=0) {
//descriptor.getResourceReferenceByName(name);
resDesc = descriptor.getResourceReferenceByName(refName);
String type = resDesc.getType();
if(type.indexOf("javax.jms")>-1) //jms resource
{
if(!refJndiName.startsWith("jms/"))
valid=false;
}
else if(type.indexOf("javax.sql")>-1) //jdbc resource
{
if(!refJndiName.startsWith("jdbc/"))
valid=false;
}
else if(type.indexOf("javax.net")>-1) //url resource
{
if(!refJndiName.startsWith("http://"))//FIX should it start with http:// or url/http://
valid=false;
}
else if(type.indexOf("javax.mail")>-1) //jms resource
{
if(!refJndiName.startsWith("mail/"))
valid=false;
}
else
valid=false;
}
else{
valid=false;
}
return valid;
}
}