FileDocCategorySizeDatePackage
CommandMap.javaAPI DocGlassfish v2 API8930Mon May 14 15:29:52 BST 2007javax.activation

CommandMap

public abstract class CommandMap extends Object
The CommandMap class provides an interface to a registry of command objects available in the system. Developers are expected to either use the CommandMap implementation included with this package (MailcapCommandMap) or develop their own. Note that some of the methods in this class are abstract.

Fields Summary
private static CommandMap
defaultCommandMap
Constructors Summary
Methods Summary
public javax.activation.DataContentHandlercreateDataContentHandler(java.lang.String mimeType, javax.activation.DataSource ds)
Locate a DataContentHandler that corresponds to the MIME type. The mechanism and semantics for determining this are determined by the implementation of the particular CommandMap.

The DataSource provides extra information, such as the file name, that a CommandMap implementation may use to further refine the choice of DataContentHandler. The implementation in this class simply calls the createDataContentHandler method that ignores this argument.

param
mimeType the MIME type
param
ds a DataSource for the data
return
the DataContentHandler for the MIME type
since
JAF 1.1

	return createDataContentHandler(mimeType);
    
public abstract javax.activation.DataContentHandlercreateDataContentHandler(java.lang.String mimeType)
Locate a DataContentHandler that corresponds to the MIME type. The mechanism and semantics for determining this are determined by the implementation of the particular CommandMap.

param
mimeType the MIME type
return
the DataContentHandler for the MIME type

public abstract javax.activation.CommandInfo[]getAllCommands(java.lang.String mimeType)
Get all the available commands for this type. This method should return all the possible commands for this MIME type.

param
mimeType the MIME type
return
the CommandInfo objects representing all the commands.

public javax.activation.CommandInfo[]getAllCommands(java.lang.String mimeType, javax.activation.DataSource ds)
Get all the available commands for this type. This method should return all the possible commands for this MIME type.

The DataSource provides extra information, such as the file name, that a CommandMap implementation may use to further refine the list of commands that are returned. The implementation in this class simply calls the getAllCommands method that ignores this argument.

param
mimeType the MIME type
param
ds a DataSource for the data
return
the CommandInfo objects representing all the commands.
since
JAF 1.1

	return getAllCommands(mimeType);
    
public abstract javax.activation.CommandInfogetCommand(java.lang.String mimeType, java.lang.String cmdName)
Get the default command corresponding to the MIME type.

param
mimeType the MIME type
param
cmdName the command name
return
the CommandInfo corresponding to the command.

public javax.activation.CommandInfogetCommand(java.lang.String mimeType, java.lang.String cmdName, javax.activation.DataSource ds)
Get the default command corresponding to the MIME type.

The DataSource provides extra information, such as the file name, that a CommandMap implementation may use to further refine the command that is chosen. The implementation in this class simply calls the getCommand method that ignores this argument.

param
mimeType the MIME type
param
cmdName the command name
param
ds a DataSource for the data
return
the CommandInfo corresponding to the command.
since
JAF 1.1

	return getCommand(mimeType, cmdName);
    
public static javax.activation.CommandMapgetDefaultCommandMap()
Get the default CommandMap.

  • In cases where a CommandMap instance has been previously set to some value (via setDefaultCommandMap) return the CommandMap.
  • In cases where no CommandMap has been set, the CommandMap creates an instance of MailcapCommandMap and set that to the default, returning its value.

return
the CommandMap


                                                                                  
        
	if (defaultCommandMap == null)
	    defaultCommandMap = new MailcapCommandMap();

	return defaultCommandMap;
    
public java.lang.String[]getMimeTypes()
Get all the MIME types known to this command map. If the command map doesn't support this operation, null is returned.

return
array of MIME types as strings, or null if not supported
since
JAF 1.1

	return null;
    
public abstract javax.activation.CommandInfo[]getPreferredCommands(java.lang.String mimeType)
Get the preferred command list from a MIME Type. The actual semantics are determined by the implementation of the CommandMap.

param
mimeType the MIME type
return
the CommandInfo classes that represent the command Beans.

public javax.activation.CommandInfo[]getPreferredCommands(java.lang.String mimeType, javax.activation.DataSource ds)
Get the preferred command list from a MIME Type. The actual semantics are determined by the implementation of the CommandMap.

The DataSource provides extra information, such as the file name, that a CommandMap implementation may use to further refine the list of commands that are returned. The implementation in this class simply calls the getPreferredCommands method that ignores this argument.

param
mimeType the MIME type
param
ds a DataSource for the data
return
the CommandInfo classes that represent the command Beans.
since
JAF 1.1

	return getPreferredCommands(mimeType);
    
public static voidsetDefaultCommandMap(javax.activation.CommandMap commandMap)
Set the default CommandMap. Reset the CommandMap to the default by calling this method with null.

param
commandMap The new default CommandMap.
exception
SecurityException if the caller doesn't have permission to change the default

	SecurityManager security = System.getSecurityManager();
	if (security != null) {
	    try {
		// if it's ok with the SecurityManager, it's ok with me...
		security.checkSetFactory();
	    } catch (SecurityException ex) {
		// otherwise, we also allow it if this code and the
		// factory come from the same class loader (e.g.,
		// the JAF classes were loaded with the applet classes).
		if (CommandMap.class.getClassLoader() !=
			    commandMap.getClass().getClassLoader())
		    throw ex;
	    }
	}
	defaultCommandMap = commandMap;