com.sun.tv.si

Class TransportImpl

java.lang.Object

com.sun.tv.si.TransportImpl

All Implemented Interfaces:

BouquetCollection, NetworkCollection, Transport, TransportStreamCollection

public class TransportImpl
extends Object
implements BouquetCollection, NetworkCollection, TransportStreamCollection

This interface represents an individual content delivery mechanism. Transport objects serve as an access point for acquiring information about services and their groupings.

A Transport object may expose various types of entities (e.g. Bouquets, Networks and/or TransportStreams) by implementing additional optional interfaces (i.e. BouquetCollection, NetworkCollection, and/or TransportStreamCollection), depending on the particular SI format used and the presence of optional elements and tables in the SI data being broadcast.

See Also:

BouquetCollection, NetworkCollection, TransportStreamCollection

Constructor Summary

Constructors

Constructor and Description
TransportImpl(int transportID, DeliverySystemType deliverySystemType)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBouquetChangeListener(BouquetChangeListener listener) Registers a BouquetChangeListener to be notified of changes to a Bouquet that is part of this BouquetCollection.
void	addNetworkChangeListener(NetworkChangeListener listener) Registers a NetworkChangeListener to be notified of changes to a Network that is part of this NetworkCollection.
void	addServiceDetailsChangeListener(ServiceDetailsChangeListener listener) Registers a ServiceDetailsChangeListener to be notified of changes to ServiceDetails that are carried on this Transport.
void	addTransportStreamChangeListener(TransportStreamChangeListener listener) Registers a TransportStreamChangeListener to be notified of changes to a TransportStream that is part of this TransportStreamCollection.
DeliverySystemType	getDeliverySystemType() Reports the type of mechanism by which this Transport delivers content.
void	notifyBouquetListeners(BouquetChangeEvent event) Notify all listeners that the bouquet has changed.
void	notifyNetworkListeners(NetworkChangeEvent event) Notify all listeners that the bouquet has changed.
void	notifyServiceDetailsListeners(ServiceDetailsChangeEvent event) Notify all listeners that this transport has been changed.
void	notifyTransportStreamListeners(TransportStreamChangeEvent event) Notify all listeners that the transport stream has changed.
void	removeBouquetChangeListener(BouquetChangeListener listener) Called to unregister an BouquetChangeListener.
void	removeNetworkChangeListener(NetworkChangeListener listener) Called to unregister an NetworkChangeListener.
void	removeServiceDetailsChangeListener(ServiceDetailsChangeListener listener) Called to unregister an ServiceDetailsChangeListener.
void	removeTransportStreamChangeListener(TransportStreamChangeListener listener) Called to unregister an TransportStreamChangeListener.
SIRequest	retrieveBouquet(Locator locator, SIRequestor requestor) Retrieves the specified Bouquet from the collection.
SIRequest	retrieveBouquets(SIRequestor requestor) Retrieves an array of all the Bouquet objects in this BouquetCollection.
SIRequest	retrieveNetwork(Locator locator, SIRequestor requestor) Retrieves the specified Network from the collection.
SIRequest	retrieveNetworks(SIRequestor requestor) Retrieves an array of all the Network objects in this NetworkCollection.
SIRequest	retrieveTransportStream(Locator locator, SIRequestor requestor) Retrieves the specified TransportStream from the collection.
SIRequest	retrieveTransportStreams(Locator locator, SIRequestor requestor) Retrieves an array of TransportStream objects representing the transport streams carried in the specified Network.
SIRequest	retrieveTransportStreams(SIRequestor requestor) Retrieves an array of the TransportStream objects in this TransportStreamCollection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransportImpl

public TransportImpl(int transportID,
             DeliverySystemType deliverySystemType)

Method Detail

getDeliverySystemType

public DeliverySystemType getDeliverySystemType()

Reports the type of mechanism by which this Transport delivers content.

Specified by:

getDeliverySystemType in interface Transport

Returns:

The delivery system type of this transport.

addServiceDetailsChangeListener

public void addServiceDetailsChangeListener(ServiceDetailsChangeListener listener)
                                     throws SecurityException

Registers a ServiceDetailsChangeListener to be notified of changes to ServiceDetails that are carried on this Transport. Subsequent notification is made via ServiceDetailsChangeEvent with this Transport instance as the event source.

