EndpointHelper.java

/*
 * 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.tuscany.sca.osgi.remoteserviceadmin.impl;

import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.tuscany.sca.assembly.Endpoint;
import org.apache.tuscany.sca.implementation.osgi.OSGiProperty;
import org.apache.tuscany.sca.interfacedef.Interface;
import org.apache.tuscany.sca.interfacedef.java.JavaInterface;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Constants;
import org.osgi.service.remoteserviceadmin.EndpointDescription;
import org.osgi.service.remoteserviceadmin.RemoteConstants;

/**
 * Implementation of {@link EndpointDescription}
 */
public class EndpointHelper {
    private EndpointHelper() {
    }

    public static EndpointDescription createEndpointDescription(BundleContext bundleContext, Endpoint endpoint) {
        return new EndpointDescription(getProperties(bundleContext, endpoint));
    }

    private static List<String> getInterfaces(Endpoint endpoint) {
        Interface intf = endpoint.getComponentServiceInterfaceContract().getInterface();
        JavaInterface javaInterface = (JavaInterface)intf;
        return Collections.singletonList(javaInterface.getName());
    }

    private static Map<String, Object> getProperties(BundleContext bundleContext, Endpoint endpoint) {
        Map<String, Object> props = new HashMap<String, Object>();
        
        if (!endpoint.isRemote()) {
            String uuid = OSGiHelper.getFrameworkUUID(bundleContext);
            props.put(RemoteConstants.ENDPOINT_FRAMEWORK_UUID, uuid);
        }
        
        for (Object ext : endpoint.getService().getExtensions()) {
            if (ext instanceof OSGiProperty) {
                OSGiProperty prop = (OSGiProperty)ext;
                props.put(prop.getName(), prop.getStringValue());
            }
        }
        
        String serviceID = (String)props.get(Constants.SERVICE_ID);
        if (serviceID != null) {
            props.put(RemoteConstants.ENDPOINT_SERVICE_ID, Long.parseLong(serviceID));
        }

        // FIXME: [rfeng] We need to calculate the intents supported by this endpoint
        /*
        QName bindingTypeName = endpoint.getBinding().getType();
        Definitions definitions = null;
        if(definitions!=null) {
        for(BindingType bindingType: definitions.getBindingTypes()) {
            if(bindingType.getType().equals(bindingTypeName)) {
                bindingType.getAlwaysProvidedIntents();
            }
        }
        */
        
        String intents = (String)props.get(RemoteConstants.SERVICE_EXPORTED_INTENTS);
        String extraIntents = (String)props.get(RemoteConstants.SERVICE_EXPORTED_INTENTS_EXTRA);
        if (intents == null) {
            intents = "";
        }
        if (extraIntents != null) {
            intents = intents + " " + extraIntents;
        }

        props.put(RemoteConstants.SERVICE_INTENTS, intents.trim());
        
        props.put(RemoteConstants.ENDPOINT_ID, endpoint.getURI());
        // FIXME: [rfeng] How to pass in the remote service id from the endpoint XML
        props.put(RemoteConstants.SERVICE_IMPORTED_CONFIGS, new String[] {"org.osgi.sca"});
        props.put(Endpoint.class.getName(), endpoint);
        List<String> interfaces = getInterfaces(endpoint);
        props.put(Constants.OBJECTCLASS, interfaces.toArray(new String[interfaces.size()]));
        return props;
    }

    public static Endpoint getEndpoint(EndpointDescription endpointDescription) {
        return (Endpoint)endpointDescription.getProperties().get(Endpoint.class.getName());
    }

}