LimeWire Consolidated API

Package com.limegroup.gnutella.lws.server

Overview

See:
          Description

Interface Summary
LWSManager The interface to which GUI and other units program for the store server.
LWSManager.Listener Defines the interface to handle commands, but does NOT return a result.
LWSManagerCommandResponseHandler Defines the interface to handle commands sent to a LWSManager.
 

Class Summary
LWSManager.AbstractHandler An abstract implementation of LWSManagerCommandResponseHandler that abstracts away LWSManager.AbstractHandler.name().
LWSManager.AbstractListener An abstract implementation of LWSManager.Listener that abstracts away LWSManager.AbstractListener.name().
LWSManager.OK An abstract implementation of LWSManager.AbstractHandler that abstracts away returning a value from LWSManager.OK.handle(Map).
LWSManagerCommandResponseHandlerWithCallback A LWSManagerCommandResponseHandler requiring a callback specified by the parameter LWSDispatcherSupport.Parameters.CALLBACK.
LWSManagerImpl Encapsulates a LWSDispatcher and LWSReceivesCommandsFromDispatcher.
LWSUtil  
 

Package com.limegroup.gnutella.lws.server Description

Overview

Classes in this package provide an interface to the rest of the Lime Wire for registering LWSManager.Handlers and LWSManager.Listeners to an instance of LWSManager in order to receive events that are sent from Javascript code coming from the Lime Wire Store. The main access to this one instance is through the method com.limegroup.gnutella.LimeWireCore#getLWSManger()

The overall layout of classes in this package and those in the lwsserver component follows:

code

The following are the definitions of the various sub-components:

Components that wish to listen to commands coming from the web site would call LWSManager#registerHandler(LWSManager.Handler) or LWSManager#registerListener(LWSManager.Listener) with an appropriate argument. The different between the two is that there can only be on LWSManager.Handler and zero or more LWSManager#Listeners, because the former has to return a result.

The purpose of these classes is to abstract out the authentication and communication aspect, which is taken care of by the lwsserver component.


LimeWire Consolidated API

Copyright © 2009. All Rights Reserved.