Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright (c) OSGi Alliance (2000, 2011). 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;
 
A Driver service object must be registered by each Driver bundle wishing to attach to Device services provided by other drivers. For each newly discovered Device object, the device manager enters a bidding phase. The Driver object whose match(org.osgi.framework.ServiceReference) method bids the highest for a particular Device object will be instructed by the device manager to attach to the Device object.

Version:
$Id: 8d86c732bdc1e4d50c18a237427578472e13dcbf $
See also:
Device
DriverLocator
ThreadSafe:
 
 public interface Driver {
Checks whether this Driver service can be attached to the Device service. The Device service is represented by the given org.osgi.framework.ServiceReference and returns a value indicating how well this driver can support the given Device service, or Device.MATCH_NONE if it cannot support the given Device service at all.

The return value must be one of the possible match values defined in the device category definition for the given Device service, or Device.MATCH_NONE if the category of the Device service is not recognized.

In order to make its decision, this Driver service may examine the properties associated with the given Device service, or may get the referenced service object (representing the actual physical device) to talk to it, as long as it ungets the service and returns the physical device to a normal state before this method returns.

A Driver service must always return the same match code whenever it is presented with the same Device service.

The match function is called by the device manager during the matching process.

Parameters:
reference the ServiceReference object of the device to match
Returns:
value indicating how well this driver can support the given Device service, or Device.MATCH_NONE if it cannot support the Device service at all
Throws:
java.lang.Exception if this Driver service cannot examine the Device service
 
 	public int match(ServiceReference referencethrows Exception;

Attaches this Driver service to the Device service represented by the given ServiceReference object.

A return value of null indicates that this Driver service has successfully attached to the given Device service. If this Driver service is unable to attach to the given Device service, but knows of a more suitable Driver service, it must return the DRIVER_ID of that Driver service. This allows for the implementation of referring drivers whose only purpose is to refer to other drivers capable of handling a given Device service.

After having attached to the Device service, this driver may register the underlying device as a new service exposing driver-specific functionality.

This method is called by the device manager.

Parameters:
reference the ServiceReference object of the device to attach to
Returns:
null if this Driver service has successfully attached to the given Device service, or the DRIVER_ID of a more suitable driver
Throws:
java.lang.Exception if the driver cannot attach to the given device and does not know of a more suitable driver
	public String attach(ServiceReference referencethrows Exception;
New to GrepCode? Check out our FAQ X