ucar.unidata.collab

Class Server

java.lang.Object

ucar.unidata.collab.Server

Direct Known Subclasses:

CollabServer

public class Server
extends java.lang.Object

A generic server

Author:

Metapps development team

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT _more_

Constructor Summary

Constructors

Constructor and Description
Server() Create a new Server connection.
Server(int port) Create a new Server connection on the given port.

Method Summary

Modifier and Type	Method and Description
void	addClient(Client client) Add the given client to the list of clients managed by this server.
void	addClient(Client client, boolean andStartListening) Add the given client to the list of clients managed by this server.
protected Client	createClient(java.net.Socket clientSocket) A factory method for creating a new client.
java.util.List	getClients() Gets the clients.
boolean	getIsRunning() Get the IsRunning property.
protected void	handleIncomingMessage(Client fromClient, java.lang.String message) Handle the message rcvd from the given client.
boolean	hasClients() Does this server have any clients.
protected void	initClient(java.net.Socket clientSocket) Create a new client object and listen for input.
protected void	logException(java.lang.String msg, java.lang.Exception exc) Log exception.
static void	main(java.lang.String[] args) The main method.
protected void	notifyClientAdd(Client client) Gets called when we have added a new client.
protected void	notifyClientRemove(Client client) Gets called when we have removed a client.
protected void	notifyServerStart() Gets called when we are starting to listen
protected void	notifyServerStop() Gets called when we are done running on the server socket
void	removeClient(Client client) Remove the given client from the list of clients managed by this server.
void	startServer() Start server.
void	startServer(int newPort) Start server.
void	stopServer() Stop server.
void	write(java.lang.String message) Write.
void	write(java.lang.String message, Client exceptClient) Write.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static int DEFAULT_PORT

_more_

Constructor Detail

Server

public Server()

Create a new Server connection.

Server

public Server(int port)

Create a new Server connection on the given port.

Parameters:

port - the port

Method Detail

startServer

public void startServer(int newPort)
                 throws java.io.IOException

Start server.

Parameters:

newPort - the new port

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

startServer

public void startServer()
                 throws java.io.IOException

Start server.

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

stopServer

public void stopServer()

Stop server.

notifyServerStart

protected void notifyServerStart()

Gets called when we are starting to listen

notifyServerStop

protected void notifyServerStop()

Gets called when we are done running on the server socket

notifyClientAdd

protected void notifyClientAdd(Client client)

Gets called when we have added a new client.

Parameters:

client - the client

notifyClientRemove

protected void notifyClientRemove(Client client)

Gets called when we have removed a client.

Parameters:

client - the client

getIsRunning

public boolean getIsRunning()

Get the IsRunning property.

Returns:

The IsRunning

createClient

protected Client createClient(java.net.Socket clientSocket)
                       throws java.io.IOException

A factory method for creating a new client.

Parameters:

clientSocket - The socket we are connected to the client with.

Returns:

a new Client

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

initClient

protected void initClient(java.net.Socket clientSocket)

Create a new client object and listen for input.

Parameters:

clientSocket - the client socket

getClients

public java.util.List getClients()

Gets the clients.

Returns:

the clients

hasClients

public boolean hasClients()

Does this server have any clients.

Returns:

true, if successful

addClient

public void addClient(Client client)

Add the given client to the list of clients managed by this server.

Parameters:

client - the client

addClient

public void addClient(Client client,
                      boolean andStartListening)

Add the given client to the list of clients managed by this server.

Parameters:

client - the client

andStartListening - the and start listening

removeClient

public void removeClient(Client client)

Remove the given client from the list of clients managed by this server.

Parameters:

client - the client

handleIncomingMessage

protected void handleIncomingMessage(Client fromClient,
                                     java.lang.String message)

Handle the message rcvd from the given client. The default is to just turn around and write it to each of the other clients.

Parameters:

fromClient - the from client

message - the message

write

public void write(java.lang.String message)

Write.

Parameters:

message - the message

write

public void write(java.lang.String message,
                  Client exceptClient)

Write.

Parameters:

message - the message

exceptClient - the except client

logException

protected void logException(java.lang.String msg,
                            java.lang.Exception exc)

Log exception.

Parameters:

msg - the msg

exc - the exc

main

public static void main(java.lang.String[] args)

The main method.

Parameters:

args - the arguments