j4cups.server

Class CupsServer

java.lang.Object

j4cups.server.CupsServer

All Implemented Interfaces:

java.lang.Runnable

public class CupsServer
extends java.lang.Object
implements java.lang.Runnable

The CupsServer is a little embedded HTTP server based on Apache's HTTP components. It is based on HTTP/1.1 and a classic (blocking) I/O model. It can also be used as a proxy to a real CUPS server.

Since:

0.5 (27.03.2018)

Author:

oboehm

Constructor Summary

Constructors

Constructor and Description
CupsServer() Instantiates a CUPS server with the IPP standard port (631).
CupsServer(int port) Instantiates a CUPS server with the given IPP port.
CupsServer(int port, java.net.URI forwardURI) Instantiates a CUPS server with the given IPP port.

Method Summary

Modifier and Type	Method and Description
int	getPort() Gives the port where the server is running.
boolean	isStarted() Looks, if the server is running.
static void	main(java.lang.String... args) This is the CLI interface to start the CupsServer.
void	run() This is the method to run the server directly.
void	shutdown() This is the command to shut down the server.
java.lang.Thread	start() This is the method to start the server in the background.
java.lang.String	toString() For a useful toString implementation we put the port into it.

Methods inherited from class java.lang.Object

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

Constructor Detail

CupsServer

public CupsServer()

Instantiates a CUPS server with the IPP standard port (631).

CupsServer

public CupsServer(int port)

Instantiates a CUPS server with the given IPP port.

Parameters:

port - e.g. 631

CupsServer

public CupsServer(int port,
                  java.net.URI forwardURI)

Instantiates a CUPS server with the given IPP port. The request will be forwarded to the given forwardURI. If the fowardURI is a file URI the server will handel the requests itself but store the results in the given directory.

Parameters:

port - e.g. 631

forwardURI - CUPS server where the requests are forwarded to

Method Detail

main

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

This is the CLI interface to start the CupsServer. If you want to set the port use it as second argument. The first parameter is reserved for the command ("start" or "stop").

Parameters:

args - "start", "631"

getPort

public int getPort()

Gives the port where the server is running.

Returns:

port, e.g. 631

start

public java.lang.Thread start()

This is the method to start the server in the background.

Returns:

the started thread

shutdown

public void shutdown()

This is the command to shut down the server.

run

public void run()

This is the method to run the server directly. This method will not end until you kill it.

Specified by:

run in interface java.lang.Runnable

isStarted

public boolean isStarted()

Looks, if the server is running.

Returns:

true if server was started

toString

public java.lang.String toString()

For a useful toString implementation we put the port into it.

Overrides:

toString in class java.lang.Object

Returns:

string representation with port value