Search in sources :

Example 36 with VerifierTestContext

use of com.sun.enterprise.tools.verifier.VerifierTestContext in project Payara by payara.

the class PrimaryKeyClassModifier method check.

/**
 * Enterprise Java Bean primary key class modifier test.
 * The class must be defined as public
 *
 * @param descriptor the Enterprise Java Bean deployment descriptor
 *
 * @return <code>Result</code> the results for this assertion
 */
public Result check(EjbDescriptor descriptor) {
    Result result = getInitializedResult();
    ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
    if (descriptor instanceof EjbEntityDescriptor) {
        String persistence = ((EjbEntityDescriptor) descriptor).getPersistenceType();
        if (EjbEntityDescriptor.CONTAINER_PERSISTENCE.equals(persistence)) {
            // field in entity bean class and this test in notApplicable
            try {
                FieldDescriptor fd = ((EjbCMPEntityDescriptor) descriptor).getPrimaryKeyFieldDesc();
                if (fd != null) {
                    String pkf = fd.getName();
                    if (pkf.length() > 0) {
                        // N/A case
                        result.addNaDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                        result.notApplicable(smh.getLocalString(getClass().getName() + ".notApplicable2", "Entity Bean [ {0} ] with primekey-field non-blank, test not applicable.", new Object[] { descriptor.getEjbClassName() }));
                    }
                } else {
                    try {
                        VerifierTestContext context = getVerifierContext();
                        ClassLoader jcl = context.getClassLoader();
                        Class c = Class.forName(((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName(), false, getVerifierContext().getClassLoader());
                        boolean isPublic = false;
                        int modifiers = c.getModifiers();
                        if (Modifier.isPublic(modifiers)) {
                            isPublic = true;
                        }
                        if (isPublic) {
                            result.addGoodDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                            result.passed(smh.getLocalString(getClass().getName() + ".passed", "[ {0} ] properly declares public class modifier.", new Object[] { ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName() }));
                        } else if (!isPublic) {
                            result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                            result.failed(smh.getLocalString(getClass().getName() + ".failed", "Error: Ejb primary key class [ {0} ] was found, but was not declared as public.  The primary key class  [ {1} ] must be defined as public.", new Object[] { ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName(), ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName() }));
                        }
                    } catch (ClassNotFoundException e) {
                        Verifier.debug(e);
                        result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                        result.failed(smh.getLocalString(getClass().getName() + ".failedException", "Error: [ {0} ] class not found.", new Object[] { ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName() }));
                    }
                }
            } catch (NullPointerException e) {
                result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                result.failed(smh.getLocalString(getClass().getName() + ".failedException2", "Error: Primkey field not defined within [ {0} ] bean.", new Object[] { descriptor.getName() }));
            }
            return result;
        } else {
            // if (BEAN_PERSISTENCE.equals(persistence)
            result.addNaDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
            result.notApplicable(smh.getLocalString(getClass().getName() + ".notApplicable1", "Expected [ {0} ] managed persistence, but [ {1} ] bean has [ {2} ] managed persistence.", new Object[] { EjbEntityDescriptor.CONTAINER_PERSISTENCE, descriptor.getName(), persistence }));
            return result;
        }
    } else {
        result.addNaDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
        result.notApplicable(smh.getLocalString(getClass().getName() + ".notApplicable", "{0} expected {1} bean, but called with {2}.", new Object[] { getClass(), "Entity", "Session" }));
        return result;
    }
}
Also used : VerifierTestContext(com.sun.enterprise.tools.verifier.VerifierTestContext) Result(com.sun.enterprise.tools.verifier.Result) FieldDescriptor(org.glassfish.ejb.deployment.descriptor.FieldDescriptor) EjbEntityDescriptor(org.glassfish.ejb.deployment.descriptor.EjbEntityDescriptor) EjbCMPEntityDescriptor(org.glassfish.ejb.deployment.descriptor.EjbCMPEntityDescriptor) ComponentNameConstructor(com.sun.enterprise.tools.verifier.tests.ComponentNameConstructor)

Example 37 with VerifierTestContext

use of com.sun.enterprise.tools.verifier.VerifierTestContext in project Payara by payara.

the class EjbPrimaryKeyClassRmiIIOP method check.

/**
 * Define primary key class which must be legal Value Type in RMI-IIOP test.
 *
 * Enterprise Bean's primary key class
 * The Bean provider must specify a primary key class in the deployment
 * descriptor. The primary key class must be a legal Value Type in RMI-IIOP.
 *
 * @param descriptor the Enterprise Java Bean deployment descriptor
 *
 * @return <code>Result</code> the results for this assertion
 */
public Result check(EjbDescriptor descriptor) {
    Result result = getInitializedResult();
    ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
    if (descriptor instanceof EjbEntityDescriptor) {
        boolean isLegalRMIIIOPValueType = false;
        boolean oneFailed = false;
        // retrieve the EJB primary key class
        String primaryKeyType = ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName();
        if (!primaryKeyType.equals("")) {
            try {
                VerifierTestContext context = getVerifierContext();
                ClassLoader jcl = context.getClassLoader();
                Class c = Class.forName(((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName(), false, getVerifierContext().getClassLoader());
                if (RmiIIOPUtils.isValidRmiIIOPValueType(c)) {
                    // this is the right primary key class
                    isLegalRMIIIOPValueType = true;
                }
                if (isLegalRMIIIOPValueType) {
                    result.addGoodDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                    result.addGoodDetails(smh.getLocalString(getClass().getName() + ".debug1", "For EJB primary key class [ {0} ]", new Object[] { primaryKeyType }));
                    result.addGoodDetails(smh.getLocalString(getClass().getName() + ".passed", "A primary key class which must be legal Value Type in RMI-IIOP was defined in the deployment descriptor."));
                } else if (!isLegalRMIIIOPValueType) {
                    oneFailed = true;
                    result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                    result.addErrorDetails(smh.getLocalString(getClass().getName() + ".debug1", "For EJB primary key class [ {0} ]", new Object[] { primaryKeyType }));
                    result.addErrorDetails(smh.getLocalString(getClass().getName() + ".failed", "Error: A primary key class which must be legal Value Type in RMI-IIOP was not defined in the deployment descriptor."));
                }
            } catch (ClassNotFoundException e) {
                Verifier.debug(e);
                result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                result.failed(smh.getLocalString(getClass().getName() + ".failedException", "Error: [ {0} ] class not found.", new Object[] { primaryKeyType }));
                oneFailed = true;
            }
        } else {
            oneFailed = true;
            result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
            result.addErrorDetails(smh.getLocalString(getClass().getName() + ".debug1", "For EJB primary key class [ {0} ]", new Object[] { primaryKeyType }));
            result.addErrorDetails(smh.getLocalString(getClass().getName() + ".failed1", "Error: A primary key class was not defined in the deployment descriptor."));
        }
        if (oneFailed) {
            result.setStatus(result.FAILED);
        } else {
            result.setStatus(result.PASSED);
        }
        return result;
    } else {
        result.addNaDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
        result.notApplicable(smh.getLocalString(getClass().getName() + ".notApplicable", "[ {0} ] expected {1} bean, but called with {2} bean.", new Object[] { getClass(), "Entity", "Session" }));
        return result;
    }
}
Also used : EjbEntityDescriptor(org.glassfish.ejb.deployment.descriptor.EjbEntityDescriptor) VerifierTestContext(com.sun.enterprise.tools.verifier.VerifierTestContext) ComponentNameConstructor(com.sun.enterprise.tools.verifier.tests.ComponentNameConstructor) Result(com.sun.enterprise.tools.verifier.Result)

Example 38 with VerifierTestContext

use of com.sun.enterprise.tools.verifier.VerifierTestContext in project Payara by payara.

the class PrimaryKeyClassMethodEqual method check.

/**
 * Primary key class provide implementation of equals() methods test.
 *
 * Enterprise Bean's primary key class
 * The class must provide suitable implementation of the equals(Object other)
 * methods to simplify the management of the primary keys by client code.
 *
 * @param descriptor the Enterprise Java Bean deployment descriptor
 *
 * @return <code>Result</code> the results for this assertion
 */
public Result check(EjbDescriptor descriptor) {
    Result result = getInitializedResult();
    ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
    if (descriptor instanceof EjbEntityDescriptor) {
        String transactionType = descriptor.getTransactionType();
        if (EjbDescriptor.CONTAINER_TRANSACTION_TYPE.equals(transactionType)) {
            boolean hasDefinedEqaulsMethod = false;
            boolean oneFailed = false;
            int lc = 0;
            // RULE: Primary key class must defined equals(Object other) method
            try {
                VerifierTestContext context = getVerifierContext();
                ClassLoader jcl = context.getClassLoader();
                // retrieve the EJB primary key class
                Class c = Class.forName(((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName(), false, getVerifierContext().getClassLoader());
                Method[] methods = c.getDeclaredMethods();
                for (int i = 0; i < methods.length; i++) {
                    if (methods[i].getName().equals("equals")) {
                        // this is the right primary key class method equals()
                        hasDefinedEqaulsMethod = true;
                        // used in output below
                        lc = i;
                        break;
                    }
                }
                if (hasDefinedEqaulsMethod) {
                    result.addGoodDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                    result.addGoodDetails(smh.getLocalString(getClass().getName() + ".debug1", "For EJB primary key class [ {0} ]", new Object[] { ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName() }));
                    result.addGoodDetails(smh.getLocalString(getClass().getName() + ".passed", "Primary key class method [ {0} ] was defined in the primary key class.", new Object[] { methods[lc].getName() }));
                } else if (!hasDefinedEqaulsMethod) {
                    oneFailed = true;
                    result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                    result.addErrorDetails(smh.getLocalString(getClass().getName() + ".debug1", "For EJB primary key class [ {0} ]", new Object[] { ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName() }));
                    result.addErrorDetails(smh.getLocalString(getClass().getName() + ".failed", "Error: Primary key class method equal() was not defined in the primary key class."));
                }
            } catch (ClassNotFoundException e) {
                Verifier.debug(e);
                result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                result.failed(smh.getLocalString(getClass().getName() + ".failedException", "Error: Primary Key Class [ {0} ] not found within bean [ {1} ]", new Object[] { ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName(), descriptor.getName() }));
            }
            if (oneFailed) {
                result.setStatus(result.FAILED);
            } else {
                result.setStatus(result.PASSED);
            }
        } else {
            // not container managed, but is a entity bean
            result.addNaDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
            result.notApplicable(smh.getLocalString(getClass().getName() + ".notApplicable2", "Bean [ {0} ] is not [ {1} ] managed, it is [ {2} ]  managed.", new Object[] { descriptor.getName(), EjbDescriptor.CONTAINER_TRANSACTION_TYPE, transactionType }));
        }
        return result;
    } else {
        result.addNaDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
        result.notApplicable(smh.getLocalString(getClass().getName() + ".notApplicable", "{0} expected {1} bean, but called with {2} bean.", new Object[] { getClass(), "Entity", "Session" }));
        return result;
    }
}
Also used : VerifierTestContext(com.sun.enterprise.tools.verifier.VerifierTestContext) Method(java.lang.reflect.Method) Result(com.sun.enterprise.tools.verifier.Result) EjbEntityDescriptor(org.glassfish.ejb.deployment.descriptor.EjbEntityDescriptor) ComponentNameConstructor(com.sun.enterprise.tools.verifier.tests.ComponentNameConstructor)

Example 39 with VerifierTestContext

use of com.sun.enterprise.tools.verifier.VerifierTestContext in project Payara by payara.

the class PrimaryKeyClassOpt method commonToBothInterfaces.

/**
 * This method is responsible for the logic of the test. It is called for both local and remote interfaces.
 * @param descriptor the Enterprise Java Bean deployment descriptor
 * @param home for the Home interface of the Ejb.
 * @return boolean the results for this assertion i.e if a test has failed or not
 */
private boolean commonToBothInterfaces(String home, EjbDescriptor descriptor) {
    boolean oneFailed = false;
    try {
        VerifierTestContext context = getVerifierContext();
        ClassLoader jcl = context.getClassLoader();
        Class c = Class.forName(home, false, getVerifierContext().getClassLoader());
        Method[] ejbFinderMethods = c.getDeclaredMethods();
        boolean paramValid = false;
        for (int j = 0; j < ejbFinderMethods.length; ++j) {
            // reset all booleans for next method within the loop
            if (ejbFinderMethods[j].getName().equals("findByPrimaryKey")) {
                Class[] ejbFinderMethodParameterTypes;
                ejbFinderMethodParameterTypes = ejbFinderMethods[j].getParameterTypes();
                for (int k = 0; k < ejbFinderMethodParameterTypes.length; ++k) {
                    if (ejbFinderMethodParameterTypes[k].getName().equals("java.lang.Object")) {
                        paramValid = true;
                        break;
                    }
                }
            }
        }
        if (paramValid) {
            result.addGoodDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
            result.passed(smh.getLocalString(getClass().getName() + ".passed", "findByPrimaryKey method properly defines method parameter [ {0} ]", new Object[] { "java.lang.Object" }));
        } else {
            result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
            result.failed(smh.getLocalString(getClass().getName() + ".failed", "Error: findByPrimaryKey method does not properly define method parameter [ {0} ]", new Object[] { "java.lang.Object" }));
        }
        return oneFailed;
    } catch (Exception e) {
        Verifier.debug(e);
        result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
        result.failed(smh.getLocalString(getClass().getName() + ".failedException", "Error: Loading Home interface class [ {0} ]", new Object[] { home }));
        return oneFailed;
    }
}
Also used : VerifierTestContext(com.sun.enterprise.tools.verifier.VerifierTestContext) Method(java.lang.reflect.Method)

Example 40 with VerifierTestContext

use of com.sun.enterprise.tools.verifier.VerifierTestContext in project Payara by payara.

the class PrimaryKeyClassOptReturn method check.

/**
 * Entity bean's Primary Key Class return test.
 * If the enterprise bean is a Entity Bean, the Bean provider specifies
 * the fully qualified name of the Entity bean's primary key class in the
 * "primary-class" element. The Bean provider 'must' specify the primary key
 * class for an Entity with bean managed persistence, and 'may' (but is not
 * required to) specify the primary key class for an Entity with
 * Container-managed persistence.
 *
 * Special case: Unknown primary key class
 * In special situations, the Bean Provider may choose not to specify the
 * primary key class for an entity bean with container-managed persistence. This
 * case happens if the Bean Provider wants to allow the Deployer to select the
 * primary key fields at deployment time. The Deployer uses instructions
 * supplied by the Bean Provider (these instructions are beyond the scope of
 * the EJB spec.) to define a suitable primary key class.
 *
 * In this special case, the type of the argument of the findByPrimaryKey method
 * must be declared as java.lang.Object, and the return value of ejbCreate()
 * must be declared as java.lang.Object. The Bean Provider must specify the
 * primary key class in the deployment descriptor as of the type
 * java.lang.Object.
 *
 * The primary key class is specified at deployment time when the Bean Provider
 * develops enterprise beans that is intended to be used with multiple back-ends
 * that provide persistence, and when these multiple back-ends require different
 * primary key structures.
 *
 * @param descriptor the Enterprise Java Bean deployment descriptor
 *
 * @return <code>Result</code> the results for this assertion
 */
public Result check(EjbDescriptor descriptor) {
    Result result = getInitializedResult();
    ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
    if (descriptor instanceof EjbEntityDescriptor) {
        String persistence = ((EjbEntityDescriptor) descriptor).getPersistenceType();
        if (EjbEntityDescriptor.CONTAINER_PERSISTENCE.equals(persistence)) {
            String primkey = ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName();
            // <prim-key-class> to "java.lang.Object"
            if (primkey.equals("java.lang.Object")) {
                try {
                    VerifierTestContext context = getVerifierContext();
                    ClassLoader jcl = context.getClassLoader();
                    Class c = Class.forName(descriptor.getEjbClassName(), false, getVerifierContext().getClassLoader());
                    boolean returnsJLO = false;
                    // start do while loop here....
                    do {
                        Method[] methods = c.getDeclaredMethods();
                        returnsJLO = false;
                        for (int j = 0; j < methods.length; ++j) {
                            if (methods[j].getName().equals("ejbCreate")) {
                                // The return type must be java.lang.Object.
                                Class rt = methods[j].getReturnType();
                                if (rt.getName().equals("java.lang.Object")) {
                                    returnsJLO = true;
                                    break;
                                }
                            }
                        }
                    } while (((c = c.getSuperclass()) != null) && (!returnsJLO));
                    if (returnsJLO) {
                        result.addGoodDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                        result.passed(smh.getLocalString(getClass().getName() + ".passed", "ejbCreate() method properly defines method return type [ {0} ]", new Object[] { "java.lang.Object" }));
                    } else {
                        result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                        result.failed(smh.getLocalString(getClass().getName() + ".failed", "ejbCreate() method does not properly define method return type [ {0} ]", new Object[] { "java.lang.Object" }));
                    }
                } catch (Exception e) {
                    Verifier.debug(e);
                    result.addErrorDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                    result.failed(smh.getLocalString(getClass().getName() + ".failedException", "Error: Loading bean class [ {0} ]", new Object[] { descriptor.getEjbClassName() }));
                    return result;
                }
            } else {
                result.addNaDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
                result.notApplicable(smh.getLocalString(getClass().getName() + ".notApplicable1", "Primary Key Class is [ {0} ]", new Object[] { primkey }));
            }
            return result;
        } else if (EjbEntityDescriptor.BEAN_PERSISTENCE.equals(persistence)) {
            result.addNaDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
            result.notApplicable(smh.getLocalString(getClass().getName() + ".notApplicable2", "Entity bean with [ {0} ] managed persistence, primkey mandatory.", new Object[] { persistence }));
            return result;
        } else {
            result.addNaDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
            result.notApplicable(smh.getLocalString(getClass().getName() + ".notApplicable3", "Expected [ {0} ] managed persistence, but [ {1} ] bean has [ {2} ] managed persistence.", new Object[] { EjbEntityDescriptor.CONTAINER_PERSISTENCE, descriptor.getName(), persistence }));
            return result;
        }
    } else {
        result.addNaDetails(smh.getLocalString("tests.componentNameConstructor", "For [ {0} ]", new Object[] { compName.toString() }));
        result.notApplicable(smh.getLocalString(getClass().getName() + ".notApplicable", "[ {0} ] expected {1} bean, but called with {2} bean.", new Object[] { getClass(), "Entity", "Session" }));
        return result;
    }
}
Also used : VerifierTestContext(com.sun.enterprise.tools.verifier.VerifierTestContext) Method(java.lang.reflect.Method) Result(com.sun.enterprise.tools.verifier.Result) EjbEntityDescriptor(org.glassfish.ejb.deployment.descriptor.EjbEntityDescriptor) ComponentNameConstructor(com.sun.enterprise.tools.verifier.tests.ComponentNameConstructor)

Aggregations

VerifierTestContext (com.sun.enterprise.tools.verifier.VerifierTestContext)91 Result (com.sun.enterprise.tools.verifier.Result)66 ComponentNameConstructor (com.sun.enterprise.tools.verifier.tests.ComponentNameConstructor)66 Method (java.lang.reflect.Method)66 EjbEntityDescriptor (org.glassfish.ejb.deployment.descriptor.EjbEntityDescriptor)49 EjbCMPEntityDescriptor (org.glassfish.ejb.deployment.descriptor.EjbCMPEntityDescriptor)12 EjbSessionDescriptor (org.glassfish.ejb.deployment.descriptor.EjbSessionDescriptor)11 Vector (java.util.Vector)9 TagLibDescriptor (com.sun.enterprise.tools.verifier.TagLibDescriptor)7 Field (java.lang.reflect.Field)7 FieldDescriptor (org.glassfish.ejb.deployment.descriptor.FieldDescriptor)6 EjbSessionDescriptor (com.sun.enterprise.deployment.EjbSessionDescriptor)4 MethodDescriptor (com.sun.enterprise.deployment.MethodDescriptor)4 TagDescriptor (com.sun.enterprise.tools.verifier.web.TagDescriptor)3 Enumeration (java.util.Enumeration)3 Iterator (java.util.Iterator)3 Set (java.util.Set)3 ContainerTransaction (org.glassfish.ejb.deployment.descriptor.ContainerTransaction)3 EjbDescriptor (org.glassfish.ejb.deployment.descriptor.EjbDescriptor)3 FunctionDescriptor (com.sun.enterprise.tools.verifier.web.FunctionDescriptor)2