This method is only a request for notification. No guarantee is provided that the SI database will detect all, or even any, SI changes or whether such changes will be detected in a timely fashion.

If the specified ServiceDetailsChangeListener is already registered, no action is performed.

Specified by:

addServiceDetailsChangeListener in interface Transport

Parameters:

listener - An ServiceDetailsChangeListener to be notified about changes related to ServiceDetails carried on this Transport.

Throws:

SecurityException - If the caller does not have javax.tv.service.ReadPermission(locator) for this Transport.

See Also:

ServiceDetailsChangeEvent, ReadPermission

removeServiceDetailsChangeListener

public void removeServiceDetailsChangeListener(ServiceDetailsChangeListener listener)

Called to unregister an ServiceDetailsChangeListener. If the specified ServiceDetailsChangeListener is not registered, no action is performed.

Specified by:

removeServiceDetailsChangeListener in interface Transport

Parameters:

listener - A previously registered listener.

notifyServiceDetailsListeners

public void notifyServiceDetailsListeners(ServiceDetailsChangeEvent event)

Notify all listeners that this transport has been changed.

retrieveBouquet

public SIRequest retrieveBouquet(Locator locator,
                        SIRequestor requestor)
                          throws InvalidLocatorException,
                                 SecurityException

Retrieves the specified Bouquet from the collection.

This method delivers its results asynchronously.

Specified by:

retrieveBouquet in interface BouquetCollection

Parameters:

locator - Locator referencing the Bouquet of interest

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieval request.

Throws:

InvalidLocatorException - If locator does not reference a valid bouquet.

SecurityException - if the caller does not have javax.tv.service.ReadPermission(locator)

See Also:

Bouquet, ReadPermission

retrieveBouquets

public SIRequest retrieveBouquets(SIRequestor requestor)

Retrieves an array of all the Bouquet objects in this BouquetCollection. This array will only contain Bouquet instances for which the caller has javax.tv.service.ReadPermission on the underlying locator.

This method delivers its results asynchronously.

Specified by:

retrieveBouquets in interface BouquetCollection

Parameters:

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieval request.

See Also:

Bouquet

retrieveNetwork

public SIRequest retrieveNetwork(Locator locator,
                        SIRequestor requestor)
                          throws InvalidLocatorException,
                                 SecurityException

Retrieves the specified Network from the collection.

This method delivers its results asynchronously.

Specified by:

retrieveNetwork in interface NetworkCollection

Parameters:

locator - Locator referencing the Network of interest.

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieval request.

Throws:

InvalidLocatorException - If locator does not reference a valid network.

SecurityException - if the caller does not have javax.tv.service.ReadPermission(locator)

See Also:

Network, ReadPermission

retrieveNetworks

public SIRequest retrieveNetworks(SIRequestor requestor)

Retrieves an array of all the Network objects in this NetworkCollection. The collection will only contain instances for which the caller has javax.tv.service.ReadPermission on the underlying locator.

This method delivers its results asynchronously.

Specified by:

retrieveNetworks in interface NetworkCollection

Parameters:

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieval request.

See Also:

Network

retrieveTransportStream

public SIRequest retrieveTransportStream(Locator locator,
                                SIRequestor requestor)
                                  throws InvalidLocatorException,
                                         SecurityException

Retrieves the specified TransportStream from the collection.

Specified by:

retrieveTransportStream in interface TransportStreamCollection

Parameters:

locator - Locator referencing the TransportStream of interest

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieval request.

Throws:

InvalidLocatorException - If locator does not reference a valid transport stream.

SecurityException - if the caller does not have javax.tv.service.ReadPermission(locator)

See Also:

TransportStream, ReadPermission

retrieveTransportStreams

public SIRequest retrieveTransportStreams(SIRequestor requestor)

Retrieves an array of the TransportStream objects in this TransportStreamCollection. Only TransportStream instances for which the caller has javax.tv.service.ReadPermission on the underlying locator will be present in the array.

This method delivers its results asynchronously.

Specified by:

retrieveTransportStreams in interface TransportStreamCollection

Parameters:

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieval request.

See Also:

TransportStream, ReadPermission

retrieveTransportStreams

public SIRequest retrieveTransportStreams(Locator locator,
                                 SIRequestor requestor)
                                   throws InvalidLocatorException,
                                          SecurityException

Retrieves an array of TransportStream objects representing the transport streams carried in the specified Network.

