/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.isis.runtimes.dflt.remoting.transport.sockets.server;
import java.io.IOException;
import java.io.InputStream;
import java.io.InterruptedIOException;
import java.io.OutputStream;
import java.net.ServerSocket;
import java.net.Socket;
import org.apache.log4j.Logger;
import org.apache.isis.core.commons.debug.DebugBuilder;
import org.apache.isis.core.commons.debug.DebuggableWithTitle;
import org.apache.isis.core.commons.exceptions.IsisException;
import org.apache.isis.core.commons.lang.Threads;
import org.apache.isis.runtimes.dflt.monitoring.servermonitor.HttpServerMonitor;
import org.apache.isis.runtimes.dflt.monitoring.servermonitor.SocketServerMonitor;
import org.apache.isis.runtimes.dflt.remoting.common.facade.ServerFacade;
import org.apache.isis.runtimes.dflt.remoting.common.facade.ServerFacadeLogger;
import org.apache.isis.runtimes.dflt.remoting.common.facade.impl.ServerFacadeImpl;
import org.apache.isis.runtimes.dflt.remoting.common.protocol.ObjectEncoderDecoder;
import org.apache.isis.runtimes.dflt.remoting.server.ServerConnection;
import org.apache.isis.runtimes.dflt.remoting.transport.ConnectionException;
import org.apache.isis.runtimes.dflt.remoting.transport.ProfilingInputStream;
import org.apache.isis.runtimes.dflt.remoting.transport.ProfilingOutputStream;
import org.apache.isis.runtimes.dflt.remoting.transport.sockets.shared.SocketTransportConstants;
import org.apache.isis.runtimes.dflt.remoting.transport.sockets.shared.Worker;
import org.apache.isis.runtimes.dflt.remoting.transport.sockets.shared.WorkerPool;
import org.apache.isis.runtimes.dflt.runtime.system.IsisSystem;
import org.apache.isis.runtimes.dflt.runtime.viewer.IsisViewerAbstract;
public abstract class SocketsViewerAbstract extends IsisViewerAbstract implements DebuggableWithTitle {
private static final Logger LOG = Logger.getLogger(SocketsViewerAbstract.class);
final ObjectEncoderDecoder encoderDecoder;
private ServerSocket socket;
private WorkerPool workerPool;
private Boolean shutdown = Boolean.FALSE;
private final Object shutdownGuard = new Object();
public SocketsViewerAbstract(final ObjectEncoderDecoder encoderDecoder) {
this.encoderDecoder = encoderDecoder;
}
// ////////////////////////////////////////////////////////////////
// init
// ////////////////////////////////////////////////////////////////
/**
* TODO: generalize so can listen on multi-homed hosts using new
* Socket(port, 2, address);
*/
@Override
public void init() {
super.init();
final int port = getConfiguration().getInteger(SocketsViewerConstants.SERVER_PORT, SocketTransportConstants.PORT_DEFAULT);
workerPool = new WorkerPool(5);
final ServerFacadeImpl serverFacade = new ServerFacadeImpl(getAuthenticationManager());
serverFacade.setEncoder(encoderDecoder);
final ServerFacade sd = new ServerFacadeLogger(encoderDecoder, serverFacade);
sd.init();
socket = newServerSocket(port);
LOG.info("listening for connection on " + socket);
acceptAndHandleRequests(sd);
shutdownListener();
}
private ServerSocket newServerSocket(final int port) {
try {
final ServerSocket socket = new ServerSocket(port);
LOG.info("nof listener started on " + socket);
socket.setSoTimeout(1000);
return socket;
} catch (final IOException e) {
throw new IsisException(e);
} finally {
shutdown(socket);
}
}
private void acceptAndHandleRequests(final ServerFacade sd) {
while (!isShutdown()) {
try {
final Socket clientSocket = socket.accept();
LOG.info("connection accepted from " + clientSocket.getInetAddress());
InputStream inputStream = clientSocket.getInputStream();
OutputStream outputStream = clientSocket.getOutputStream();
if (isDebugging()) {
inputStream = new ProfilingInputStream(inputStream);
outputStream = new ProfilingOutputStream(outputStream);
}
final ServerConnection connection = createServerConnection(inputStream, outputStream, sd);
// spawnConnectionThread(connection, sd);
final Worker worker = workerPool.getWorker();
worker.setIncomingConnection(connection);
// worker.start();
// main thread accepts new connection - have a connection -
// therefore implicitly a request
// get worker; associate with connection
// receive request
// process request
// return worker to pool and drop connection
// or
// repeat from 3 (if KEEP_ALIVE)
// main thread accepts new connection
// adds connection to to queue
// repeats, waiting for new connection
// (one of many) consumer picks up connection from queue
// wait for request
// process request
// consumer returns connection
// repeat from top
} catch (final InterruptedIOException ignore) {
// timeout - check at top of loop
continue;
} catch (final IOException e) {
LOG.warn("connection exception", e);
continue;
} catch (final ConnectionException e) {
LOG.warn("connection exception", e);
}
}
}
// ////////////////////////////////////////////////////////////////
// shutdown
// ////////////////////////////////////////////////////////////////
@Override
public void shutdown() {
LOG.info("stopping listener");
synchronized (shutdownGuard) {
shutdown = Boolean.TRUE;
}
}
private void shutdownListener() {
shutdown(socket);
socket = null;
shutdown(workerPool);
workerPool = null;
}
private void shutdown(final ServerSocket socket) {
if (socket == null) {
return;
}
try {
socket.close();
LOG.info("socket closed");
} catch (final IOException e) {
LOG.error("Failed to close listening socket", e);
}
}
private void shutdown(final WorkerPool workerPool) {
if (workerPool == null) {
return;
}
workerPool.shutdown();
LOG.info("worker pool stopped");
}
protected boolean isShutdown() {
synchronized (shutdownGuard) {
return shutdown.booleanValue();
}
}
// ///////////////////////////////////////////////////////
// hooks
// ///////////////////////////////////////////////////////
/**
* Hook method.
*/
protected abstract ServerConnection createServerConnection(final InputStream input, final OutputStream output, final ServerFacade serverFacade);
// ////////////////////////////////////////////////////////////////
// debugging
// ////////////////////////////////////////////////////////////////
@Override
public void debugData(final DebugBuilder debug) {
debug.appendln("Listener on", socket.toString());
debug.appendln("Workers", workerPool);
workerPool.debug(debug);
}
@Override
public String debugTitle() {
return "Server Listener";
}
private boolean isDebugging() {
return true;
}
// ///////////////////////////////////////////////////////////////
//
// ///////////////////////////////////////////////////////////////
@SuppressWarnings("unused")
private void startMonitors(final IsisSystem system) {
if (system.getDeploymentType().shouldMonitor()) {
final Runnable serverMonitorRunnable = new Runnable() {
@Override
public void run() {
final SocketServerMonitor serverMonitor = new SocketServerMonitor();
serverMonitor.setTarget(system);
serverMonitor.listen();
}
};
Threads.startThread(serverMonitorRunnable, "Monitor-1");
final Runnable httpServerMonitorRunnable = new Runnable() {
@Override
public void run() {
final HttpServerMonitor httpServerMonitor = new HttpServerMonitor();
httpServerMonitor.setTarget(system);
httpServerMonitor.listen();
}
};
Threads.startThread(httpServerMonitorRunnable, "Monitor-2");
}
}
}