Interface marimba.plugin.RequestContext
All Packages Class Hierarchy This Package Previous Next Index
Interface marimba.plugin.RequestContext
- public interface RequestContext
- extends Object
This is the interface exported to plugin writers to get information
about the channel request.
- Version:
- 1.16, 01/07/97
- Author:
- Jonathan Payne
-
addFile(String, byte[], Checksum, int)
- Adds a file to the file list with the specified data for the
file, and checksums.
-
addFile(String, byte[], int)
- Adds a file to the file list with the specified data for that
file.
-
addFile(String, File)
- Adds a file to the file list.
-
addFile(String, File, Checksum)
- Adds a file to the file list, like the above method, but also
allows you to specify a checksum yourself.
-
deleteFile(String)
- Deletes the specified path from the file list.
-
getLoggingData()
- Returns the client data, or null if there was none.
-
getLogPrefix()
- Returns the beginning of a log string that includes the
IP number, tuner ID and date/time of the request in the
common log format:
207.33.72.30 - tunerid [19/Dec/1996:16:58:05 -0800]
-
getMinutesGMT()
- Returns the number of minutes from GMT of the requestee.
-
getOSarch()
- Returns the OS arch of the requestee.
-
getOSname()
- Returns the OS name of the requestee.
-
getOSversion()
- Returns the OS version of the requestee.
-
getProfileData()
- Returns the profile data, or null if there was none.
-
getProtocolVersion()
- Returns the version of the transmitter protocol.
-
getRedirects()
- Returns a list of host:port strings of the hosts that the
requesting tuner is currently redirected to.
-
getRequestComment()
- Returns the request comment, or null if none was specified.
-
getTunerID()
- Returns the ID of the requesting tuner.
-
getTunerIDString()
- Returns the ID of the requesting tuner.
-
redirect(String, int)
- Adds an entry to the transmitter redirect list for the tuner.
-
renameFile(String, String)
- Rename a file.
-
setRequestDelay(int)
- Sets the delay in minutes before that tuner should bother
requesting its next update.
getRequestComment
public abstract String getRequestComment()
- Returns the request comment, or null if none was specified.
REMIND: This is now obsolete. The request comment is always null.
getLoggingData
public abstract byte[] getLoggingData()
- Returns the client data, or null if there was none. Client data
is just a bag of bytes.
getProfileData
public abstract byte[] getProfileData()
- Returns the profile data, or null if there was none. Profile data
is just a bag of bytes.
getLogPrefix
public abstract String getLogPrefix()
- Returns the beginning of a log string that includes the
IP number, tuner ID and date/time of the request in the
common log format:
207.33.72.30 - tunerid [19/Dec/1996:16:58:05 -0800]
getOSname
public abstract String getOSname()
- Returns the OS name of the requestee.
getOSarch
public abstract String getOSarch()
- Returns the OS arch of the requestee.
getOSversion
public abstract String getOSversion()
- Returns the OS version of the requestee.
getMinutesGMT
public abstract int getMinutesGMT()
- Returns the number of minutes from GMT of the requestee.
getTunerID
public abstract long getTunerID()
- Returns the ID of the requesting tuner.
getTunerIDString
public abstract String getTunerIDString()
- Returns the ID of the requesting tuner.
getProtocolVersion
public abstract int getProtocolVersion()
- Returns the version of the transmitter protocol.
addFile
public abstract void addFile(String path,
File file) throws IOException
- Adds a file to the file list. The file will be known as "path"
on the tuner's hard disk. The data lives in "abspath" on the
transmitter. The path should not contain the name of the channel
at the front, because that is assumed.
addFile
public abstract void addFile(String path,
File file,
Checksum cs) throws IOException
- Adds a file to the file list, like the above method, but also
allows you to specify a checksum yourself.
addFile
public abstract void addFile(String path,
byte data[],
int disposition)
- Adds a file to the file list with the specified data for that
file.
addFile
public abstract void addFile(String path,
byte data[],
Checksum cs,
int disposition)
- Adds a file to the file list with the specified data for the
file, and checksums.
deleteFile
public abstract void deleteFile(String path)
- Deletes the specified path from the file list.
renameFile
public abstract void renameFile(String from,
String to)
- Rename a file.
setRequestDelay
public abstract void setRequestDelay(int min)
- Sets the delay in minutes before that tuner should bother
requesting its next update.
redirect
public abstract void redirect(String host,
int port)
- Adds an entry to the transmitter redirect list for the tuner.
getRedirects
public abstract Vector getRedirects()
- Returns a list of host:port strings of the hosts that the
requesting tuner is currently redirected to. Returns null
if there is currently no redirection.
All Packages Class Hierarchy This Package Previous Next Index