This method delivers its results asynchronously.

Parameters:

locator - A locator referencing a Network from which to retrieve transport stream information.

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieval request.

Throws:

InvalidLocatorException - If locator does not reference a valid Network on the Transport implementing this interface.

SecurityException - if the caller does not have javax.tv.service.ReadPermission(locator)

See Also:

TransportStream, Transport, ReadPermission

addBouquetChangeListener

public void addBouquetChangeListener(BouquetChangeListener listener)
                              throws SecurityException

Registers a BouquetChangeListener to be notified of changes to a Bouquet that is part of this BouquetCollection. Subsequent notification is made via BouquetChangeEvent with this BouquetCollection as the event source.

This method is only a request for notification. No guarantee is provided that the SI database will detect all, or even any, SI changes or whether such changes will be detected in a timely fashion.

If the specified BouquetChangeListener is already registered, no action is performed.

Specified by:

addBouquetChangeListener in interface BouquetCollection

Parameters:

listener - A BouquetChangeListener to be notified about changes related to Bouquet carried on this Transport.

Throws:

SecurityException - If the caller does not have javax.tv.service.ReadPermission(locator).

See Also:

BouquetChangeEvent, ReadPermission

removeBouquetChangeListener

public void removeBouquetChangeListener(BouquetChangeListener listener)

Called to unregister an BouquetChangeListener. If the specified BouquetChangeListener is not registered, no action is performed.

Specified by:

removeBouquetChangeListener in interface BouquetCollection

Parameters:

listener - A previously registered listener.

notifyBouquetListeners

public void notifyBouquetListeners(BouquetChangeEvent event)

Notify all listeners that the bouquet has changed.

addNetworkChangeListener

public void addNetworkChangeListener(NetworkChangeListener listener)
                              throws SecurityException

Registers a NetworkChangeListener to be notified of changes to a Network that is part of this NetworkCollection. Subsequent notification is made via NetworkChangeEvent with this NetworkCollection as the event source.

This method is only a request for notification. No guarantee is provided that the SI database will detect all, or even any, SI changes or whether such changes will be detected in a timely fashion.

If the specified NetworkChangeListener is already registered, no action is performed.

Specified by:

addNetworkChangeListener in interface NetworkCollection

Parameters:

listener - A NetworkChangeListener to be notified about changes related to Network carried on this Transport.

Throws:

SecurityException - If the caller does not have javax.tv.service.ReadPermission(locator).

See Also:

NetworkChangeEvent, ReadPermission

removeNetworkChangeListener

public void removeNetworkChangeListener(NetworkChangeListener listener)

Called to unregister an NetworkChangeListener. If the specified NetworkChangeListener is not registered, no action is performed.

Specified by:

removeNetworkChangeListener in interface NetworkCollection

Parameters:

listener - A previously registered listener.

notifyNetworkListeners

public void notifyNetworkListeners(NetworkChangeEvent event)

Notify all listeners that the bouquet has changed.

addTransportStreamChangeListener

public void addTransportStreamChangeListener(TransportStreamChangeListener listener)
                                      throws SecurityException

Registers a TransportStreamChangeListener to be notified of changes to a TransportStream that is part of this TransportStreamCollection. Subsequent notification is made via TransportStreamChangeEvent with this TransportStreamCollection as the event source.

This method is only a request for notification. No guarantee is provided that the SI database will detect all, or even any, SI changes or whether such changes will be detected in a timely fashion.

If the specified TransportStreamChangeListener is already registered, no action is performed.

Specified by:

addTransportStreamChangeListener in interface TransportStreamCollection

Parameters:

listener - A TransportStreamChangeListener to be notified about changes related to TransportStream carried on this Transport.

Throws:

SecurityException - If the caller does not have javax.tv.service.ReadPermission(locator).

See Also:

TransportStreamChangeEvent, ReadPermission

removeTransportStreamChangeListener

public void removeTransportStreamChangeListener(TransportStreamChangeListener listener)

Called to unregister an TransportStreamChangeListener. If the specified TransportStreamChangeListener is not registered, no action is performed.

Specified by:

removeTransportStreamChangeListener in interface TransportStreamCollection

Parameters:

listener - A previously registered listener.

notifyTransportStreamListeners

public void notifyTransportStreamListeners(TransportStreamChangeEvent event)

Notify all listeners that the transport stream has changed.