SocketHandler (Java Platform SE 7 ) (original) (raw)

• java.lang.Object

• • java.util.logging.Handler
  • • java.util.logging.StreamHandler
      • • java.util.logging.SocketHandler

• ---

public class SocketHandler
extends StreamHandler
Simple network logging
Handler
.
LogRecords are published to a network stream connection. By default the XMLFormatter class is used for formatting.
Configuration: By default each SocketHandler is initialized using the followingLogManager configuration properties. If properties are not defined (or have invalid values) then the specified default values are used.

• java.util.logging.SocketHandler.level specifies the default level for the Handler (defaults to Level.ALL).

• java.util.logging.SocketHandler.filter specifies the name of a Filter class to use (defaults to no Filter).

• java.util.logging.SocketHandler.formatter specifies the name of a Formatter class to use (defaults to java.util.logging.XMLFormatter).

• java.util.logging.SocketHandler.encoding the name of the character set encoding to use (defaults to the default platform encoding).

• java.util.logging.SocketHandler.host specifies the target host name to connect to (no default).

• java.util.logging.SocketHandler.port specifies the target TCP port to use (no default).
  The output IO stream is buffered, but is flushed after eachLogRecord is written.
  Since:
  1.4

• • Constructor Summary

  Constructors

  Constructor and Description
  SocketHandler() Create a SocketHandler, using only LogManager properties (or their defaults).
  SocketHandler(String host, int port) Construct a SocketHandler using a specified host and port.

  • Method Summary

  Methods

  Modifier and Type	Method and Description
  void	close() Close this output stream.
  void	publish(LogRecord record) Format and publish a LogRecord.

     * ### Methods inherited from class java.util.logging.[StreamHandler](../../../java/util/logging/StreamHandler.html "class in java.util.logging")  
     `[flush](../../../java/util/logging/StreamHandler.html#flush%28%29), [isLoggable](../../../java/util/logging/StreamHandler.html#isLoggable%28java.util.logging.LogRecord%29), [setEncoding](../../../java/util/logging/StreamHandler.html#setEncoding%28java.lang.String%29), [setOutputStream](../../../java/util/logging/StreamHandler.html#setOutputStream%28java.io.OutputStream%29)`  
     * ### Methods inherited from class java.util.logging.[Handler](../../../java/util/logging/Handler.html "class in java.util.logging")  
     `[getEncoding](../../../java/util/logging/Handler.html#getEncoding%28%29), [getErrorManager](../../../java/util/logging/Handler.html#getErrorManager%28%29), [getFilter](../../../java/util/logging/Handler.html#getFilter%28%29), [getFormatter](../../../java/util/logging/Handler.html#getFormatter%28%29), [getLevel](../../../java/util/logging/Handler.html#getLevel%28%29), [reportError](../../../java/util/logging/Handler.html#reportError%28java.lang.String,%20java.lang.Exception,%20int%29), [setErrorManager](../../../java/util/logging/Handler.html#setErrorManager%28java.util.logging.ErrorManager%29), [setFilter](../../../java/util/logging/Handler.html#setFilter%28java.util.logging.Filter%29), [setFormatter](../../../java/util/logging/Handler.html#setFormatter%28java.util.logging.Formatter%29), [setLevel](../../../java/util/logging/Handler.html#setLevel%28java.util.logging.Level%29)`  
     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone%28%29), [equals](../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java/lang/Object.html#finalize%28%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../java/lang/Object.html#hashCode%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,%20int%29)`

• • Constructor Detail

     * #### SocketHandler  
     public SocketHandler()  
                   throws [IOException](../../../java/io/IOException.html "class in java.io")  
     Create a  
     SocketHandler  
     , using only  
     LogManager  
      properties (or their defaults).  
     Throws:  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the host or port are invalid or are not specified as LogManager properties.  
     `[IOException](../../../java/io/IOException.html "class in java.io")` \- if we are unable to connect to the target host and port.  
     * #### SocketHandler  
     public SocketHandler([String](../../../java/lang/String.html "class in java.lang") host,  
                  int port)  
                   throws [IOException](../../../java/io/IOException.html "class in java.io")  
     Construct a  
     SocketHandler  
      using a specified host and port. The  
     SocketHandler  
      is configured based on  
     LogManager  
      properties (or their default values) except that the given target host and port arguments are used. If the host argument is empty, but not null String then the localhost is used.  
     Parameters:  
     `host` \- target host.  
     `port` \- target port.  
     Throws:  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the host or port are invalid.  
     `[IOException](../../../java/io/IOException.html "class in java.io")` \- if we are unable to connect to the target host and port.  

  • Method Detail

    * #### close  
    public void close()  
               throws [SecurityException](../../../java/lang/SecurityException.html "class in java.lang")  
    Close this output stream.  
    **Overrides:**  
    `[close](../../../java/util/logging/StreamHandler.html#close%28%29)` in class `[StreamHandler](../../../java/util/logging/StreamHandler.html "class in java.util.logging")`  
    Throws:  
    `[SecurityException](../../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and if the caller does not have LoggingPermission("control").  
    * #### publish  
    public void publish([LogRecord](../../../java/util/logging/LogRecord.html "class in java.util.logging") record)  
    Format and publish a  
    LogRecord  
    .  
    **Overrides:**  
    `[publish](../../../java/util/logging/StreamHandler.html#publish%28java.util.logging.LogRecord%29)` in class `[StreamHandler](../../../java/util/logging/StreamHandler.html "class in java.util.logging")`  
    Parameters:  
    `record` \- description of the log event. A null record is silently ignored and is not published

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, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.