org.osgi.service.component.runtime.dto.UnsatisfiedReferenceDTO Maven / Gradle / Ivy

/*
 * Copyright (c) OSGi Alliance (2013, 2014). All Rights Reserved.
 *
 * Licensed 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.osgi.service.component.runtime.dto;

import org.osgi.dto.DTO;
import org.osgi.framework.dto.ServiceReferenceDTO;

/**
 * A representation of an unsatisfied reference.
 * 
 * @since 1.3
 * @NotThreadSafe
 * @author $Id: UnsatisfiedReferenceDTO.java 1777635 2017-01-06 16:13:24Z cziegeler $
 */
public class UnsatisfiedReferenceDTO extends DTO {
	/**
	 * The name of the declared reference.
	 * 
	 * 
	 * This is declared in the {@code name} attribute of the {@code reference}
	 * element of the component description.
	 * 
	 * @see ReferenceDTO#name
	 */
	public String					name;

	/**
	 * The target property of the unsatisfied reference.
	 * 
	 * 

	 * This is the value of the {@link ComponentConfigurationDTO#properties
	 * component property} whose name is the concatenation of the
	 * {@link ReferenceDTO#name declared reference name} and
	 * ".target". This must be {@code null} if no target property is
	 * set for the reference.
	 */
	public String					target;

	/**
	 * The target services.
	 * 
	 * 
	 * Each {@link ServiceReferenceDTO} in the array represents a target service
	 * for the reference. The array must be empty if there are no target
	 * services. The upper bound on the number of target services in the array
	 * is the upper bound on the {@link ReferenceDTO#cardinality cardinality} of
	 * the reference.
	 */
	public ServiceReferenceDTO[]	targetServices;
}