org.apache.river.jeri.internal.mux

Class MuxServer

java.lang.Object

org.apache.river.jeri.internal.mux.MuxServer

public class MuxServer
extends Object

A MuxServer controls the server side of a multiplexed connection.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_REQUESTS

Constructor Summary

Constructors

Constructor and Description
MuxServer(OutputStream out, InputStream in, RequestDispatcher requestDispatcher) Initiates the server side of a multiplexed connection over the given input/output stream pair.
MuxServer(SocketChannel channel, RequestDispatcher requestDispatcher)

Method Summary

Modifier and Type	Method and Description
protected InvocationConstraints	checkConstraints(InvocationConstraints constraints) Checks that the specified requirements are either fully or partially satisfied by the constraints actually in force for this connection, and returns any constraints that must be fully or partially implemented by higher layers in order to fully satisfy all of the specified requirements.
protected void	checkPermissions() Verifies that the calling context has all of the security permissions necessary to receive a request on this connection.
protected void	handleDown() Handles indication that this multiplexed connection has gone down, either through normal operation or failure.
protected void	populateContext(Collection context) Populates the context collection with information representing this connection (such as the client host).
void	shutdown(String message) Shuts down this multiplexed connection.
boolean	shutdownGracefully() Shuts down this multiplexed connection only if there are no requests in progress (i.e. requests that have been dispatched to the request dispatcher but that have not been aborted or had their response fully written to the client).
void	start() Starts I/O processing.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_REQUESTS

public static final int MAX_REQUESTS

See Also:

Constant Field Values

Constructor Detail

MuxServer

public MuxServer(OutputStream out,
                 InputStream in,
                 RequestDispatcher requestDispatcher)
          throws IOException

Initiates the server side of a multiplexed connection over the given input/output stream pair.

Parameters:

out - the output stream of the underlying connection

in - the input stream of the underlying connection

requestDispatcher - the request dispatcher to dispatch incoming requests received on this multiplexed connection to

Throws:

IOException

MuxServer

public MuxServer(SocketChannel channel,
                 RequestDispatcher requestDispatcher)
          throws IOException

Throws:

IOException

Method Detail

shutdown

public void shutdown(String message)

Shuts down this multiplexed connection. Requests in progress will throw IOException for future I/O operations. On the client side, requests that were in progress will appear to have been aborted with unknown partial execution status.

Parameters:

message - reason for shutdown to be included in IOExceptions thrown from future I/O operations

shutdownGracefully

public boolean shutdownGracefully()

Shuts down this multiplexed connection only if there are no requests in progress (i.e. requests that have been dispatched to the request dispatcher but that have not been aborted or had their response fully written to the client).

Returns:

true if the connection was shut down (because there were no requests in progress), and false otherwise

checkPermissions

protected void checkPermissions()

Verifies that the calling context has all of the security permissions necessary to receive a request on this connection. This method should be overridden by subclasses to implement the desired behavior of the checkPermissions method for InboundRequest instances generated for this connection.

checkConstraints

protected InvocationConstraints checkConstraints(InvocationConstraints constraints)
                                          throws UnsupportedConstraintException

Checks that the specified requirements are either fully or partially satisfied by the constraints actually in force for this connection, and returns any constraints that must be fully or partially implemented by higher layers in order to fully satisfy all of the specified requirements. This method should be overridden by subclasses to implement the desired behavior of the checkConstraints method for InboundRequest instances generated for this connection.

Throws:

UnsupportedConstraintException

populateContext

protected void populateContext(Collection context)

Populates the context collection with information representing this connection (such as the client host). This method should be overridden by subclasses to implement the desired behavior of the populateContext method for InboundRequest instances generated for this connection.

start

public void start()
           throws IOException

Starts I/O processing. This method should be invoked only after this instance has been completely initialized, so that subclasses will not see uninitialized state.

Throws:

IOException

handleDown

protected void handleDown()

Handles indication that this multiplexed connection has gone down, either through normal operation or failure. This method should be overridden by subclasses that want to implement custom behavior when this connection has gone down.