weblogic.socket

Class SocketMuxer

java.lang.Object

weblogic.socket.SocketMuxer

Direct Known Subclasses:

ServerSocketMuxer

public abstract class SocketMuxer
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SocketMuxer.SingletonMaker
protected class	SocketMuxer.TimerListenerImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	DELAYPOLLWAKEUP
private static java.lang.String	DELAYPOLLWAKEUPPROP
private static int	EOS
private static boolean	isAix
private static boolean	isAvailable
private static boolean	isLinux
private static java.lang.Object	ISPRESENT
private static java.lang.String	osName
protected static int	rdrThreads
private static int	sockCreateTimeout
private static java.lang.String	sockCreateTimeoutProp
protected static java.lang.String	SOCKET_READERS_QUEUE_NAME
protected java.util.concurrent.ConcurrentHashMap<weblogic.socket.MuxableSocket,java.lang.Object>	sockets
private static int	TIMER_MANAGER_INTERVAL
private static java.lang.String	TIMER_MANAGER_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SocketMuxer()

Method Summary

Modifier and Type	Method and Description
protected void	cancelIo(weblogic.socket.MuxableSocket ms)
private static java.lang.String	chooseMuxerClassBySettings()
(package private) void	cleanupSocket(weblogic.socket.MuxableSocket ms, weblogic.socket.SocketInfo info) Performs cleanup for muxable socket, which is only done once for each muxable socket.
void	closeSocket(weblogic.socket.MuxableSocket ms) Called to close the MuxableSocket.
protected void	closeSocket(java.net.Socket s)
private void	closeSocket(java.net.Socket s, boolean shouldCloseSocket)
(package private) boolean	completeIO(weblogic.socket.MuxableSocket ms, weblogic.socket.SocketInfo info) This is called by muxer subclasses after the pending IO for the muxable socket is available, i.e.
protected weblogic.timers.TimerListener	createTimeoutTrigger()
void	deliverEndOfStream(weblogic.socket.MuxableSocket ms) Deliver an idle timeout to the muxable socket.
private void	deliverExceptionAndCleanup(weblogic.socket.MuxableSocket ms, java.lang.Throwable ex) Deliver the exception to the muxable socket, and performing cleanup if possible (i.e.
void	deliverHasException(weblogic.socket.MuxableSocket ms, java.lang.Throwable ex) Deliver an exception to the muxable socket.
void	finishExceptionHandling(weblogic.socket.MuxableSocket ms) If the muxable socket returns false on timeout, the muxer will not clean up the socket immediately and will wait for the muxable socket to call this method to inform the muxer that exception handling is finished.
private static java.lang.String	getLinkError(java.lang.String muxerClassName)
static SocketMuxer	getMuxer()
private static java.lang.String	getNativeMuxerClassName()
int	getNumberOfReaders()
int	getNumSockets() Returns the current number of registered sockets.
weblogic.socket.MuxableSocket[]	getSockets() Returns an array of all of the current MuxableSocket.
java.util.Iterator<weblogic.socket.MuxableSocket>	getSocketsIterator() Return an iterator of MuxableSockets for use in timing out.
protected void	handleReadTimeout(weblogic.socket.MuxableSocket ms)
(package private) boolean	initiateIO(weblogic.socket.SocketInfo info) This is called by muxer subclasses before initiating IO for the muxable socket.
private static long	initMuxerDelayPollProp()
private static java.lang.String	initOSNameProp()
private static int	initSockCreateTimeoutProp()
(package private) static void	initSocket(java.net.Socket sock)
protected java.net.Socket	initSocket(java.net.Socket sock, java.net.InetAddress address, int port, java.net.InetAddress localAddr, int localPort, int connectTimeoutMillis)
(package private) static SocketMuxer	initSocketMuxerOnServer()
protected void	initSocketReaderThreads(int defaultNumberOfReaders, java.lang.String queueName, java.lang.String oldQueueName) Deprecated.
protected static void	initThreadCount(int defaultNumberOfReaders, java.lang.String queueName, java.lang.String oldQueueName)
protected void	internalWrite(weblogic.socket.AsyncOutputStream s)
boolean	isAsyncMuxer()
static boolean	isAvailable()
private static SocketMuxer	makeTheMuxer()
java.net.Socket	newClientSocket(java.net.InetAddress host, int port)
java.net.Socket	newClientSocket(java.net.InetAddress host, int port, java.net.InetAddress localHost, int localPort, int timeout)
java.net.Socket	newClientSocket(java.net.InetAddress host, int port, int timeout)
java.net.Socket	newProxySocket(java.net.InetAddress host, int port, java.net.InetAddress localAddr, int localPort, java.net.InetAddress proxyHost, int proxyPort, int connectTimeoutMillis) Create a new, tunneled, socket through a Squid-type proxy.
java.net.Socket	newSDPSocket(java.net.InetAddress address, int port, java.net.InetAddress localAddr, int localPort, int connectTimeoutMillis)
java.net.Socket	newSocket(java.net.InetAddress address, int port)
java.net.Socket	newSocket(java.net.InetAddress address, int port, java.net.InetAddress localAddr, int localPort, int connectTimeoutMillis) Create and initialize a new Socket, binding to some local address and port.
java.net.Socket	newSocket(java.net.InetAddress address, int port, int timeout)
java.net.Socket	newSSLClientSocket(java.net.InetAddress host, int port)
java.net.Socket	newSSLClientSocket(java.net.InetAddress host, int port, java.net.InetAddress localHost, int localPort, int timeout)
java.net.Socket	newSSLClientSocket(java.net.InetAddress host, int port, int timeout)
java.net.Socket	newWeblogicSocket(java.net.Socket sock)
protected abstract void	processSockets() The main method in the SocketMuxer where the reading occurs.
abstract void	read(java.util.Collection<weblogic.socket.MuxableSocket> muxableSockets)
abstract void	read(weblogic.socket.MuxableSocket ms) Attempts to read data for a MuxableSocket that has been registered.
protected void	readCompleted(weblogic.socket.MuxableSocket ms)
protected int	readFromSocket(weblogic.socket.MuxableSocket ms)
(package private) void	readReadySocket(weblogic.socket.MuxableSocket ms, weblogic.socket.SocketInfo info, long timeoutMillis) Read on a socket that is ready for IO.
private boolean	readReadySocketOnce(weblogic.socket.MuxableSocket ms, weblogic.socket.SocketInfo info) Returns true if more needs to be read
void	register(java.util.Collection<weblogic.socket.MuxableSocket> muxableSockets)
void	register(weblogic.socket.MuxableSocket ms) Register a MuxableSocket, but do not begin IO.
void	reRegister(weblogic.socket.MuxableSocket oldSock, weblogic.socket.MuxableSocket newSock) Changes the implementation of muxable socket for Raw socket A Socket MUST be registered before re-register Currently muxers return silently if socket is found to be not registered with muxer when re-register is called This is used by Dispatch of MuxableRawSocket For Protocol Discrimination a MuxableRawSocker is registered with muxer, when protocol discrimination is complete and the incoming protocol jas been established, MuxableRawSocket should be replaced by Protocol Specific Muxable Socket Generally Muxers maintain a map from Raw Socket or FD to Muxable Socket.
protected void	startSocketReaderThreads(java.lang.String queueName)
void	write(weblogic.socket.AsyncOutputStream s)

Methods inherited from class java.lang.Object

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

Field Detail

TIMER_MANAGER_NAME

private static final java.lang.String TIMER_MANAGER_NAME

See Also:

Constant Field Values

TIMER_MANAGER_INTERVAL

private static final int TIMER_MANAGER_INTERVAL

See Also:

Constant Field Values

DELAYPOLLWAKEUPPROP

private static final java.lang.String DELAYPOLLWAKEUPPROP

See Also:

Constant Field Values

DELAYPOLLWAKEUP

protected static final long DELAYPOLLWAKEUP

EOS

private static final int EOS

See Also:

Constant Field Values

sockCreateTimeoutProp

private static final java.lang.String sockCreateTimeoutProp

See Also:

Constant Field Values

sockCreateTimeout

private static final int sockCreateTimeout

SOCKET_READERS_QUEUE_NAME

protected static final java.lang.String SOCKET_READERS_QUEUE_NAME

See Also:

Constant Field Values

sockets

protected final java.util.concurrent.ConcurrentHashMap<weblogic.socket.MuxableSocket,java.lang.Object> sockets

ISPRESENT

private static final java.lang.Object ISPRESENT

isAvailable

private static boolean isAvailable

osName

private static final java.lang.String osName

isLinux

private static final boolean isLinux

isAix

private static final boolean isAix

rdrThreads

protected static int rdrThreads

Constructor Detail

SocketMuxer

protected SocketMuxer()
               throws java.io.IOException

Throws:

java.io.IOException

Method Detail

initSockCreateTimeoutProp

private static int initSockCreateTimeoutProp()

initMuxerDelayPollProp

private static long initMuxerDelayPollProp()

initOSNameProp

private static java.lang.String initOSNameProp()

getMuxer

public static SocketMuxer getMuxer()

isAvailable

public static boolean isAvailable()

initSocketMuxerOnServer

static SocketMuxer initSocketMuxerOnServer()
                                    throws ServiceFailureException

Throws:

ServiceFailureException

makeTheMuxer

private static SocketMuxer makeTheMuxer()

getNativeMuxerClassName

private static java.lang.String getNativeMuxerClassName()

chooseMuxerClassBySettings

private static java.lang.String chooseMuxerClassBySettings()
                                                    throws java.lang.SecurityException

Throws:

java.lang.SecurityException

getLinkError

private static java.lang.String getLinkError(java.lang.String muxerClassName)

initSocketReaderThreads

@Deprecated
protected void initSocketReaderThreads(int defaultNumberOfReaders,
                                                   java.lang.String queueName,
                                                   java.lang.String oldQueueName)

Deprecated.

Parameters:

defaultNumberOfReaders -

queueName -

oldQueueName -

getNumberOfReaders

public int getNumberOfReaders()

initThreadCount

protected static void initThreadCount(int defaultNumberOfReaders,
                                      java.lang.String queueName,
                                      java.lang.String oldQueueName)

Parameters:

defaultNumberOfReaders -

queueName -

oldQueueName -

startSocketReaderThreads

protected void startSocketReaderThreads(java.lang.String queueName)

isAsyncMuxer

public boolean isAsyncMuxer()

newSocket

public java.net.Socket newSocket(java.net.InetAddress address,
                                 int port)
                          throws java.io.IOException

Throws:

java.io.IOException

newSocket

public java.net.Socket newSocket(java.net.InetAddress address,
                                 int port,
                                 int timeout)
                          throws java.io.IOException

Throws:

java.io.IOException

newClientSocket

public java.net.Socket newClientSocket(java.net.InetAddress host,
                                       int port,
                                       int timeout)
                                throws java.io.IOException

Throws:

java.io.IOException

newClientSocket

public java.net.Socket newClientSocket(java.net.InetAddress host,
                                       int port,
                                       java.net.InetAddress localHost,
                                       int localPort,
                                       int timeout)
                                throws java.io.IOException

Throws:

java.io.IOException

newClientSocket

public java.net.Socket newClientSocket(java.net.InetAddress host,
                                       int port)
                                throws java.io.IOException

Throws:

java.io.IOException

newSSLClientSocket

public java.net.Socket newSSLClientSocket(java.net.InetAddress host,
                                          int port,
                                          int timeout)
                                   throws java.io.IOException

Throws:

java.io.IOException

newSSLClientSocket

public java.net.Socket newSSLClientSocket(java.net.InetAddress host,
                                          int port,
                                          java.net.InetAddress localHost,
                                          int localPort,
                                          int timeout)
                                   throws java.io.IOException

Throws:

java.io.IOException

newSSLClientSocket

public java.net.Socket newSSLClientSocket(java.net.InetAddress host,
                                          int port)
                                   throws java.io.IOException

Throws:

java.io.IOException

newSocket

public java.net.Socket newSocket(java.net.InetAddress address,
                                 int port,
                                 java.net.InetAddress localAddr,
                                 int localPort,
                                 int connectTimeoutMillis)
                          throws java.io.IOException

Create and initialize a new Socket, binding to some local address and port.

Throws:

java.io.IOException

newSDPSocket

public java.net.Socket newSDPSocket(java.net.InetAddress address,
                                    int port,
                                    java.net.InetAddress localAddr,
                                    int localPort,
                                    int connectTimeoutMillis)
                             throws java.io.IOException

Throws:

java.io.IOException

initSocket

protected java.net.Socket initSocket(java.net.Socket sock,
                                     java.net.InetAddress address,
                                     int port,
                                     java.net.InetAddress localAddr,
                                     int localPort,
                                     int connectTimeoutMillis)
                              throws java.io.IOException

Throws:

java.io.IOException

newProxySocket

public java.net.Socket newProxySocket(java.net.InetAddress host,
                                      int port,
                                      java.net.InetAddress localAddr,
                                      int localPort,
                                      java.net.InetAddress proxyHost,
                                      int proxyPort,
                                      int connectTimeoutMillis)
                               throws java.io.IOException

Create a new, tunneled, socket through a Squid-type proxy. This kind of proxy must understand the CONNECT message for establishing outbound tunnels.

Throws:

java.io.IOException

newWeblogicSocket

public java.net.Socket newWeblogicSocket(java.net.Socket sock)
                                  throws java.io.IOException

Throws:

java.io.IOException

initSocket

static void initSocket(java.net.Socket sock)
                throws SocketOptionException

Throws:

SocketOptionException

closeSocket

protected void closeSocket(java.net.Socket s)

closeSocket

private void closeSocket(java.net.Socket s,
                         boolean shouldCloseSocket)

register

public void register(weblogic.socket.MuxableSocket ms)
              throws java.io.IOException

Register a MuxableSocket, but do not begin IO. A SocketMuxer implementation should use this opportunity to do any set up it needs to do before a call to read() may be performed. This call is generally called shortly after a new MuxableSocket is created. Calling it with a MuxableSocket which is already registered is an error. Overwritten by NativeSocketMuxer. A CALL TO register() MUST BE FOLLOWED BY A SUBSEQUENT CALL TO read() OR cleanup(). FAILURE TO DO SO WILL LEAD TO THE LEAKING OF FILE HANDLES AND OTHER RESOURCES IN THE SERVER.

Throws:

java.io.IOException

See Also:

MuxableSocket

register

public void register(java.util.Collection<weblogic.socket.MuxableSocket> muxableSockets)

reRegister

public void reRegister(weblogic.socket.MuxableSocket oldSock,
                       weblogic.socket.MuxableSocket newSock)

Changes the implementation of muxable socket for Raw socket A Socket MUST be registered before re-register Currently muxers return silently if socket is found to be not registered with muxer when re-register is called This is used by Dispatch of MuxableRawSocket For Protocol Discrimination a MuxableRawSocker is registered with muxer, when protocol discrimination is complete and the incoming protocol jas been established, MuxableRawSocket should be replaced by Protocol Specific Muxable Socket Generally Muxers maintain a map from Raw Socket or FD to Muxable Socket. Implementation of this method will just change or re-write that entry in Map. Overwritten by NativeSocketMuxer.

read

public abstract void read(weblogic.socket.MuxableSocket ms)

Attempts to read data for a MuxableSocket that has been registered. Calls to read() with a closed socket should be tolerated and silently fail.
The SocketMuxer may use the MuxableSocket getRawSocket() or getSocketInputStream() methods to retrieve the Socket or SocketInputStream underlying the MuxableSocket. Once a read is in progress the SocketMuxer should monitor the MuxableSocket's activity and time it out if it is not used with in the period specified by calling getIdleTimeoutMillis() on the MuxableSocket. If the MuxableSocket is determined to have timed out timeout() should be called on the MuxableSocket.
Data which becomes available should be placed into the byte[] returned from getBuffer() starting at the index returned by getBufferOffest(). After the data is in the byte[] incrementBufferOffset() should be called with the number of bytes read. isMessageComplete() should then be called and if it returns true dispatch() should be called. dispatch() must be called by a ExecuteThread. When the call dispatch() returns no further reading of data should be attempted until read() is called again.
If isMessageComplete() returns false the SocketMuxer should begin monitoring the MuxableSocket to ensure that a complete message is read within the timeout returned by getCompleteMessageTimeoutMillis(). If a complete message is not read within the timeout the SocketMuxer should call hasException() on the MuxableSocket with an IOException.
If at any time the SocketMuxer receives an error while reading data for a MuxableSocket it should call hasException passing in as specific an IOException as possible. This is true even if the error recieved is a MaxMessageSizeExceededException thrown by incrementBufferOffset(). If the socket is reset by its peer the SocketMuxer should throw a SocketResetException().

See Also:

ExecuteThread, MuxableSocket, SocketResetException

read

public abstract void read(java.util.Collection<weblogic.socket.MuxableSocket> muxableSockets)

closeSocket

public final void closeSocket(weblogic.socket.MuxableSocket ms)

Called to close the MuxableSocket. This is an opportunity for the SocketMuxer to clean up any resources it might have allocated in register(). If a read is currently in progress for the MuxableSocket it should be cancelled. If the MuxableSocket is already closed calls to cleanup should silently fail. The SocketMuxer should also call close() on the Socket returned by getSocket(). Note that this call is mainly intended to be called by RJVM and should not be called by muxable sockets.

See Also:

MuxableSocket

processSockets

protected abstract void processSockets()

The main method in the SocketMuxer where the reading occurs. If the SocketMuxer requires ExecuteThreads from the main execute queue it should enqueue a SocketReaderRequest for each desired thread using Kernel.execute(). These SocketReaderRequests will call this method which is not expected to return until the thread is no longer needed.
The number of threads concurrently in processSockets() should not exceed the value indicated by KernelMBean.getThreadPoolPercentSocketReaders().

See Also:

Kernel, KernelMBean, SocketReaderRequest

getNumSockets

public final int getNumSockets()

Returns the current number of registered sockets. This value is for use by the monitoring system. Note that this method is called frequently, so we keep a member variable instead of calling sockets.size() for performance reasons.

getSocketsIterator

public final java.util.Iterator<weblogic.socket.MuxableSocket> getSocketsIterator()

Return an iterator of MuxableSockets for use in timing out.

getSockets

public final weblogic.socket.MuxableSocket[] getSockets()

Returns an array of all of the current MuxableSocket. This will also be used by the monitoring system.

initiateIO

final boolean initiateIO(weblogic.socket.SocketInfo info)

This is called by muxer subclasses before initiating IO for the muxable socket. Returns whether the muxer should initiate the IO

completeIO

final boolean completeIO(weblogic.socket.MuxableSocket ms,
                         weblogic.socket.SocketInfo info)

This is called by muxer subclasses after the pending IO for the muxable socket is available, i.e. when the socket is ready for the actual IO. Cleans up the socket if needed and possible (i.e. the muxable socket is marked as close-only and there is no pending exception handling). Return whether the muxer should complete the actual IO

finishExceptionHandling

public final void finishExceptionHandling(weblogic.socket.MuxableSocket ms)

If the muxable socket returns false on timeout, the muxer will not clean up the socket immediately and will wait for the muxable socket to call this method to inform the muxer that exception handling is finished. The muxer will then clean up the socket if there is no pending IO, else the muxer will clean up the socket when the pending IO returns. Since timeout will only be called once on the muxable socket, finishExceptionHandling will also only be called once. This is specifically used ONLY by IIOP in MuxableSocketIIOP

See Also:

weblogic.socket.MuxableSocket.hasException, weblogic.socket.MuxableSocket.timeout, weblogic.socket.SocketMuxer.completeIO

deliverEndOfStream

public final void deliverEndOfStream(weblogic.socket.MuxableSocket ms)

Deliver an idle timeout to the muxable socket. Note that at most one exception will be delivered to the muxable socket.

deliverHasException

public final void deliverHasException(weblogic.socket.MuxableSocket ms,
                                      java.lang.Throwable ex)

Deliver an exception to the muxable socket. Note that at most one exception will be delivered to the muxable socket.

deliverExceptionAndCleanup

private void deliverExceptionAndCleanup(weblogic.socket.MuxableSocket ms,
                                        java.lang.Throwable ex)

Deliver the exception to the muxable socket, and performing cleanup if possible (i.e. no pending IO or exception handling). Passed in muxable socket will be checked for a wrapping filter. And we will deliver the exception/event to that filter Note that exception handling of the muxable sockets can happen both synchronously and asynchronously (see MuxableSocket.hasException/ endOfStream/timeout). In the latter case, the socket will only be cleaned up after the muxable socket finishes its exception handling and informs the muxer via finishExceptionHandling call.

See Also:

weblogic.socket.MuxableSocket.hasException, weblogic.socket.MuxableSocket.timeout, weblogic.socket.SocketMuxer.finishExceptionHandling

cancelIo

protected void cancelIo(weblogic.socket.MuxableSocket ms)

cleanupSocket

void cleanupSocket(weblogic.socket.MuxableSocket ms,
                   weblogic.socket.SocketInfo info)

Performs cleanup for muxable socket, which is only done once for each muxable socket.

readReadySocket

final void readReadySocket(weblogic.socket.MuxableSocket ms,
                           weblogic.socket.SocketInfo info,
                           long timeoutMillis)

Read on a socket that is ready for IO.

readReadySocketOnce

private final boolean readReadySocketOnce(weblogic.socket.MuxableSocket ms,
                                          weblogic.socket.SocketInfo info)

Returns true if more needs to be read

readFromSocket

protected int readFromSocket(weblogic.socket.MuxableSocket ms)
                      throws java.io.IOException

Throws:

java.io.IOException

handleReadTimeout

protected void handleReadTimeout(weblogic.socket.MuxableSocket ms)

readCompleted

protected void readCompleted(weblogic.socket.MuxableSocket ms)

write

public final void write(weblogic.socket.AsyncOutputStream s)

internalWrite

protected void internalWrite(weblogic.socket.AsyncOutputStream s)

createTimeoutTrigger

protected weblogic.timers.TimerListener createTimeoutTrigger()