Commit d38bbd30 authored by ocaptst_build's avatar ocaptst_build

Merging mostly cosmetic changes from trunk to 1.2.1 REL-A tag before 1.2.1 Release

parent d78e1b21
......@@ -3,6 +3,7 @@ package org.ocap.hn;
import org.ocap.hn.content.navigation.ContentList;
import org.ocap.hn.service.ServiceResolutionHandler;
import org.ocap.hn.content.StreamingActivityListener;
import org.dvb.spi.selection.SelectionProvider;
/**
* <p>
......@@ -244,7 +245,7 @@ public interface ContentServerNetModule extends NetModule
* needs tuning information for a ChannelContentItem (e.g. a switched
* channel).
* <p>
* If an SPI service provider is already registered for the "ocap://" scheme
* If an SPI service provider is already registered for the “ocap://” scheme
* this method throws an exception. If an SPI service provider
* (e.g. {@link SelectionProvider}) is subsequently registered, it SHALL have
* precedence over the registered {@link ServiceResolutionHandler}
......@@ -274,21 +275,21 @@ public interface ContentServerNetModule extends NetModule
* notification of streaming being started, changed or ended.
*
* @param contentTypes the contentItem types <code>StreamingActivityListener</code>
* is interested in. Defined in <code>StreamingActivityListener</code>
* 0 for all content with streamable resources
* 1 for ChannelContentItem and virtual tuners only
* 2 for RecordingContentItem only
* is interested in. Defined in <code>StreamingActivityListener</code>
* 0 for all content with streamable resources
* 1 for ChannelContentItem and virtual tuners only
* 2 for RecordingContentItem only
*
* @throws UnsupportedOperationException if the isLocal method returns false.
*
* @throws IllegalArgumentException if contentTypes is not one of the types defined
* in <code>StreamingActivityListener</code>.
* in <code>StreamingActivityListener</code>.
*/
public void addStreamingActivityListener(StreamingActivityListener listener, int contentTypes);
/**
* Removes the specified <code>StreamingActivityListener</code> for all contentItem types
* specified in <code> addStreamingActivityListener </code>.
* specified in <code>addStreamingActivityListener</code>
*
* @param listener the <code>StreamingActivityListener</code> to remove.
*/
......
/*
* Copyright Matsushita Electric Industrial Co., Ltd.2004
* All Rights Reserved
*/
package org.ocap.hn;
/**
......
/*
* Copyright Matsushita Electric Industrial Co., Ltd.2004
* All Rights Reserved
*/
package org.ocap.hn;
/**
......
/*
* Copyright Matsushita Electric Industrial Co., Ltd.2004
* All Rights Reserved
*/
package org.ocap.hn;
/**
......
/*
* Copyright Matsushita Electric Industrial Co., Ltd.2004
* All Rights Reserved
*/
package org.ocap.hn;
/**
......
/*
* Copyright Matsushita Electric Industrial Co., Ltd.2004
* All Rights Reserved
*/
package org.ocap.hn;
/**
......
......@@ -5,7 +5,6 @@ import org.ocap.net.OcapLocator;
import org.ocap.storage.ExtendedFileAccessPermissions;
import javax.tv.locator.InvalidLocatorException;
/**
* This interface represents a video or audio broadcast channel object.
*/
......@@ -65,32 +64,38 @@ public interface ChannelContentItem extends ContentItem
public OcapLocator getTuningLocator();
/**
* Sets the tuning locator for this ChannelContentItem that the
* <p>Sets the tuning locator for this ChannelContentItem that the
* implementation can use for tuning a broadcast channel. Returns false
* if the #isLocal method returns false.
* </p>
* Setting the tuning locator to a null locator makes the channel
* <p>
* An application may call this method to update a channel's tuning parameters (for example,
* when an SDV channel's program number or frequency changes). Upon a successful update of
* the channel's tuning parameters the implementation SHALL be responsible for updating
* any active streaming sessions to the new tuning parameters. When a JavaTV Service represents
* this ChannelContentItem the implementation SHALL modify the transport dependent locator
* of the Service to match the locator parameter.
* </p>
* <p>
* Setting the channel tuning locator to a null locator makes the channel
* item no longer tunable (for example, when the application ends an SDV
* session). Setting the tuning locator to null while streaming ends
* session).
* Setting the tuning locator to null while streaming ends
* streaming, removes the locator,
* and {@link StreamingActivityListener#notifyStreamingEnded}
* is called with an activityID of <code>ACTIVITY_END_SERVICE_VANISHED
* </code>.
* </p>
* When a JavaTV Service represents this ChannelContentItem the implementation
* SHALL modify the transport dependent locator of the Service to match
* the locator parameter.
*
* @param locator A frequency-based locator for the channel, or null to
* remove the current locator.
*
* @return True when the locator parameter is set correctly, otherwise,
* returns false
* @return true when the locator parameter is set correctly, otherwise,
* returns false.
*
* @throws InvalidLocatorException if the locator parameter is not
* frequency based and is not null.
*
*
* frequency based and is not null.
*
* @throws SecurityException if the calling application is not granted
* write permission by the permissions returned from the
* getExtendedFileAccessPermissions method.
......
......@@ -305,14 +305,14 @@ public interface ContentContainer extends ContentEntry
* instances only. If the #isLocal method returns false, an exception is
* thrown.
*
* @return True if all of the ContentEntry objects required to be
* deleted are deleted, otherwise returns false (e.g. ContentContainer entries
* are not required to be deleted)
* @return true if all of the ContentEntry objects required to be deleted are
* deleted, otherwise returns false (e.g. ContentContainer entries
* are not required to be deleted).
*
* @throws SecurityException if the caller does not have
* HomeNetPermission("contentmanagement"), or if the caller
* does not have write permission on this container or
* and entries contained in this container (except for
* any entries contained in this container (except for
* ContentContainer entries).
*
* @throws java.io.IOException if this ContentContainer is not local.
......@@ -323,14 +323,14 @@ public interface ContentContainer extends ContentEntry
* Deletes this ContentContainer and all of the ContentEntry objects in this
* container. Calls the {@link ContentEntry#deleteEntry} method on each
* ContentEntry in a recursive manner. This method deletes local
* ContentEntry instances only. If the #isLocal method returns false,
* ContentEntry instances only. If the #isLocal method returns false,
* an exception is thrown.
*
* If a SecurityException is thrown due to insufficient write access permissions
* on any entry contained within this ContentContainer, this method MAY delete
* a partial subset of the entries contained within.
*
* @return True if this ContentContainer and all of the ContentEntry objects in this container were
* @return true if this ContentContainer and all of the ContentEntry objects in this container were
* deleted, otherwise returns false.
*
* @throws SecurityException if the caller does not have
......@@ -383,7 +383,7 @@ public interface ContentContainer extends ContentEntry
* @return True if the entry was added. Returns false if the isLocal
* method of this ContentContainer or the parameter ContentEntry
* returns false. Returns false if this ContentContainer is a channel
* group container, and the entry is not a ChannelContentItem.
* group container, and the entry is not a ChannelContentItem.
*
* @throws IllegalStateException if this ContentContainer does not have
* a parentID property, i.e., this ContentContainer is not added
......
......@@ -52,7 +52,7 @@ public abstract class ContentEntryFactory
* ServiceResolutionHandler.resolveChannelItem method. If resolveChannelItem
* returns true, the
* implementation SHALL use this Locator returned from getTuningLocator()
* to acquire the Service for streaming.
* to acquire the Service for streaming.
* </p>
*
* @param channelType The type of broadcast channel, can be one of
......@@ -66,7 +66,7 @@ public abstract class ContentEntryFactory
* 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.
* @param channelLocator An <code>OcapLocator</code> for the channel.
* @param channelLocator An <code>OcapLocator</code> for the channel
* @param permissions Access permissions of the new
* <code>ChannelContentItem</code> for local server applications only.
*
......@@ -76,10 +76,8 @@ public abstract class ContentEntryFactory
* @throws IllegalArgumentException if channelType is not
* AUDIO_ITEM_BROADCAST or VIDEO_ITEM_BROADCAST,
* or if channelNumber format is invalid.
*
* @throws NullPointerException if channelName, channelTitle,
* or channelLocator arguments passed to this method are null.
*
* @throws SecurityException if the caller does not have
* HomeNetPermission("contentmanagement").
*/
......@@ -90,4 +88,4 @@ public abstract class ContentEntryFactory
String channelNumber,
OcapLocator channelLocator,
ExtendedFileAccessPermissions permissions);
}
}
\ No newline at end of file
//Generated code by CodeGen Copyright Philips Tue Jun 08 13:22:21 BST 2004
//Contact Dale.Heron@philips.com
package org.ocap.hn.content;
......
......@@ -16,11 +16,11 @@ public interface StreamingActivityListener extends EventListener
/*
* The service vanished from the network.
*/
public final static int ACTIVITY_END_SERVICE_VANISHED = 1;
public final static int ACTIVITY_END_SERVICE_VANISHED = 1;
/*
* Resources needed to present the service have been removed.
*/
*/
public final static int ACTIVITY_END_RESOURCE_REMOVED = 3;
/*
......@@ -28,9 +28,9 @@ public interface StreamingActivityListener extends EventListener
*/
public final static int ACTIVITY_END_ACCESS_WITHDRAWN = 4;
/*
* The application or user requested that the presentation be stopped.
*/
/*
* The application or user requested that the presentation be stopped.
*/
public final static int ACTIVITY_END_USER_STOP = 5;
/*
......@@ -42,12 +42,13 @@ public interface StreamingActivityListener extends EventListener
* The presentation was terminated due to an unknown reason or for multiple reasons
*/
public final static int ACTIVITY_END_OTHER = 255;
/**
* contentTypes.
*/
public final static int CONTENT_TYPE_ALL_RESOURCES = 0;
public final static int CONTENT_TYPE_LIVE_RESOURCES = 1;
public final static int CONTENT_TYPE_RECORDED_RESOURCES = 2;
*/
public final static int CONTENT_TYPE_ALL_RESOURCES = 0;
public final static int CONTENT_TYPE_LIVE_RESOURCES = 1;
public final static int CONTENT_TYPE_RECORDED_RESOURCES = 2;
/**
* Notifies the <code>StreamingActivityListener</code> when content begins
......
package org.ocap.hn.resource;
import org.dvb.application.AppID;
import org.ocap.resource.ResourceUsage;
import org.ocap.net.OcapLocator;
......
......@@ -43,7 +43,7 @@ public interface NetAuthorizationHandler
*
* @param actionName Name of the action received. Will match a name
* in the {@code actionNames} parameter previously passed to
* {@link NetSecurityManager#.setAuthorizationHandler(NetAuthorizationHandler, String[] boolean)}.
* {@link NetSecurityManager#setAuthorizationHandler(NetAuthorizationHandler, String[], boolean)}.
* @param inetAddress IP address the transaction was sent from.
* @param macAddress An empty string; this parameter is not used.
* @param activityID The unique identifier of the activity if known. If
......
......@@ -8,11 +8,14 @@ import org.ocap.hn.content.ChannelContentItem;
* non-tunable ChannelContentItem, such as an SDV channel. If a
* <code>ServiceResolutionHandler</code> is not registered then
* the implementation fails any attempts to tune to such channels.
*
* <p>
* This interface also provides a handler that can be used by
* the implementation to notify the application that tuning attempts with
* the application provided locator for a broadcast
* channel item have failed.
* <p>
* Note: This interface is intended to be used by applications which do not
* provide a DVB SPI SelectionProvider for the "ocap" scheme.
*/
public interface ServiceResolutionHandler
{
......@@ -23,7 +26,8 @@ public interface ServiceResolutionHandler
* @param channel A ChannelContentItem
*
* @return If the return value is true, the implementation SHALL
* retry tuning; if the return value is false, the implementation SHALL
* retry tuning using the current value of the ChannelContentItem's tuning locator;
* if the return value is false or the tuning locator is null, the implementation SHALL
* fail the tuning request.
*/
public boolean notifyTuneFailed(ChannelContentItem channel);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment