org.apache.tuscany.sca.assembly.Reference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tuscany-base-runtime
There is a newer version: 2.0.1
/*
 * 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.assembly;

import java.util.List;

/**
 * Represents a reference. References within an implementation represent links
 * to services that the implementation uses that must be provided by other
 * components.
 * 
 * @version $Rev: 1068209 $ $Date: 2011-02-07 23:07:58 +0000 (Mon, 07 Feb 2011) $
 * @tuscany.spi.extension.asclient
 */
public interface Reference extends AbstractReference, Contract {

    /**
     * Returns a boolean value, "false" by default, which indicates that the
     * implementation wires this reference dynamically.
     * 
     * @return true if the implementation wires this reference dynamically
     */
    boolean isWiredByImpl();

    /**
     * Sets a boolean value, "false" by default, which indicates that the
     * implementation wires this reference dynamically.
     * 
     * @param wiredByImpl whether the implementation wires this reference
     *            dynamically
     */
    void setWiredByImpl(boolean wiredByImpl);


    /**
     * Returns the targets of this reference.
     * 
     * @return the targets of this reference.
     */
    List getTargets();

    /**
     * Returns the endpoint references implied by this reference.
     *  
     * Endpoint references are used to represent:
     * 
     *   - manually specified reference targets
     *   - reference targets determined by autowire
     *   - manually configured remote bindings
     *   
     * @return the endpoint references implied by this reference
     */
    List getEndpointReferences();
    
    /**
     * Indicate if the reference allows pass by reference for remotable operations
     */
    boolean isAllowsPassByReference();
    
    /**
     * @param allowsPassByReference the allowsPassByReference to set
     */
    void setAllowsPassByReference(boolean allowsPassByReference);
}