- java.lang.Object
-
- java.util.logging.Handler
-
- Direct Known Subclasses:
- MemoryHandler, StreamHandler
public abstract class Handler extends Object
A Handler object takes log messages from a Logger and exports them. It might for example, write them to a console or write them to a file, or send them to a network logging service, or forward them to an OS log, or whatever.A Handler can be disabled by doing a setLevel(Level.OFF) and can be re-enabled by doing a setLevel with an appropriate level.
Handler classes typically use LogManager properties to set default values for the Handler's Filter, Formatter, and Level. See the specific documentation for each concrete Handler class.
- Since:
- 1.4
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
Handler()
Default constructor.
-
Method Summary
Methods Modifier and Type Method and Description abstract void
close()
Close the Handler and free all associated resources.abstract void
flush()
Flush any buffered output.String
getEncoding()
Return the character encoding for this Handler.ErrorManager
getErrorManager()
Retrieves the ErrorManager for this Handler.Filter
getFilter()
Get the current Filter for this Handler.Formatter
getFormatter()
Return the Formatter for this Handler.Level
getLevel()
Get the log level specifying which messages will be logged by this Handler.boolean
isLoggable(LogRecord record)
Check if this Handler would actually log a given LogRecord.abstract void
publish(LogRecord record)
Publish a LogRecord.protected void
reportError(String msg, Exception ex, int code)
Protected convenience method to report an error to this Handler's ErrorManager.void
setEncoding(String encoding)
Set the character encoding used by this Handler.void
setErrorManager(ErrorManager em)
Define an ErrorManager for this Handler.void
setFilter(Filter newFilter)
Set a Filter to control output on this Handler.void
setFormatter(Formatter newFormatter)
Set a Formatter.void
setLevel(Level newLevel)
Set the log level specifying which message levels will be logged by this Handler.
-
-
-
Constructor Detail
-
Handler
protected Handler()
Default constructor. The resulting Handler has a log level of Level.ALL, no Formatter, and no Filter. A default ErrorManager instance is installed as the ErrorManager.
-
-
Method Detail
-
publish
public abstract void publish(LogRecord record)
Publish a LogRecord.The logging request was made initially to a Logger object, which initialized the LogRecord and forwarded it here.
The Handler is responsible for formatting the message, when and if necessary. The formatting should include localization.
- Parameters:
record
- description of the log event. A null record is silently ignored and is not published
-
flush
public abstract void flush()
Flush any buffered output.
-
close
public abstract void close() throws SecurityException
Close the Handler and free all associated resources.The close method will perform a flush and then close the Handler. After close has been called this Handler should no longer be used. Method calls may either be silently ignored or may throw runtime exceptions.
- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").
-
setFormatter
public void setFormatter(Formatter newFormatter) throws SecurityException
Set a Formatter. This Formatter will be used to format LogRecords for this Handler.Some Handlers may not use Formatters, in which case the Formatter will be remembered, but not used.
- Parameters:
newFormatter
- the Formatter to use (may not be null)- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").
-
getFormatter
public Formatter getFormatter()
Return the Formatter for this Handler.- Returns:
- the Formatter (may be null).
-
setEncoding
public void setEncoding(String encoding) throws SecurityException, UnsupportedEncodingException
Set the character encoding used by this Handler.The encoding should be set before any LogRecords are written to the Handler.
- Parameters:
encoding
- The name of a supported character encoding. May be null, to indicate the default platform encoding.- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").UnsupportedEncodingException
- if the named encoding is not supported.
-
getEncoding
public String getEncoding()
Return the character encoding for this Handler.- Returns:
- The encoding name. May be null, which indicates the default encoding should be used.
-
setFilter
public void setFilter(Filter newFilter) throws SecurityException
Set a Filter to control output on this Handler.For each call of publish the Handler will call this Filter (if it is non-null) to check if the LogRecord should be published or discarded.
- Parameters:
newFilter
- a Filter object (may be null)- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").
-
getFilter
public Filter getFilter()
Get the current Filter for this Handler.- Returns:
- a Filter object (may be null)
-
setErrorManager
public void setErrorManager(ErrorManager em)
Define an ErrorManager for this Handler.The ErrorManager's "error" method will be invoked if any errors occur while using this Handler.
- Parameters:
em
- the new ErrorManager- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").
-
getErrorManager
public ErrorManager getErrorManager()
Retrieves the ErrorManager for this Handler.- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").
-
reportError
protected void reportError(String msg, Exception ex, int code)
Protected convenience method to report an error to this Handler's ErrorManager. Note that this method retrieves and uses the ErrorManager without doing a security check. It can therefore be used in environments where the caller may be non-privileged.- Parameters:
msg
- a descriptive string (may be null)ex
- an exception (may be null)code
- an error code defined in ErrorManager
-
setLevel
public void setLevel(Level newLevel) throws SecurityException
Set the log level specifying which message levels will be logged by this Handler. Message levels lower than this value will be discarded.The intention is to allow developers to turn on voluminous logging, but to limit the messages that are sent to certain Handlers.
- Parameters:
newLevel
- the new value for the log level- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").
-
getLevel
public Level getLevel()
Get the log level specifying which messages will be logged by this Handler. Message levels lower than this level will be discarded.- Returns:
- the level of messages being logged.
-
isLoggable
public boolean isLoggable(LogRecord record)
Check if this Handler would actually log a given LogRecord.This method checks if the LogRecord has an appropriate Level and whether it satisfies any Filter. It also may make other Handler specific checks that might prevent a handler from logging the LogRecord. It will return false if the LogRecord is null.
- Parameters:
record
- a LogRecord- Returns:
- true if the LogRecord would be logged.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
06/11/2024 01:12:46 Cette version de la page est en cache (à la date du 06/11/2024 01:12:46) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 30/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/util/logging/Handler.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.