org.ocap.hn.content

Class ContentEntryFactory

java.lang.Object

org.ocap.hn.content.ContentEntryFactory

public abstract class ContentEntryFactory
extends Object

This factory can be used to create ContentEntry instances. There are specialty methods for application convenience when creating channel content items.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContentEntryFactory() Singleton behavior.

Method Summary

Methods

Modifier and Type	Method and Description
abstract ChannelContentItem	createChannelContentItem(String channelType, String channelTitle, String channelName, String channelNumber, org.ocap.net.OcapLocator channelLocator, org.ocap.storage.ExtendedFileAccessPermissions permissions) Creates a new ChannelContentItem representing a broadcast channel.
static ContentEntryFactory	getInstance() Gets an instance of the factory.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentEntryFactory

protected ContentEntryFactory()

Singleton behavior.

Method Detail

getInstance

public static ContentEntryFactory getInstance()

Gets an instance of the factory.

Returns:

A content entry factory instance.

createChannelContentItem

public abstract ChannelContentItem createChannelContentItem(String channelType,
                                          String channelTitle,
                                          String channelName,
                                          String channelNumber,
                                          org.ocap.net.OcapLocator channelLocator,
                                          org.ocap.storage.ExtendedFileAccessPermissions permissions)

Creates a new ChannelContentItem representing a broadcast channel. A ChannelContentItem can only be added to a container created by createChannelGroupContainer.

This content item is not automatically added to a parent container. Applications can publish multiple channels in a single method call by creating an array of ChannelContentItem instances and passing it to the addContentEntries of a container created by createChannelGroupContainer in CDS.

At the point that the created ChannelContentItem is requested by a DMC, the implementation SHALL determine if the channelLocator is transport-dependent (e.g. a frequency-based Locator) and use the Locator to acquire the Service for streaming. If the channelLocator is a transport-independent (e.g. a sourceID-based) Locator and can be resolved via JavaTV, the implementation SHALL use JavaTV (e.g. SIManager.getService) to acquire the Service for streaming. If the transport-independent Locator cannot be resolved via JavaTV, and the Locator returned from getTuningLocator() is null, the implementation SHALL invoke the ServiceResolutionHandler.resolveChannelItem method. If resolveChannelItem returns true, the implementation SHALL use this Locator returned from getTuningLocator() to acquire the Service for streaming.

Parameters:

channelType - The type of broadcast channel, can be one of VIDEO_ITEM_BROADCAST or AUDIO_ITEM_BROADCAST defined in { @link ContentItem }.

channelTitle - The title of the new ChannelContentItem.

channelName - The name of the new ChannelContentItem.

channelNumber - String representing type and channel number, where type must be "Analog" or "Digital", number is (major channel number) for analog channels, and number is (major channel and minor channel) for digital channels, in the format "type, number [, number]". For example: "Analog,12", or "Digital,15,2". May also be null, when application is not providing this information.

channelLocator - An OcapLocator for the channel

permissions - Access permissions of the new ChannelContentItem for local server applications only.

Returns:

true if a new ChannelContentItem has been created, otherwise return false.

Throws:

IllegalArgumentException - if channelType is not AUDIO_ITEM_BROADCAST or VIDEO_ITEM_BROADCAST, or if channelNumber format is invalid.

NullPointerException - if channelName, channelTitle, or channelLocator arguments passed to this method are null.

SecurityException - if the caller does not have HomeNetPermission("contentmanagement").