MethodDesc.java

package org.objectweb.jonas_ejb.deployment.api;

import java.lang.reflect.Method;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;

import org.objectweb.jonas_ejb.deployment.xml.MethodParams;
import org.objectweb.jonas_lib.deployment.api.DeploymentDescException;

public class MethodDesc {

    public static final int TX_NULL          = -1;
    public static final int TX_NOT_SET       = 0;
    public static final int TX_NOT_SUPPORTED = 1;
    public static final int TX_REQUIRED      = 2;
    public static final int TX_SUPPORTS      = 3;
    public static final int TX_REQUIRES_NEW  = 4;
    public static final int TX_MANDATORY     = 5;
    public static final int TX_NEVER         = 6;


    private static final String[] ATTR = {
        "TX_NOT_SET",
        "TX_NOT_SUPPORTED",
        "TX_REQUIRED",
        "TX_SUPPORTS",
        "TX_REQUIRES_NEW",
        "TX_MANDATORY",
        "TX_NEVER"
    };

    protected static final String TX_STR_DEFAULT_VALUE = "Supports";

    protected static final String TX_STR_DEFAULT_VALUE_4_MDB = "NotSupported";

    private int txAttribute = TX_NOT_SET;
    private int txAttributeStatus = APPLY_TO_BEAN;

    // Array of String representing the roles which can execute the method of this MethodDesc
    private HashSet roleName = new HashSet();

    public static final int APPLY_TO_NOTHING = 0;
    public static final int APPLY_TO_BEAN = 1;
    public static final int APPLY_TO_CLASS = 2;
    public static final int APPLY_TO_BEAN_METHOD_NAME = 3;
    public static final int APPLY_TO_CLASS_METHOD_NAME = 4;
    public static final int APPLY_TO_BEAN_METHOD = 5;
    public static final int APPLY_TO_CLASS_METHOD = 6;

    protected static final String[] APPLY_TO = {
        "APPLY_TO_NOTHING",
        "APPLY_TO_BEAN",
        "APPLY_TO_CLASS",
        "APPLY_TO_BEAN_METHOD_NAME",
        "APPLY_TO_CLASS_METHOD_NAME",
        "APPLY_TO_BEAN_METHOD",
        "APPLY_TO_CLASS_METHOD"
    };

    private Method meth;
    private int index;

    protected BeanDesc beanDesc;

    private boolean isFinder = false;
    private boolean isEjbSelect = false;
    private boolean isFindByPrimaryKey = false;

    private boolean excluded = false;
    
    public MethodDesc(BeanDesc beanDesc, Method meth, int index) {
        this.meth = meth;
        this.index = index;
        this.beanDesc = beanDesc;
        isFindByPrimaryKey = MethodDesc.isFindByPrimaryKey(meth);
        isFinder = isFinder(meth);
        isEjbSelect = isEjbSelect(meth);
    }

    public int getIndex() {
        return index;
    }

    public void setIndex(int idx) {
        index = idx;
    }

    public boolean isFinder() {
        return isFinder;
    }

    public boolean isFindByPrimaryKey() {
        return isFindByPrimaryKey;
    }


    public boolean isEjbSelect() {
        return isEjbSelect;
    }


    void overwriteTxAttribute(String transAttribute, int status) throws DeploymentDescException {
        // overwrite only if numerical value greater than existing one
        if (status < this.txAttributeStatus) {
            return;
        }
        setTxAttribute(transAttribute);
        txAttributeStatus = status;
    }

    void setTxAttribute(String transAttribute) throws DeploymentDescException {
        if (transAttribute.equals("NotSupported")) {
            txAttribute = TX_NOT_SUPPORTED;
        } else if (transAttribute.equals("Required")) {
            txAttribute = TX_REQUIRED;
        } else if (transAttribute.equals("Supports")) {
            txAttribute = TX_SUPPORTS;
        } else if (transAttribute.equals("RequiresNew")) {
            txAttribute = TX_REQUIRES_NEW;
        } else if (transAttribute.equals("Mandatory")) {
            txAttribute = TX_MANDATORY;
        } else if (transAttribute.equals("Never")) {
            txAttribute = TX_NEVER;
        } else {
            throw new DeploymentDescException(transAttribute
                                              + " is not a valid trans-attribute value");
        }
    }

    void addRoleName (String rn) {
        roleName.add(rn);
    }

    public int matchPattern(Class pclass, String mName, MethodParams patternMethodParams) {
        return matchPattern(getMethod(), pclass, mName, patternMethodParams);
    }

