Examples with SpecVersion org.apache.felix.scrplugin.SpecVersion used on opensource projects

Example 1 with SpecVersion

use of org.apache.felix.scrplugin.SpecVersion in project felix by apache.

the class DSAnnotationProcessor method createComponent.

/**
 * Create a component description.
 *
 * @param cad The component annotation for the class.
 * @param scannedClass The scanned class.
 */
private ComponentDescription createComponent(final ClassAnnotation cad, final ClassDescription describedClass, final ScannedClass scannedClass) throws SCRDescriptorException {
    final ComponentDescription component = new ComponentDescription(cad);
    describedClass.add(component);
    // Although not defined in the spec, we support abstract classes.
    final boolean classIsAbstract = Modifier.isAbstract(scannedClass.getClass().getModifiers());
    component.setAbstract(classIsAbstract);
    // name
    component.setName(cad.getStringValue("name", scannedClass.getScannedClass().getName()));
    // services
    final List<String> listedInterfaces = new ArrayList<String>();
    if (cad.hasValue("service")) {
        final String[] interfaces = (String[]) cad.getValue("service");
        if (interfaces != null) {
            for (final String t : interfaces) {
                listedInterfaces.add(t);
            }
        }
    } else {
        // scan directly implemented interfaces
        this.searchInterfaces(listedInterfaces, scannedClass.getScannedClass());
    }
    if (listedInterfaces.size() > 0) {
        final ServiceDescription serviceDesc = new ServiceDescription(cad);
        describedClass.add(serviceDesc);
        for (final String name : listedInterfaces) {
            serviceDesc.addInterface(name);
        }
        serviceDesc.setServiceFactory(cad.getBooleanValue("servicefactory", false));
    }
    // factory
    component.setFactory(cad.getStringValue("factory", null));
    // enabled
    if (cad.getValue("enabled") != null) {
        component.setEnabled(cad.getBooleanValue("enabled", true));
    }
    // immediate
    if (cad.getValue("immediate") != null) {
        component.setImmediate(cad.getBooleanValue("immediate", false));
    }
    // property
    final String[] property = (String[]) cad.getValue("property");
    if (property != null) {
        // TODO - what do we do if the value is invalid?
        for (final String propDef : property) {
            final int pos = propDef.indexOf('=');
            if (pos != -1) {
                final String prefix = propDef.substring(0, pos);
                final String value = propDef.substring(pos + 1);
                final int typeSep = prefix.indexOf(':');
                final String key = (typeSep == -1 ? prefix : prefix.substring(0, typeSep));
                final String type = (typeSep == -1 ? PropertyType.String.name() : prefix.substring(typeSep + 1));
                final PropertyType propType = PropertyType.valueOf(type);
                // FELIX-4159 : check if this is a multi value prop
                final List<PropertyDescription> existingProps = describedClass.getDescriptions(PropertyDescription.class);
                PropertyDescription found = null;
                for (final PropertyDescription current : existingProps) {
                    if (current.getName().equals(key)) {
                        found = current;
                        break;
                    }
                }
                if (found == null) {
                    final PropertyDescription pd = new PropertyDescription(cad);
                    describedClass.add(pd);
                    pd.setName(key);
                    pd.setValue(value);
                    pd.setType(propType);
                    pd.setUnbounded(PropertyUnbounded.DEFAULT);
                } else {
                    if (propType != found.getType()) {
                        throw new SCRDescriptorException("Multi value property '" + key + "' has different types: " + found.getType() + " & " + propType, describedClass.getSource());
                    }
                    if (found.getValue() != null) {
                        final String[] values = new String[2];
                        values[0] = found.getValue();
                        values[1] = value;
                        found.setMultiValue(values);
                    } else {
                        final String[] oldValues = found.getMultiValue();
                        final String[] newValues = new String[oldValues.length + 1];
                        System.arraycopy(oldValues, 0, newValues, 0, oldValues.length);
                        newValues[oldValues.length] = value;
                        found.setMultiValue(newValues);
                    }
                }
            }
        }
    }
    // xmlns
    if (cad.getValue("xmlns") != null) {
        final SpecVersion spec = SpecVersion.fromNamespaceUrl(cad.getValue("xmlns").toString());
        if (spec == null) {
            throw new SCRDescriptorException("Unknown xmlns attribute value: " + cad.getValue("xmlns"), describedClass.getSource());
        }
        component.setSpecVersion(spec);
    }
    // configuration policy
    component.setConfigurationPolicy(ComponentConfigurationPolicy.valueOf(cad.getEnumValue("configurationPolicy", ComponentConfigurationPolicy.OPTIONAL.name())));
    // configuration pid
    Object configPid = cad.getValue("configurationPid");
    if (configPid instanceof String) {
        component.setConfigurationPid((String) configPid);
    } else if (configPid instanceof String[] && ((String[]) configPid).length == 1) {
        component.setConfigurationPid(((String[]) configPid)[0]);
    } else {
        component.setConfigurationPid(null);
    }
    component.setCreatePid(false);
    // no inheritance
    component.setInherit(false);
    return component;
}

Example 2 with SpecVersion

use of org.apache.felix.scrplugin.SpecVersion in project felix by apache.

the class Validator method findMethod.

/**
 * Find the method and the required spec version
 * @throws SCRDescriptorException If the class can't be found
 */
