public class MailcapCommandMap extends CommandMap
Mailcap file search order:
The MailcapCommandMap looks in various places in the user's system for mailcap file entries. When requests are made to search for commands in the MailcapCommandMap, it searches mailcap files in the following order:
.mailcap in the user's home directory.
/lib/mailcap.
META-INF/mailcap.
META-INF/mailcap.default
(usually found only in the activation.jar file).
Mailcap file format:
Mailcap files must conform to the mailcap file specification (RFC 1524, A User Agent Configuration Mechanism For Multimedia Mail Format Information). The file format consists of entries corresponding to particular MIME types. In general, the specification specifies applications for clients to use when they themselves cannot operate on the specified MIME type. The MailcapCommandMap extends this specification by using a parameter mechanism in mailcap files that allows JavaBeans(tm) components to be specified as corresponding to particular commands for a MIME type.
When a mailcap file is
parsed, the MailcapCommandMap recognizes certain parameter signatures,
specifically those parameter names that begin with x-java-.
The MailcapCommandMap uses this signature to find
command entries for inclusion into its registries.
Parameter names with the form x-java-<name>
are read by the MailcapCommandMap as identifying a command
with the name name. When the name is
content-handler the MailcapCommandMap recognizes the class
signified by this parameter as a DataContentHandler.
All other commands are handled generically regardless of command
name. The command implementation is specified by a fully qualified
class name of a JavaBean(tm) component. For example; a command for viewing
some data can be specified as: x-java-view=com.foo.ViewBean.
When the command name is fallback-entry, the value of
the command may be true or false. An
entry for a MIME type that includes a parameter of
x-java-fallback-entry=true defines fallback commands
for that MIME type that will only be used if no non-fallback entry
can be found. For example, an entry of the form text/*; ;
x-java-fallback-entry=true; x-java-view=com.sun.TextViewer
specifies a view command to be used for any text MIME type. This
view command would only be used if a non-fallback view command for
the MIME type could not be found.
MailcapCommandMap aware mailcap files have the following general form:
# Comments begin with a '#' and continue to the end of the line.
<mime type>; ; <parameter list>
# Where a parameter list consists of one or more parameters,
# where parameters look like: x-java-view=com.sun.TextViewer
# and a parameter list looks like:
text/plain; ; x-java-view=com.sun.TextViewer; x-java-edit=com.sun.TextEdit
# Note that mailcap entries that do not contain 'x-java' parameters
# and comply to RFC 1524 are simply ignored:
image/gif; /usr/dt/bin/sdtimage %s
| Constructor and Description |
|---|
MailcapCommandMap()
The default Constructor.
|
MailcapCommandMap(InputStream is)
Constructor that allows the caller to specify an InputStream
containing a mailcap file.
|
MailcapCommandMap(String fileName)
Constructor that allows the caller to specify the path
of a mailcap file.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addMailcap(String mail_cap)
Add entries to the registry.
|
DataContentHandler |
createDataContentHandler(String mimeType)
Return the DataContentHandler for the specified MIME type.
|
CommandInfo[] |
getAllCommands(String mimeType)
Get all the available commands in all mailcap files known to
this instance of MailcapCommandMap for this MIME type.
|
CommandInfo |
getCommand(String mimeType,
String cmdName)
Get the command corresponding to
cmdName for the MIME type. |
String[] |
getMimeTypes()
Get all the MIME types known to this command map.
|
String[] |
getNativeCommands(String mimeType)
Get the native commands for the given MIME type.
|
CommandInfo[] |
getPreferredCommands(String mimeType)
Get the preferred command list for a MIME Type.
|
createDataContentHandler, getAllCommands, getCommand, getDefaultCommandMap, getPreferredCommands, setDefaultCommandMappublic MailcapCommandMap()
public MailcapCommandMap(String fileName) throws IOException
fileName - The name of the mailcap file to openIOException - if the file can't be accessedpublic MailcapCommandMap(InputStream is)
is - InputStream of the mailcap file to openpublic CommandInfo[] getPreferredCommands(String mimeType)
The result of the search is a proper subset of available commands in all mailcap files known to this instance of MailcapCommandMap. The first entry for a particular command is considered the preferred command.
getPreferredCommands in class CommandMapmimeType - the MIME typepublic CommandInfo[] getAllCommands(String mimeType)
getAllCommands in class CommandMapmimeType - the MIME typepublic CommandInfo getCommand(String mimeType, String cmdName)
cmdName for the MIME type.getCommand in class CommandMapmimeType - the MIME typecmdName - the command namepublic void addMailcap(String mail_cap)
The string that is passed in should be in mailcap format.
mail_cap - a correctly formatted mailcap stringpublic DataContentHandler createDataContentHandler(String mimeType)
createDataContentHandler in class CommandMapmimeType - the MIME typepublic String[] getMimeTypes()
getMimeTypes in class CommandMappublic String[] getNativeCommands(String mimeType)
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.