Examples of com.softwarepearls.lego.comms.net.svs.SourceViewerService

com.softwarepearls.lego.comms.net.svs.SourceViewerService

Miniature TCP-based service giving arbitrary external programs access to a Java source code viewer in some host program such as an IDE or programmer's editor.

You can embed a {@link SourceViewerService} into any host application (or plugin). Exampleapplication: Eclipse plugin exposing Java source code viewing to other standalone development tools.

The TCP port used to publish the service is configurable (any port within 1024 .. 65535 range).

The {@link SourceViewerService} protocol is very simple, and consists of the following ASCIIcommands sent to the server.

V <fully qualified Java type name><EOL>
L <line number><EOL>

V = View specified Java type's source code
L = Goto specified line number in currently active editor

<EOL> is either LF, CR, or a CR-LF pair.

The server greets any connecting clients with a welcome String and protocol version information: "OK SourceViewerService v1.0"

On receiving any packet, the server always sends back a success or failure code to the connected client.

OK<EOL>
FAIL<EOL>

Dependencies: {@link JavaEditorBridge}, JRE. @author Laurence Vanhelsuwe, Software Pearls BVBA

        // get TCP port number from persistant configuration
        final Preferences pluginPreferences = NbPreferences.forModule(PluginConstants.class);
        final int tcpPortNumber = pluginPreferences.getInt(TCP_PORT_KEY, DEFAULT_PORT_NUMBER);


        try {
            sourceViewerService = new SourceViewerService(new JavaEditorBridgeImpl(), tcpPortNumber);
            sourceViewerService.start();
            ServiceStatus.getInstance().setServiceRunning(true);
        } catch (final IllegalStateException illegalStateException) {
            ServiceStatus.getInstance().setServiceRunning(false);
        }

Examples of com.softwarepearls.lego.comms.net.svs.SourceViewerService

Related Classes of com.softwarepearls.lego.comms.net.svs.SourceViewerService