weblogic.protocol

Interface ProtocolHandler

All Known Implementing Classes:

ProtocolHandlerAdmin, ProtocolImpl.NullProtocolHandler

@Contract
public interface ProtocolHandler

ProtcolHandler implementations are used for discriminating inbound connection attempts and as factories for MuxableSocket implementations for the specified protocol.

Excluded in public API Reference.

Method Summary

Modifier and Type	Method and Description
boolean	claimSocket(weblogic.utils.io.Chunk head) Returns true if protocol can accept the socket.
weblogic.socket.MuxableSocket	createSocket(weblogic.utils.io.Chunk head, java.net.Socket s, ServerChannel networkChannel) Implementations use corresponding protocol factory to create a protocol socket.
ServerChannel	getDefaultServerChannel() Get the default server channel for this protocol.
int	getHeaderLength() Returns the number of bytes this handler will peek in claimSocket This is required as while disciminating we need to know if socket was not claimed due to 1)less noof bytes read or 2) Bytes were different than accepted for this protocol.
int	getPriority() Returns the relative priority of this protocol handler handlers with a higher priority value will be discriminated later.
Protocol	getProtocol() Return the protocol discriminated by this handler

Method Detail

getDefaultServerChannel

ServerChannel getDefaultServerChannel()

Get the default server channel for this protocol.

getHeaderLength

int getHeaderLength()

Returns the number of bytes this handler will peek in claimSocket This is required as while disciminating we need to know if socket was not claimed due to 1)less noof bytes read or 2) Bytes were different than accepted for this protocol.

getPriority

int getPriority()

Returns the relative priority of this protocol handler handlers with a higher priority value will be discriminated later. Primary protocols should have priority 0. A priority of -1 means that the protocol is not suitable for discrimination and will not be added to any default channels.

claimSocket

boolean claimSocket(weblogic.utils.io.Chunk head)

Returns true if protocol can accept the socket. The implementations peek at the initial few bytes on the socket and return true iff it matches the protocol they are discriminating. The implementation may also construct an error message (for instance version mismatch) and send it on the socket.

createSocket

weblogic.socket.MuxableSocket createSocket(weblogic.utils.io.Chunk head,
                                           java.net.Socket s,
                                           ServerChannel networkChannel)
                                    throws java.io.IOException

Implementations use corresponding protocol factory to create a protocol socket. This MuxableSocket is registered with Muxer and replaces the pre-discrimination MuxableSocket for socket FD

Throws:

java.io.IOException

getProtocol

Protocol getProtocol()

Return the protocol discriminated by this handler