org.osgi.service.device.Constants Maven / Gradle / Ivy

/*
 * Copyright (c) OSGi Alliance (2000, 2013). 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.device;

/**
 * This interface defines standard names for property keys associated with
 * {@link Device} and {@link Driver} services.
 * 
 * 
 * The values associated with these keys are of type {@code java.lang.String},
 * unless otherwise stated.
 * 
 * @noimplement
 * @author $Id: 967b949d668d2d3b7edf650369c19b3f48a67373 $
 * @since 1.1
 * @see Device
 * @see Driver
 */
public interface Constants {
	/**
	 * Property (named "DRIVER_ID") identifying a driver.
	 * 
	 * 

	 * A {@code DRIVER_ID} should start with the reversed domain name of the
	 * company that implemented the driver (e.g., {@code com.acme}), and must
	 * meet the following requirements:
	 * 
	 * 

	 * It must be independent of the location from where it is obtained.
	 * It must be independent of the {@link DriverLocator} service that
	 * downloaded it.
	 * It must be unique.
	 * It must be different for different revisions of the same driver.
	 * 
	 * 
	 * 
	 * This property is mandatory, i.e., every {@code Driver} service must be
	 * registered with it.
	 */
	public static final String	DRIVER_ID			= "DRIVER_ID";
	/**
	 * Property (named "DEVICE_CATEGORY") containing a human readable
	 * description of the device categories implemented by a device. This
	 * property is of type {@code String[]}
	 * 
	 * 
	 * Services registered with this property will be treated as devices and
	 * discovered by the device manager
	 */
	public static final String	DEVICE_CATEGORY		= "DEVICE_CATEGORY";
	/**
	 * Property (named "DEVICE_SERIAL") specifying a device's serial
	 * number.
	 */
	public static final String	DEVICE_SERIAL		= "DEVICE_SERIAL";
	/**
	 * Property (named "DEVICE_DESCRIPTION") containing a human
	 * readable string describing the actual hardware device.
	 */
	public static final String	DEVICE_DESCRIPTION	= "DEVICE_DESCRIPTION";
}