Java DTV API 1.3
18-Nov-2009

com.sun.dtv.broadcast
Class BroadcastFilesystem

java.lang.Object
  extended by com.sun.dtv.broadcast.BroadcastFilesystem
All Implemented Interfaces:
Serializable

public class BroadcastFilesystem
extends Object
implements Serializable

This class represents instances of broadcast filesystems mounted into the local filesystem. That means every service transmitting a broadcast filesystem creates its own filesystem, depending on the definition of the transport stream.

See Also:
Serialized Form

Constructor Summary
BroadcastFilesystem(Locator l)
          Create and mount a broadcast filesystem defined by the given transport dependent locator.
BroadcastFilesystem(URL url)
          Create and mount a broadcast filesystem defined by the given URL.
 
Method Summary
static BroadcastFile getBroadcastRoot()
          Retrieves the system specific root mount point of all broadcast filesystems in the local filesystem.
static String getBroadcastRootPath()
          Retrieves the system specific root mount point of all broadcast filesystems in the local filesystem.
 BroadcastFile getMountLocation()
          Retrieve the root of this mounted broadcast filesystem.
 void unmount()
          Unmount this broadcast filesystem from the local filesystem.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BroadcastFilesystem

public BroadcastFilesystem(Locator l)
                    throws IOException,
                           IllegalArgumentException
Create and mount a broadcast filesystem defined by the given transport dependent locator.

Parameters:
l - the locator of the broadcast filesystem to be mounted
Throws:
IOException - if no broadcast filesystem exists at the given location.
IllegalArgumentException - if the given locator cannot be used to identify a broadcast filesystem.

BroadcastFilesystem

public BroadcastFilesystem(URL url)
                    throws IOException,
                           IllegalArgumentException
Create and mount a broadcast filesystem defined by the given URL. The provided URL has to follow the "file:" protocol as defined in RFC1630 "Universal Resource Identifiers in WWW" and RFC1738 "Uniform Resource Locators (URL)"

Parameters:
url - the URL of the broadcast filesystem to be mounted
Throws:
IOException - if no broadcast filesystem exists at the given location
IllegalArgumentException - if the given URL can't be used to identify a broadcast filesystem
Method Detail

unmount

public void unmount()
Unmount this broadcast filesystem from the local filesystem.


getMountLocation

public BroadcastFile getMountLocation()
                               throws IOException
Retrieve the root of this mounted broadcast filesystem.

Returns:
the location of this broadcast filesystem root.
Throws:
IOException - thrown if the filesystem is unmounted.

getBroadcastRoot

public static BroadcastFile getBroadcastRoot()
Retrieves the system specific root mount point of all broadcast filesystems in the local filesystem. A list of all available broadcast filesystems (no matter if mounted or not) can be retrieved from the returned BroadcastFile.listDirectory().

Returns:
the location of the broadcast root

getBroadcastRootPath

public static String getBroadcastRootPath()
Retrieves the system specific root mount point of all broadcast filesystems in the local filesystem.

Returns:
the path of root mount point

Java DTV API 1.3
18-Nov-2009

Copyright © 2008-2009 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All rights reserved.

U.S. Government Rights - Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions of the FAR and its supplements. Sun, Sun Microsystems, the Sun logo and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.Products covered by and information contained in this service manual are controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile, chemical biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and specially designated nationals lists is strictly prohibited.

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

Use of this document is subject to license terms.