public static MethodResult findMethod(final Project project, final Options options, final ClassDescription cd, final ReferenceDescription ref, final String methodName) throws SCRDescriptorException {
    if ("-".equals(methodName)) {
        return null;
    }
    SpecVersion requiredVersion = SpecVersion.VERSION_1_0;
    try {
        final Class<?>[] sig = new Class<?>[] { project.getClassLoader().loadClass(TYPE_SERVICE_REFERENCE) };
        final Class<?>[] sig2 = new Class<?>[] { project.getClassLoader().loadClass(ref.getInterfaceName()) };
        final Class<?>[] sig3 = new Class<?>[] { project.getClassLoader().loadClass(ref.getInterfaceName()), Map.class };
        // service interface or ServiceReference first
        String realMethodName = methodName;
        Method method = getMethod(cd, realMethodName, sig);
        if (method == null) {
            method = getMethod(cd, realMethodName, sig2);
            if (method == null && (options.getSpecVersion() == null || options.getSpecVersion().ordinal() >= SpecVersion.VERSION_1_1.ordinal())) {
                method = getMethod(cd, realMethodName, sig3);
                requiredVersion = SpecVersion.VERSION_1_1;
            }
        }
        // append reference name with service interface and ServiceReference
        if (method == null) {
            final String info;
            if (StringUtils.isEmpty(ref.getName())) {
                final String interfaceName = ref.getInterfaceName();
                final int pos = interfaceName.lastIndexOf('.');
                info = interfaceName.substring(pos + 1);
            } else {
                info = ref.getName();
            }
            realMethodName = methodName + Character.toUpperCase(info.charAt(0)) + info.substring(1);
            method = getMethod(cd, realMethodName, sig);
        }
        if (method == null) {
            method = getMethod(cd, realMethodName, sig2);
            if (method == null && (options.getSpecVersion() == null || options.getSpecVersion().ordinal() >= SpecVersion.VERSION_1_1.ordinal())) {
                method = getMethod(cd, realMethodName, sig3);
                requiredVersion = SpecVersion.VERSION_1_1;
            }
        }
        // append type name with service interface and ServiceReference
        if (method == null) {
            int lastDot = ref.getInterfaceName().lastIndexOf('.');
            realMethodName = methodName + ref.getInterfaceName().substring(lastDot + 1);
            method = getMethod(cd, realMethodName, sig);
        }
        if (method == null) {
            method = getMethod(cd, realMethodName, sig2);
            if (method == null && (options.getSpecVersion() == null || options.getSpecVersion().ordinal() >= SpecVersion.VERSION_1_1.ordinal())) {
                method = getMethod(cd, realMethodName, sig3);
                requiredVersion = SpecVersion.VERSION_1_1;
            }
        }
        if (method == null) {
            return null;
        }
        final MethodResult result = new MethodResult();
        result.method = method;
        result.requiredSpecVersion = requiredVersion;
        return result;
    } catch (final ClassNotFoundException cnfe) {
        throw new SCRDescriptorException("Unable to load class!", cnfe);
    }
}

Example 3 with SpecVersion

use of org.apache.felix.scrplugin.SpecVersion in project felix by apache.

the class ComponentDescriptorIO method generateDescriptorFiles.

/**
 * Generate descriptor file(s)
 */
public static List<String> generateDescriptorFiles(final DescriptionContainer module, final Options options, final Log logger) throws SCRDescriptorException, SCRDescriptorFailureException {
    // get the list of all relevant containers
    final List<ComponentContainer> components = new ArrayList<ComponentContainer>();
    for (final ComponentContainer container : module.getComponents()) {
        if (!container.getComponentDescription().isCreateDs()) {
            logger.debug("Ignoring descriptor for DS : " + container);
        } else if (!container.getComponentDescription().isAbstract()) {
            logger.debug("Adding descriptor for DS : " + container);
            components.add(container);
        }
    }
    // check descriptor file
    final File descriptorDir = options.getComponentDescriptorDirectory();
    // terminate if there is nothing else to write
    if (components.isEmpty()) {
        logger.debug("No Service Component Descriptors found in project.");
        // remove files if it exists
        if (descriptorDir.exists() && !options.isIncremental()) {
            for (final File f : descriptorDir.listFiles()) {
                if (f.isFile()) {
                    logger.debug("Removing obsolete service descriptor " + f);
                    f.delete();
                }
            }
        }
        return null;
    }
    // finally the descriptors have to be written ....
    // ensure parent dir
    descriptorDir.mkdirs();
    final List<String> fileNames = new ArrayList<String>();
    final List<ComponentContainerContainer> containers = ComponentContainerUtil.split(components);
    for (final ComponentContainerContainer ccc : containers) {
        final SpecVersion globalVersion = module.getOptions().getSpecVersion();
        SpecVersion sv = null;
        for (final ComponentContainer cc : ccc.components) {
            if (sv == null || sv.ordinal() < cc.getComponentDescription().getSpecVersion().ordinal()) {
                sv = cc.getComponentDescription().getSpecVersion();
            }
        }
        module.getOptions().setSpecVersion(sv);
        final File useFile = new File(descriptorDir, ccc.className + ".xml");
        try {
            ComponentDescriptorIO.generateXML(module, ccc.components, useFile, logger);
        } catch (final IOException e) {
            throw new SCRDescriptorException("Unable to generate xml", useFile.toString(), e);
        } catch (final TransformerException e) {
            throw new SCRDescriptorException("Unable to generate xml", useFile.toString(), e);
        } catch (final SAXException e) {
            throw new SCRDescriptorException("Unable to generate xml", useFile.toString(), e);
        }
        fileNames.add(PARENT_NAME + '/' + useFile.getName());
        module.getOptions().setSpecVersion(globalVersion);
    }
    return fileNames;
}