API Overview API Index Package Overview Direct link to this page
JDK 1.6
  java.util.logging. SocketHandler View Javadoc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

/*
 * @(#)SocketHandler.java	1.19 05/11/17
 *
 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */


package java.util.logging;

import java.io.*;
import java.net.*;

/**
 * Simple network logging <tt>Handler</tt>.
 * <p>
 * <tt>LogRecords</tt> are published to a network stream connection.  By default
 * the <tt>XMLFormatter</tt> class is used for formatting.
 * <p>
 * <b>Configuration:</b>
 * By default each <tt>SocketHandler</tt> is initialized using the following
 * <tt>LogManager</tt> configuration properties.  If properties are not defined
 * (or have invalid values) then the specified default values are used.
 * <ul>
 * <li>   java.util.logging.SocketHandler.level
 *	  specifies the default level for the <tt>Handler</tt>
 *	  (defaults to <tt>Level.ALL</tt>).
 * <li>   java.util.logging.SocketHandler.filter
 * 	  specifies the name of a <tt>Filter</tt> class to use
 *	  (defaults to no <tt>Filter</tt>).
 * <li>   java.util.logging.SocketHandler.formatter
 *	  specifies the name of a <tt>Formatter</tt> class to use 
 *	  (defaults to <tt>java.util.logging.XMLFormatter</tt>).
 * <li>   java.util.logging.SocketHandler.encoding 
 *	  the name of the character set encoding to use (defaults to
 *	  the default platform encoding).
 * <li>   java.util.logging.SocketHandler.host
 *	  specifies the target host name to connect to (no default).
 * <li>   java.util.logging.SocketHandler.port
 *	  specifies the target TCP port to use (no default).
 * </ul>
 * <p>
 * The output IO stream is buffered, but is flushed after each
 * <tt>LogRecord</tt> is written.
 *
 * @version 1.19, 11/17/05
 * @since 1.4
 */

public class SocketHandler extends StreamHandler {
    private Socket sock;
    private String host;
    private int port;
    private String portProperty;

    // Private method to configure a SocketHandler from LogManager
    // properties and/or default values as specified in the class
    // javadoc.
    private void configure() {
        LogManager manager = LogManager.getLogManager();
	String cname = getClass().getName();

	setLevel(manager.getLevelProperty(cname +".level", Level.ALL));
	setFilter(manager.getFilterProperty(cname +".filter", null));
	setFormatter(manager.getFormatterProperty(cname +".formatter", new XMLFormatter()));
	try {
	    setEncoding(manager.getStringProperty(cname +".encoding", null));
	} catch (Exception ex) {
	    try {
	        setEncoding(null);
	    } catch (Exception ex2) {
		// doing a setEncoding with null should always work.
		// assert false;
	    }
	}
	port = manager.getIntProperty(cname + ".port", 0);
	host = manager.getStringProperty(cname + ".host", null);
    }


    /**
     * Create a <tt>SocketHandler</tt>, using only <tt>LogManager</tt> properties
     * (or their defaults).
     * @throws IllegalArgumentException if the host or port are invalid or
     *		are not specified as LogManager properties.
     * @throws IOException if we are unable to connect to the target
     *	       host and port.
     */
    public SocketHandler() throws IOException {
	// We are going to use the logging defaults.
	sealed = false;
	configure();

	try {
            connect();
	} catch (IOException ix) {
	    System.err.println("SocketHandler: connect failed to " + host + ":" + port);
	    throw ix;
	}
        sealed = true;
    }

    /**
     * Construct a <tt>SocketHandler</tt> using a specified host and port.
     *
     * The <tt>SocketHandler</tt> is configured based on <tt>LogManager</tt> 
     * 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.
     *
     * @param host target host.
     * @param port target port.
     *
     * @throws IllegalArgumentException if the host or port are invalid.
     * @throws IOException if we are unable to connect to the target
     *	       host and port.
     */
    public SocketHandler(String host, int port) throws IOException {
	sealed = false;
	configure();
	sealed = true;
	this.port = port;
	this.host = host;
	connect();
    }

    private void connect() throws IOException {
	// Check the arguments are valid.
	if (port == 0) {
	    throw new IllegalArgumentException("Bad port: " + port);
	}
	if (host == null) {
	    throw new IllegalArgumentException("Null host name: " + host);
	}

	// Try to open a new socket.
	sock = new Socket(host, port);
	OutputStream out = sock.getOutputStream();
	BufferedOutputStream bout = new BufferedOutputStream(out);
	setOutputStream(bout);
    }

    /**
     * Close this output stream.
     *
     * @exception  SecurityException  if a security manager exists and if
     *             the caller does not have <tt>LoggingPermission("control")</tt>.
     */
    public synchronized void close() throws SecurityException {
	super.close();
	if (sock != null) {
	    try {
	        sock.close();
	    } catch (IOException ix) {
		// drop through.
	    }
 	}
	sock = null;
    }

    /**
     * Format and publish a <tt>LogRecord</tt>.
     *
     * @param  record  description of the log event. A null record is
     *                 silently ignored and is not published
     */
    public synchronized void publish(LogRecord record) {
	if (!isLoggable(record)) {
	    return;
	}
	super.publish(record);
	flush();
    }
}

Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar