org.jboss.logmanager.ext.handlers

Class SocketHandler

java.lang.Object

java.util.logging.Handler

org.jboss.logmanager.ExtHandler

org.jboss.logmanager.ext.handlers.SocketHandler

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, org.jboss.logmanager.handlers.FlushableCloseable, org.jboss.logmanager.Protectable

public class SocketHandler
extends org.jboss.logmanager.ExtHandler

A handler used to communicate over a socket.

Author:

James R. Perkins

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SocketHandler.Protocol The type of socket

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT

Fields inherited from class org.jboss.logmanager.ExtHandler

handlers, handlersUpdater

Constructor Summary

Constructors

Constructor and Description
SocketHandler() Creates a socket handler with an address of localhost and port of 4560.
SocketHandler(InetAddress address, int port) Creates a socket handler.
SocketHandler(SocketHandler.Protocol protocol, InetAddress address, int port) Creates a socket handler.
SocketHandler(SocketHandler.Protocol protocol, String hostname, int port) Creates a socket handler.
SocketHandler(String hostname, int port) Creates a socket handler.

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	doPublish(org.jboss.logmanager.ExtLogRecord record)
void	flush()
InetAddress	getAddress() Returns the address being used.
int	getPort() Returns the port being used.
SocketHandler.Protocol	getProtocol() Returns the protocol being used.
void	setAddress(InetAddress address) Sets the address to connect to.
void	setHostname(String hostname) Sets the address to connect to by doing a lookup on the hostname.
void	setPort(int port) Sets the port to connect to.
void	setProtocol(SocketHandler.Protocol protocol) Sets the protocol to use.

Methods inherited from class org.jboss.logmanager.ExtHandler

addHandler, checkAccess, checkAccess, clearHandlers, disableAccess, enableAccess, getHandlers, isAutoFlush, isEnabled, protect, publish, publish, removeHandler, setAutoFlush, setEnabled, setEncoding, setErrorManager, setFilter, setFormatter, setHandlers, setLevel, unprotect

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

Constructor Detail

SocketHandler

public SocketHandler()
              throws UnknownHostException

Creates a socket handler with an address of localhost and port of 4560.

Throws:

UnknownHostException - if an error occurs attempting to retrieve the localhost

SocketHandler

public SocketHandler(String hostname,
                     int port)
              throws UnknownHostException

Creates a socket handler.

Parameters:

hostname - the hostname to connect to

port - the port to connect to

Throws:

UnknownHostException - if an error occurs resolving the address

SocketHandler

public SocketHandler(InetAddress address,
                     int port)

Creates a socket handler.

Parameters:

address - the address to connect to

port - the port to connect to

SocketHandler

public SocketHandler(SocketHandler.Protocol protocol,
                     String hostname,
                     int port)
              throws UnknownHostException

Creates a socket handler.

Parameters:

protocol - the protocol to connect with

hostname - the hostname to connect to

port - the port to connect to

Throws:

UnknownHostException - if an error occurs resolving the hostname

SocketHandler

public SocketHandler(SocketHandler.Protocol protocol,
                     InetAddress address,
                     int port)

Creates a socket handler.

Parameters:

protocol - the protocol to connect with

address - the address to connect to

port - the port to connect to

Method Detail

doPublish

protected void doPublish(org.jboss.logmanager.ExtLogRecord record)

Overrides:

doPublish in class org.jboss.logmanager.ExtHandler

flush

public void flush()

Specified by:

flush in interface Flushable

Overrides:

flush in class org.jboss.logmanager.ExtHandler

close

public void close()
           throws SecurityException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class org.jboss.logmanager.ExtHandler

Throws:

SecurityException

getAddress

public InetAddress getAddress()

Returns the address being used.

Returns:

the address

setAddress

public void setAddress(InetAddress address)

Sets the address to connect to.

Parameters:

address - the address

setHostname

public void setHostname(String hostname)
                 throws UnknownHostException

Sets the address to connect to by doing a lookup on the hostname.

Parameters:

hostname - the host name used to resolve the address

Throws:

UnknownHostException - if an error occurs resolving the address

getProtocol

public SocketHandler.Protocol getProtocol()

Returns the protocol being used.

Returns:

the protocol

setProtocol

public void setProtocol(SocketHandler.Protocol protocol)

Sets the protocol to use.

Parameters:

protocol - the protocol to use

getPort

public int getPort()

Returns the port being used.

Returns:

the port

setPort

public void setPort(int port)

Sets the port to connect to.

Parameters:

port - the port