    public static int matchPattern(java.lang.reflect.Method meth,
                                   Class pclass,
                                   String mName,
                                   MethodParams patternMethodParams) {

        // If pclass don't match -> APPLY_TO_NOTHING
        if (pclass != null && !pclass.isAssignableFrom(meth.getDeclaringClass())) {
            return APPLY_TO_NOTHING;
        }

        // class is enough
        if (mName.equals("*")) {
            return (pclass == null) ? APPLY_TO_BEAN : APPLY_TO_CLASS;
        }

        // method name does not match
        if (!mName.equals(meth.getName())) {
            return APPLY_TO_NOTHING;
        }

        // no params specified (name test is enough)
        if (patternMethodParams == null) {
            return (pclass == null) ? APPLY_TO_BEAN_METHOD_NAME : APPLY_TO_CLASS_METHOD_NAME;
        }

        Class pars[] = meth.getParameterTypes();
        List pattPars = patternMethodParams.getMethodParamList();
        // number of parameters does not match
        if (pars.length != pattPars.size()) {
            return APPLY_TO_NOTHING;
        }
        Iterator i = pattPars.iterator();
        for (int ii = 0; ii < pars.length; ii++) {
            String cName = (String) i.next();
            if (!getClassName(pars[ii]).equals(cName)) {
                return APPLY_TO_NOTHING;
            }
        }
        return (pclass == null) ? APPLY_TO_BEAN_METHOD : APPLY_TO_CLASS_METHOD;
    }

    private static String getClassName(Class c) {
        String name;
        if (c.isArray()) {
            name = getClassName(c.getComponentType()) + "[]";
        } else {
            name = c.getName();
        }
        return (name);
    }



    public int getTxAttribute() {
        return txAttribute;
    }

    public int getTxAttributeStatus() {
        return txAttributeStatus;
    }

    public static String getTxAttributeName(int value) {
        if ((value < 0) || (value > ATTR.length)) {
            throw new Error(value + " is not a valid TxAttribute");
        }
        return ATTR[value];
    }

    public String getTxAttributeName() {
        return ATTR[txAttribute];
    }

    public String[] getRoleName () {
        if (roleName.isEmpty()) {
            return new String[0];
        }
        Object[] o = roleName.toArray();
        String[] rn =  new String[o.length];
        for (int i = 0; i < rn.length; i++) {
            rn[i] = (String) o[i];
        }
        return rn;
    }

    public static String methodElementToString(org.objectweb.jonas_ejb.deployment.xml.Method m) {
        return methodElementToString(m.getMethodIntf(), m.getMethodName(), m.getMethodParams());
    }

    protected static String methodElementToString(String intf, String name, MethodParams params) {
        String s = new String();
        if (intf != null) {
            s = s.concat(intf + ".");
        }
        s = s.concat(name);
        if (params != null) {
            s = s.concat("(");
            for (Iterator i = params.getMethodParamList().iterator(); i.hasNext();) {
                s = s.concat((String) i.next());
                if (i.hasNext()) {
                    s = s.concat(",");
                }
            }
            s = s.concat(")");
        }
        return (s);
    }

    public static String toString(Method m) {
        StringBuffer ret = new StringBuffer();
        ret.append(m.getDeclaringClass().getName());
        ret.append('.');
        ret.append(m.getName());
        ret.append('(');
        Class[] params = m.getParameterTypes();
        for (int i = 0; i < params.length; i++) {
            ret.append(getClassName(params[i]));
            if (i == params.length - 1) {
                break;
            }
            ret.append(',');
        }
        ret.append(')');
        return ret.toString();
    }

    public Method getMethod() {
        return meth;
    }

    public BeanDesc getBeanDesc() {
        return beanDesc;
    }

    public static boolean isFinder(Method meth) {
        return (meth.getName().startsWith("find")
                && (javax.ejb.EJBHome.class.isAssignableFrom(meth.getDeclaringClass())
                    || javax.ejb.EJBLocalHome.class.isAssignableFrom(meth.getDeclaringClass())));
    }

    public static boolean isFindByPrimaryKey(Method meth) {
        return (meth.getName().equals("findByPrimaryKey")
                && (javax.ejb.EJBHome.class.isAssignableFrom(meth.getDeclaringClass())
                    || javax.ejb.EJBLocalHome.class.isAssignableFrom(meth.getDeclaringClass())));
    }

    public static boolean isEjbSelect(Method meth) {
        return (meth.getName().startsWith("ejbSelect")
                && javax.ejb.EntityBean.class.isAssignableFrom(meth.getDeclaringClass()));
    }

    public String toString() {
        StringBuffer ret = new StringBuffer();
        ret.append("\ngetTxAttribute()       = " + ATTR[getTxAttribute()]);
        ret.append("\ngetTxAttributeStatus() = " + APPLY_TO[getTxAttributeStatus()]);
        ret.append("\nMethodIndex            = " + index);
        ret.append("\nmeth                   = " + toString(meth));
        ret.append("\nisFinder               = " + isFinder);
        ret.append("\nisEjbSelect            = " + isEjbSelect);
        ret.append("\nisFindByPrimaryKey     = " + isFindByPrimaryKey);
        if (!roleName.isEmpty()) {
            ret.append("\ngetRoleName()          = [");
            String [] rn = getRoleName();
            for (int i = 0; i < rn.length - 1; i++) {
                ret.append (rn[i] + ", ");
            }
            ret.append(rn[rn.length - 1] + "]");
            ret.append("\n");
        }
        return ret.toString();
    }

    public boolean isExcluded() {
        return excluded;
    }
    public void setExcluded(boolean excluded) {
        this.excluded = excluded;
    }
}

---