org.apache.felix.ipojo.composite.CompositeInstanceDescription Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.felix.ipojo.composite Show documentation
iPOJO Composition Model. This is an iPOJO extension to execute service composition.
There is a newer version: 1.12.1
Show newest version
/* 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.felix.ipojo.composite;

import java.util.Arrays;
import java.util.List;

import org.apache.felix.ipojo.Factory;
import org.apache.felix.ipojo.ServiceContext;
import org.apache.felix.ipojo.architecture.Architecture;
import org.apache.felix.ipojo.architecture.ComponentTypeDescription;
import org.apache.felix.ipojo.architecture.InstanceDescription;
import org.apache.felix.ipojo.metadata.Attribute;
import org.apache.felix.ipojo.metadata.Element;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;


/**
 * Composite Instance Description.
 * 
 * @author Felix Project Team
 */
public class CompositeInstanceDescription extends InstanceDescription {
    
    /**
     * Creates a Primitive Instance Description.
     * @param type the component type description
     * @param instance the instance description
     */
    public CompositeInstanceDescription(ComponentTypeDescription type, CompositeManager instance) {
        super(type, instance);
    }


    /**
     * Gets the list of contained instance in the described instance.
     * This list contains only instances who exposed their architecture.
     * @return the list of contained instances.
     */
    public InstanceDescription[] getContainedInstances() {
        // Get instances description of internal instance
        ServiceContext internal = ((CompositeManager) m_instance).getServiceContext();
        try {
            ServiceReference[] refs = internal.getServiceReferences(Architecture.class.getName(), null);
            if (refs != null) {
                InstanceDescription[] desc = new InstanceDescription[refs.length];
                for (int i = 0; i < refs.length; i++) {
                    Architecture arch = (Architecture) internal.getService(refs[i]);
                    desc[i] = arch.getInstanceDescription();
                    internal.ungetService(refs[i]);
                }
                return desc;
            }
        } catch (InvalidSyntaxException e) {
            // Cannot happen
        }
        return new InstanceDescription[0];
    }

    /**
     * Gets the list of internally published services.
     * @return the list of published services.
     */
    public Element getInternalServices() {
        Element services = new Element("services", "");
        ServiceContext internal = ((CompositeManager) m_instance)
                .getServiceContext();
        try {
            ServiceReference[] refs = internal.getServiceReferences((String) null, "(!(objectclass=" + Factory.class
                    .getName() + "))");
            for (int i = 0; refs != null && i < refs.length; i++) {
                Element svc = new Element("service", "");
                String[] keys = refs[i].getPropertyKeys();
                for (int j = 0; j < keys.length; j++) {
                    Object v = refs[i].getProperty(keys[j]);
                    if (v instanceof String[]) {
                        List l = Arrays.asList((String[]) v);
                        svc.addAttribute(new Attribute(keys[j], l.toString()));
                    } else {
                        svc.addAttribute(new Attribute(keys[j], v.toString()));
                    }
                }
                services.addElement(svc);
            }

        } catch (InvalidSyntaxException e) {
            // Cannot happen
        }
        return services;
    }
    
    /**
     * Gets the instance description.
     * Overridden to add created objects.
     * @return the instance description
     */
    public Element getDescription() {
        Element elem = super.getDescription();
        elem.addElement(getInternalServices());

        InstanceDescription[] descs = getContainedInstances();
        if (descs.length > 0) {
            Element inst = new Element("ContainedInstances", "");
            for (int i = 0; i < descs.length; i++) {
                inst.addElement(descs[i].getDescription());
            }
            elem.addElement(inst);
        }
        
        return elem;
    }

}