Interface marimba.channel.ApplicationContext
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface marimba.channel.ApplicationContext

public interface ApplicationContext
extends Object
This provides the context for an Application. It is the interface of the application to the tuner.
Version:
1.18, 01/13/97
Author:
Arthur van Hoff, Maurice Balick

Method Index

 o appendLog(byte[])
Logs an array of bytes for the channel.
 o appendLog(String)
Logs a String for the channel.
 o channelFileExists(String)
Returns true if the specified path exists for this channel.
 o getAudioClip(URL)
Get an audio clip.
 o getBase()
Get the base URL of this channel.
 o getChannelDirectory()
OBSOLETE.
 o getChannelName()
Get the name of this channel.
 o getChannelStatus(String)
Get the status of a channel on this transmitter.
 o getCodeBase()
Get the code base URL of this channel.
 o getDataBase()
Get the base URL for the data directory of this channel.
 o getDataDirectory()
Gets the base data directory for this channel.
 o getImage(URL)
Get an image.
 o getParameter(String)
Get an application parameter.
 o getPendingUpdates()
Gets the UpdateReport for this channel.
 o getProfile()
Get the profile data associated with this channel.
 o getServerName()
Get the name of the server of this channel.
 o installData(String)
Request the installation of new all new data or just part in the given directory.
 o listChannelDirectory(String)
Returns an array of strings which are the names of files in the specified directory.
 o listChannels()
Get a list of all the channels on this transmitter which have been subscribed to by the user.
 o publishTime()
Return the time at which this version of the channel was published.
 o removeChannel(String)
Remove a channel from this transmitter
 o restart()
Restart the application.
 o setProfile(byte[])
Set the profile for a channel.
 o showDocument(String)
Show a document.
 o showDocument(String, String)
Show a Document in a frame.
 o showDocument(URL)
Show a document.
 o showDocument(URL, String)
Show a document in a named frame.
 o showStatus(String)
Show status.
 o startChannel(String, String)
Start a channel.
 o stop()
Stop the application.
 o subscribeChannel(String, String)
Subscribe to a channel, but don't start it yet.
 o unsubscribeChannel(String)
Unsubscribe a channel from this transmitter
 o update()
Update the application.
 o updateTime()
Return the time the channel was updated with new data.

Methods

 o getBase
  public abstract URL getBase()
Get the base URL of this channel.
 o getCodeBase
  public abstract URL getCodeBase()
Get the code base URL of this channel. This is where the code for the channel is stored.
 o getDataBase
  public abstract URL getDataBase()
Get the base URL for the data directory of this channel. This is where the directory where the channel can store persistent data.
See Also:
getDataDirectory
 o channelFileExists
  public abstract boolean channelFileExists(String path)
Returns true if the specified path exists for this channel. Path must be a relative pathname.
 o listChannelDirectory
  public abstract String[] listChannelDirectory(String directory)
Returns an array of strings which are the names of files in the specified directory. Directory is a relative path. To list the root of a channel, directory should be "". Returns null if directory does not exist or is not a directory.
 o getDataDirectory
  public abstract String getDataDirectory()
Gets the base data directory for this channel. This directory can be used to store persistent data. It also contains logging and profiling data. An un authenticated channel is not allowed to write anywhere else in the file system.
 o getPendingUpdates
  public abstract Updates getPendingUpdates()
Gets the UpdateReport for this channel. The update report can be queried for a list of all the pending changes in this channel, e.g., a list of the deletions, creations and updates that are pending. Returns null if there are no existing updates of any kind pending on this channel.
See Also:
Updates
 o getChannelDirectory
  public abstract String getChannelDirectory()
OBSOLETE. Will be removed in a future release
See Also:
getBase, channelFileExists, listChannelDirectory
 o getServerName
  public abstract String getServerName()
Get the name of the server of this channel. The server name is of the form: "hostname:port".
 o getChannelName
  public abstract String getChannelName()
Get the name of this channel.
 o getParameter
  public abstract String getParameter(String nm)
Get an application parameter. The application parameters are specified in a properties file in the application directory. Application parameters are case-insensitive.
 o installData
  public abstract void installData(String dir)
Request the installation of new all new data or just part in the given directory. Pass an empty string to install the entire channel.
 o appendLog
  public abstract boolean appendLog(byte data[])
Logs an array of bytes for the channel. The log data is sent back to the transmitter at some point in the future, usually when the next update is requested. Returns false if an error occurred while creating the log entry.
 o appendLog
  public abstract boolean appendLog(String data)
Logs a String for the channel. The log data is sent back to the transmitter at some point in the future, usually when the next update is requested. Returns false if an error occurred while creating the log entry.
 o getProfile
  public abstract byte[] getProfile()
Get the profile data associated with this channel. This data is included in every request to the transmitter and can be used for profiling. This will return null an error occurred while reading the profile. It will return an empty profile if no profile was created yet.
 o setProfile
  public abstract boolean setProfile(byte data[])
Set the profile for a channel. This data is included in every request to the transmitter and can be used for profiling. This will the override the previous profiling data (if any). The profile data is application specific and can be any format you like. The profile data can be deleting by passing in null. Returns false if the profile could not be saved.
 o publishTime
  public abstract long publishTime()
Return the time at which this version of the channel was published.
 o updateTime
  public abstract long updateTime()
Return the time the channel was updated with new data.
 o restart
  public abstract void restart()
Restart the application. The application can call this method after recieving a notifyAvailable() call. As a result the channel is stopped and restarted with the new changes.
 o stop
  public abstract void stop()
Stop the application. The application should call this methods to notify the tuner that it wants to be destroyed. A call to stop() and destroy() will follow shortly.
 o update
  public abstract void update()
Update the application. The application can call this to request an update to occur. This will cause the tuner to contact the transmitter (which will happen automatically some small amount of time after this call) to find out if an update is needed.
 o startChannel
  public abstract void startChannel(String serverName,
                                    String channelName)
Start a channel.
 o subscribeChannel
  public abstract void subscribeChannel(String serverName,
                                        String channelName)
Subscribe to a channel, but don't start it yet.
 o unsubscribeChannel
  public abstract void unsubscribeChannel(String channelName)
Unsubscribe a channel from this transmitter
 o removeChannel
  public abstract void removeChannel(String channelName)
Remove a channel from this transmitter
 o listChannels
  public abstract String[] listChannels()
Get a list of all the channels on this transmitter which have been subscribed to by the user.
 o getChannelStatus
  public abstract String getChannelStatus(String channelName)
Get the status of a channel on this transmitter. The status will be "unsubscribed", "subscribed", or "running".
 o getAudioClip
  public abstract AudioClip getAudioClip(URL ur)
Get an audio clip.
 o getImage
  public abstract Image getImage(URL url)
Get an image.
 o showDocument
  public abstract void showDocument(URL url)
Show a document.
 o showDocument
  public abstract void showDocument(URL url,
                                    String frame)
Show a document in a named frame.
 o showDocument
  public abstract void showDocument(String url)
Show a document.
 o showDocument
  public abstract void showDocument(String url,
                                    String frame)
Show a Document in a frame.
 o showStatus
  public abstract void showStatus(String msg)
Show status.

All Packages  Class Hierarchy  This Package  Previous  Next  Index