A B C D E F G H I J K L M N O P R S T U V W X

A

APACHE - Static variable in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Implementation based on Apache XML-RPC.

ASYNCH_MODE - Static variable in class org.astrogrid.samp.test.Calculator

Sends messages using the Synchronous Call/Response delivery pattern.

AbstractMessageHandler - class org.astrogrid.samp.client.AbstractMessageHandler.

Partial implementation of MessageHandler interface which helps to ensure correct client behaviour.

AbstractMessageHandler(Map) - Constructor for class org.astrogrid.samp.client.AbstractMessageHandler

Constructor using a given subscriptions map.

AbstractMessageHandler(String[]) - Constructor for class org.astrogrid.samp.client.AbstractMessageHandler

Constructor using a given list of subscribed MTypes.

AbstractMessageHandler(String) - Constructor for class org.astrogrid.samp.client.AbstractMessageHandler

Constructor using a single subscribed MType.

ApacheClient - class org.astrogrid.samp.xmlrpc.apache.ApacheClient.

SampXmlRpcClient implementation based on Apache XMLRPC classes.

ApacheClient(XmlRpcClient) - Constructor for class org.astrogrid.samp.xmlrpc.apache.ApacheClient

Constructor.

ApacheClientFactory - class org.astrogrid.samp.xmlrpc.apache.ApacheClientFactory.

SampXmlRpcClientFactory implementation based on Apache XMLRPC classes.

ApacheClientFactory() - Constructor for class org.astrogrid.samp.xmlrpc.apache.ApacheClientFactory

ApacheServer - class org.astrogrid.samp.xmlrpc.apache.ApacheServer.

SampXmlRpcServer implementation based on Apache XML-RPC library.

ApacheServer(WebServer, int) - Constructor for class org.astrogrid.samp.xmlrpc.apache.ApacheServer

Constructs a new server based on a given WebServer object.

ApacheServer() - Constructor for class org.astrogrid.samp.xmlrpc.apache.ApacheServer

Constructs a new server starting up a new WebServer object.

ApacheServerFactory - class org.astrogrid.samp.xmlrpc.apache.ApacheServerFactory.

SampXmlRpcServerFactory implementation which uses Apache classes.

ApacheServerFactory() - Constructor for class org.astrogrid.samp.xmlrpc.apache.ApacheServerFactory

add(HubClient) - Method in interface org.astrogrid.samp.hub.ClientSet

Adds a new client to the set.

addConnectionListener(ChangeListener) - Method in class org.astrogrid.samp.client.HubConnector

Adds a listener which will be notified when this connector registers or unregisters with a hub.

addHandler(SampXmlRpcHandler) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcServer

Adds a handler which can service certain XML-RPC methods.

addHandler(SampXmlRpcHandler) - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheServer

addHandler(HttpServer.Handler) - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Adds a handler which can serve some requests going through this server.

addHandler(SampXmlRpcHandler) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServer

addMType(String) - Method in class org.astrogrid.samp.Subscriptions

Adds a subscription to a given MType.

addMessageHandler(MessageHandler) - Method in class org.astrogrid.samp.client.HubConnector

Adds a MessageHandler to this connector, which allows it to respond to incoming messages.

addParam(String, Object) - Method in class org.astrogrid.samp.Message

Sets the value for a single entry in this message's samp.params map.

addResponseHandler(ResponseHandler) - Method in class org.astrogrid.samp.client.HubConnector

Adds a ResponseHandler to this connector, which allows it to receive replies from messages sent asynchronously.

asErrInfo(Map) - Static method in class org.astrogrid.samp.ErrInfo

Returns a given map as an ErrInfo object.

asLockInfo(Map) - Static method in class org.astrogrid.samp.LockInfo

Returns a given map as a LockInfo object.

asMessage(Map) - Static method in class org.astrogrid.samp.Message

Returns a given map as a Message object.

asMetadata(Map) - Static method in class org.astrogrid.samp.Metadata

Returns a given map as a Metadata object.

asRegInfo(Map) - Static method in class org.astrogrid.samp.RegInfo

Returns a given map as a RegInfo.

asResponse(Map) - Static method in class org.astrogrid.samp.Response

Returns a map as a Response object.

asSubscriptions(Map) - Static method in class org.astrogrid.samp.Subscriptions

Returns a given map in the form of a Subscriptions object.

assertEquals(Object, Object) - Static method in class org.astrogrid.samp.test.Tester

Tests object equality.

assertEquals(int, int) - Static method in class org.astrogrid.samp.test.Tester

Tests integer equality.

assertTrue(boolean) - Static method in class org.astrogrid.samp.test.Tester

Tests an assertion.

B

BasicHubService - class org.astrogrid.samp.hub.BasicHubService.

HubService implementation.

BasicHubService(Random) - Constructor for class org.astrogrid.samp.hub.BasicHubService

Constructor.

C

CODE_KEY - Static variable in class org.astrogrid.samp.ErrInfo

Key for a numeric or textual code identifying the error.

CalcStorm - class org.astrogrid.samp.test.CalcStorm.

Runs a load of Calculator clients at once all sending messages to each other.

CalcStorm(ClientProfile, Random, int, int, Calculator.SendMode) - Constructor for class org.astrogrid.samp.test.CalcStorm

Constructor.

Calculator - class org.astrogrid.samp.test.Calculator.

Test client.

Calculator(HubConnection, Random) - Constructor for class org.astrogrid.samp.test.Calculator

Constructor.

Calculator.SendMode - class org.astrogrid.samp.test.Calculator.SendMode.

Represents a delivery pattern.

CallableClient - interface org.astrogrid.samp.client.CallableClient.

Defines callbacks which the hub can make on a callable client.

Client - interface org.astrogrid.samp.Client.

Describes an application registered with a SAMP hub.

ClientLabeller - class org.astrogrid.samp.gui.ClientLabeller.

Provides text and icon labels for a Client.

ClientLabeller(ListModel, RegInfo) - Constructor for class org.astrogrid.samp.gui.ClientLabeller

Constructor.

ClientListCellRenderer - class org.astrogrid.samp.gui.ClientListCellRenderer.

List Cell Renderer for use with Client objects.

ClientListCellRenderer(ListModel, RegInfo) - Constructor for class org.astrogrid.samp.gui.ClientListCellRenderer

Constructor.

ClientPanel - class org.astrogrid.samp.gui.ClientPanel.

Component which displays details about a Client.

ClientPanel() - Constructor for class org.astrogrid.samp.gui.ClientPanel

Constructor.

ClientProfile - interface org.astrogrid.samp.client.ClientProfile.

Defines Profile-specific aspects of the SAMP client implementation.

ClientSet - interface org.astrogrid.samp.hub.ClientSet.

Data structure for keeping track of clients currently registered with a hub.

ConnectorGui - class org.astrogrid.samp.gui.ConnectorGui.

Provides a number of useful Swing actions and components for use with a HubConnector instance.

ConnectorGui(HubConnector) - Constructor for class org.astrogrid.samp.gui.ConnectorGui

Constructor.

call(String, String, Map) - Method in interface org.astrogrid.samp.client.HubConnection

Sends a message to a given client expecting a response.

call(Object, String, String, Map) - Method in class org.astrogrid.samp.hub.BasicHubService

call(Object, String, String, Map) - Method in interface org.astrogrid.samp.hub.HubService

Sends a message to a given client expecting a response.

call(String, String, Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

callAll(String, Map) - Method in interface org.astrogrid.samp.client.HubConnection

Sends a message to all subscribed clients expecting responses.

callAll(Object, String, Map) - Method in class org.astrogrid.samp.hub.BasicHubService

callAll(Object, String, Map) - Method in interface org.astrogrid.samp.hub.HubService

Sends a message to all subscribed clients expecting responses.

callAll(String, Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

callAndForget(String, List) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcClient

Sends a call, but does not wait around for the response.

callAndForget(String, List) - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheClient

callAndForget(String, List) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalClient

callAndWait(String, Map, int) - Method in interface org.astrogrid.samp.client.HubConnection

Sends a message synchronously to a client, waiting for the response.

callAndWait(String, Map, int) - Method in class org.astrogrid.samp.client.HubConnector

Sends a message synchronously to a client, waiting for the response.

callAndWait(Object, String, Map, String) - Method in class org.astrogrid.samp.hub.BasicHubService

callAndWait(Object, String, Map, String) - Method in interface org.astrogrid.samp.hub.HubService

Sends a message synchronously to a client.

callAndWait(String, List) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcClient

Makes a synchronous call, waiting for the response and returning the result.

callAndWait(String, Map, int) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

callAndWait(String, List) - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheClient

callAndWait(String, List) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalClient

canHandleCall(String) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcHandler

Returns true if this handler should be able to process given XML-RPC method.

check() - Method in class org.astrogrid.samp.ErrInfo

check() - Method in class org.astrogrid.samp.LockInfo

check() - Method in class org.astrogrid.samp.Message

check() - Method in class org.astrogrid.samp.Metadata

check() - Method in class org.astrogrid.samp.RegInfo

check() - Method in class org.astrogrid.samp.Response

check() - Method in class org.astrogrid.samp.SampMap

Checks that this object is ready for use with the SAMP toolkit.

check() - Method in class org.astrogrid.samp.Subscriptions

checkHasKeys(String[]) - Method in class org.astrogrid.samp.SampMap

Checks that this map contains at least the given set of keys.

checkList(List) - Static method in class org.astrogrid.samp.SampUtils

Checks that a given List is legal for use in a SAMP context.

checkMap(Map) - Static method in class org.astrogrid.samp.SampUtils

Checks that a given Map is legal for use in a SAMP context.

checkObject(Object) - Static method in class org.astrogrid.samp.SampUtils

Checks that a given object is legal for use in a SAMP context.

checkString(String) - Static method in class org.astrogrid.samp.SampUtils

Checks that a given String is legal for use in a SAMP context.

checkUrl(String) - Static method in class org.astrogrid.samp.SampUtils

Checks that a string can is a legal URL.

close() - Method in class org.astrogrid.samp.hub.LockWriter

Closes the output stream.

computeSubscriptions() - Method in class org.astrogrid.samp.client.HubConnector

Works out the subscriptions map for this connector.

configureConnection(HubConnection) - Method in class org.astrogrid.samp.client.HubConnector

Configures a connection with a hub in accordance with the state of this object.

contentsChanged(ListDataEvent) - Method in class org.astrogrid.samp.gui.ClientLabeller

createBroadcastAction() - Method in class org.astrogrid.samp.gui.DefaultSendActionManager

createBroadcastAction() - Method in class org.astrogrid.samp.gui.SendActionManager

Returns a new action for broadcast associated with this object.

createClient(URL) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcClientFactory

Returns an XML-RPC client implementation.

createClient(URL) - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheClientFactory

createClient(URL) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalClientFactory

createConnectionIndicator(Icon, Icon) - Method in class org.astrogrid.samp.gui.ConnectorGui

Creates a component which indicates whether this connector is currently connected or not, using supplied icons.

createConnectionIndicator() - Method in class org.astrogrid.samp.gui.ConnectorGui

Creates a component which indicates whether this connector is currently connected or not, using default icons.

createErrorResponse(ErrInfo) - Static method in class org.astrogrid.samp.Response

Returns a new response which is an error.

createErrorResponse(int, String) - Static method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Utility method to create an error response.

createErrorResponse(int, String, Throwable) - Static method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Utility method to create an error response given an exception.

createHubWindow() - Method in class org.astrogrid.samp.gui.GuiHubService

Creates a new window which maintains a display of the current hub internal state.

createMessage() - Method in class org.astrogrid.samp.gui.DefaultSendActionManager

Generates the message which is sent to one or all clients by this object's actions.

createRandomObject(int, boolean) - Method in class org.astrogrid.samp.test.HubTester

Generates an object with random content for transmission using SAMP.

createRandomString(boolean) - Method in class org.astrogrid.samp.test.HubTester

Creates a new random string for transmission using SAMP.

createReflectionKit(String, String, String) - Static method in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Returns a new XmlRpcKit given classnames for the client and server factory classes.

createSecret() - Method in class org.astrogrid.samp.xmlrpc.HubRunner

Used to generate the registration password.

createSendMenu() - Method in class org.astrogrid.samp.gui.DefaultSendActionManager

Constructs a menu with a sensible name and icon.

createSendMenu(String) - Method in class org.astrogrid.samp.gui.SendActionManager

Returns a new menu which provides options to send a message to one of the registered listeners at a time.

createSuccessResponse(Map) - Static method in class org.astrogrid.samp.Response

Returns a new response which is a success.

D

DEBUGTXT_KEY - Static variable in class org.astrogrid.samp.ErrInfo

Key for debugging information such as a stack trace.

DEFAULT_VERSION_VALUE - Static variable in class org.astrogrid.samp.LockInfo

SAMP Standard Profile version for this toolkit implementation.

DESCHTML_KEY - Static variable in class org.astrogrid.samp.Metadata

Key for description of the application in HTML.

DESCTEXT_KEY - Static variable in class org.astrogrid.samp.Metadata

Key for short description of the application in plain text.

DOCURL_KEY - Static variable in class org.astrogrid.samp.Metadata

Key for the URL of a documentation web page.

DataException - exception org.astrogrid.samp.DataException.

Unchecked exception thrown when a data structure for use with SAMP does not have the correct form.

DataException() - Constructor for class org.astrogrid.samp.DataException

Constructs an exception with no message.

DataException(String) - Constructor for class org.astrogrid.samp.DataException

Consructs an exception with a given message.

DataException(Throwable) - Constructor for class org.astrogrid.samp.DataException

Constructs an exception with a given cause.

DataException(String, Throwable) - Constructor for class org.astrogrid.samp.DataException

Constructs an exception with a given message and cause.

DefaultSendActionManager - class org.astrogrid.samp.gui.DefaultSendActionManager.

SendActionManager concrete subclass which works with messages of a single MType.

DefaultSendActionManager(Component, HubConnector, String, String) - Constructor for class org.astrogrid.samp.gui.DefaultSendActionManager

Constructor.

declareMetadata(Map) - Method in interface org.astrogrid.samp.client.HubConnection

Declares this registered client's metadata.

declareMetadata(Map) - Method in class org.astrogrid.samp.client.HubConnector

Declares the metadata for this client.

declareMetadata(Object, Map) - Method in class org.astrogrid.samp.gui.GuiHubService

declareMetadata(Object, Map) - Method in class org.astrogrid.samp.hub.BasicHubService

declareMetadata(Object, Map) - Method in interface org.astrogrid.samp.hub.HubService

Declares metadata for the calling client.

declareMetadata(Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

declareSubscriptions(Map) - Method in interface org.astrogrid.samp.client.HubConnection

Declares this registered client's MType subscriptions.

declareSubscriptions(Map) - Method in class org.astrogrid.samp.client.HubConnector

Declares the MType subscriptions for this client.

declareSubscriptions(Object, Map) - Method in class org.astrogrid.samp.gui.GuiHubService

declareSubscriptions(Object, Map) - Method in class org.astrogrid.samp.hub.BasicHubService

declareSubscriptions(Object, Map) - Method in interface org.astrogrid.samp.hub.HubService

Declares subscription information for the calling client.

declareSubscriptions(Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

decodeBoolean(String) - Static method in class org.astrogrid.samp.SampUtils

Returns the boolean value for a SAMP boolean string.

decodeFloat(String) - Static method in class org.astrogrid.samp.SampUtils

Returns the double value for a SAMP float string.

decodeInt(String) - Static method in class org.astrogrid.samp.SampUtils

Returns the integer value for a SAMP int string.

decodeLong(String) - Static method in class org.astrogrid.samp.SampUtils

Returns the integer value as a long for a SAMP int string.

dispose() - Method in class org.astrogrid.samp.gui.SelectiveClientListModel

Releases any resources associated with this transmitter.

dispose() - Method in class org.astrogrid.samp.gui.SendActionManager

Releases any resources associated with this object.

disposeSendMenu(JMenu) - Method in class org.astrogrid.samp.gui.SendActionManager

Releases any resources associated with a menu previously created using SendActionManager.createSendMenu(java.lang.String).

E

EMPTY - Static variable in class org.astrogrid.samp.SampMap

ERRORTXT_KEY - Static variable in class org.astrogrid.samp.ErrInfo

Key for short description of what went wrong.

ERROR_KEY - Static variable in class org.astrogrid.samp.Response

Key for error map.

ERROR_STATUS - Static variable in class org.astrogrid.samp.Response

Response.STATUS_KEY value indicating failure.

ErrInfo - class org.astrogrid.samp.ErrInfo.

Represents the error information associated with a SAMP response.

ErrInfo() - Constructor for class org.astrogrid.samp.ErrInfo

Constructs an empty ErrInfo.

ErrInfo(Throwable) - Constructor for class org.astrogrid.samp.ErrInfo

Constructs an ErrInfo based on a given Throwable.

ErrInfo(Map) - Constructor for class org.astrogrid.samp.ErrInfo

Constructs an ErrInfo based on an existing map.

ErrInfo(String) - Constructor for class org.astrogrid.samp.ErrInfo

Constructs an ErrInfo with a given ErrInfo.ERRORTXT_KEY value.

ErrorDialog - class org.astrogrid.samp.gui.ErrorDialog.

Dialog window which displays an error message, possibly with some verbose details optionally visible.

ErrorDialog(Frame, String, String) - Constructor for class org.astrogrid.samp.gui.ErrorDialog

Constructor.

encodeBoolean(boolean) - Static method in class org.astrogrid.samp.SampUtils

Returns a SAMP boolean string representation of a boolean value.

encodeFloat(double) - Static method in class org.astrogrid.samp.SampUtils

Returns a SAMP float string representation of a floating point value.

encodeInt(int) - Static method in class org.astrogrid.samp.SampUtils

Returns a SAMP int string representation of an integer.

encodeLong(long) - Static method in class org.astrogrid.samp.SampUtils

Returns a SAMP int string representation of a long integer.

entrySet() - Method in class org.astrogrid.samp.SampMap

F

fail() - Static method in class org.astrogrid.samp.test.Tester

Fails a test.

finalize() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

Unregisters if not already unregistered.

flush() - Method in class org.astrogrid.samp.test.Calculator

Waits until all the responses this client is expecting to get have been safely received.

formatObject(Object, int) - Static method in class org.astrogrid.samp.SampUtils

Pretty-prints a SAMP object.

G

GuiHubService - class org.astrogrid.samp.gui.GuiHubService.

BasicHubService subclass which provides a GUI window displaying hub status as well as the basic hub services.

GuiHubService(Random) - Constructor for class org.astrogrid.samp.gui.GuiHubService

Constructor.

getBaseUrl() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Returns the base URL for this server.

getBody() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer.Request

Returns the body of the HTTP request if there was one.

getBroadcastAction() - Method in class org.astrogrid.samp.gui.SendActionManager

Returns an action which will broadcast a message to all suitable registered applications.

getClient() - Method in class org.astrogrid.samp.gui.ClientPanel

Returns the most recently displayed client.

getClientFactory() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Returns an XML-RPC client factory.

getClientListModel() - Method in class org.astrogrid.samp.client.HubConnector

Returns a list model which keeps track of other clients currently registered with the hub to which this object is connected, including their currently declared metadata and subscriptions.

getClientListModel() - Method in class org.astrogrid.samp.gui.GuiHubService

Returns a ListModel containing information about clients currently registered with this hub.

getClientMap() - Method in class org.astrogrid.samp.client.HubConnector

Returns a map which keeps track of other clients currently registered with the hub to which this object is connected, including their currently declared metadata and subscriptions.

getClientSet() - Method in class org.astrogrid.samp.gui.GuiHubService

getClientSet() - Method in class org.astrogrid.samp.hub.BasicHubService

Returns the structure which keeps track of registered clients.

getClients() - Method in interface org.astrogrid.samp.hub.ClientSet

Returns an array of all the currently contained clients.

getCode() - Method in class org.astrogrid.samp.ErrInfo

Returns the value for the ErrInfo.CODE_KEY key.

getConnection() - Method in class org.astrogrid.samp.client.HubConnector

If necessary attempts to acquire, and returns, a connection to a running hub.

getConnection() - Method in class org.astrogrid.samp.test.Calculator

Returns the hub connection used by this client.

getDebugtxt() - Method in class org.astrogrid.samp.ErrInfo

Returns the value for the ErrInfo.DEBUGTXT_KEY key.

getDescriptionHtml() - Method in class org.astrogrid.samp.Metadata

Returns an HTML description of the application.

getDescriptionText() - Method in class org.astrogrid.samp.Metadata

Returns a short description of the application.

getDetailText() - Method in class org.astrogrid.samp.gui.ErrorDialog

Supplies the text to be displayed in the detail panel.

getDocumentationUrl() - Method in class org.astrogrid.samp.Metadata

Returns a URL for a documentation web page.

getElementAt(int) - Method in class org.astrogrid.samp.gui.SelectiveClientListModel

getEndpoint() - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcServer

Returns the server's endpoint.

getEndpoint() - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheServer

getEndpoint() - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServer

getErrInfo() - Method in class org.astrogrid.samp.Response

Returns the error object.

getErrortxt() - Method in class org.astrogrid.samp.ErrInfo

Returns the value for the ErrInfo.ERRORTXT_KEY key.

getExternalHubAction() - Method in class org.astrogrid.samp.gui.ConnectorGui

Returns an action which will start up a SAMP hub in a new independent JVM.

getFromPrivateKey(String) - Method in interface org.astrogrid.samp.hub.ClientSet

Returns the client in the set corresponding to a given private key.

getFromPublicId(String) - Method in interface org.astrogrid.samp.hub.ClientSet

Returns the client in the set corresponding to a given public ID.

getHeaderMap() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer.Request

Returns a map of key-value pairs representing HTTP request headers.

getHeaderMap() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer.Response

Returns a map of the header keyword-value pairs.

getHomeDirectory() - Method in class org.astrogrid.samp.Platform

Returns SAMP's definition of the "home" directory.

getHub() - Method in class org.astrogrid.samp.xmlrpc.HubRunner

Returns the HubService object used by this runner.

getHubClient() - Method in class org.astrogrid.samp.hub.BasicHubService

getHubId() - Method in class org.astrogrid.samp.RegInfo

Returns the hub's own public client id.

getIcon(Client) - Method in class org.astrogrid.samp.gui.ClientLabeller

Attempts to return an icon associated with the given client.

getIconUrl() - Method in class org.astrogrid.samp.Metadata

Returns a URL for a gif, png or jpeg icon identifying the application.

getId() - Method in interface org.astrogrid.samp.Client

Returns the public identifier for this client.

getId() - Method in class org.astrogrid.samp.hub.HubClient

getInstance() - Static method in class org.astrogrid.samp.xmlrpc.StandardClientProfile

Returns an instance based on the default XML-RPC implementation.

getInstance() - Static method in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Returns the default instance of this class.

getInstanceByName(String) - Static method in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Returns an XmlRpcKit instance given its name.

getInternalHubAction() - Method in class org.astrogrid.samp.gui.ConnectorGui

Returns an action which will start up a SAMP hub in the current JVM.

getLabel(Client) - Method in class org.astrogrid.samp.gui.ClientLabeller

Attempts to return a human-readable text label for the given client.

getList(String) - Method in class org.astrogrid.samp.SampMap

Returns the value for a given key in this map, cast to List.

getListCellRendererComponent(JList, Object, int, boolean, boolean) - Method in class org.astrogrid.samp.gui.ClientListCellRenderer

getLocalhost() - Static method in class org.astrogrid.samp.SampUtils

Returns a string denoting the local host to be used for communicating local server endpoints and so on.

getLockFile() - Static method in class org.astrogrid.samp.SampUtils

Returns the location of the Standard Profile lockfile.

getLockInfo() - Method in class org.astrogrid.samp.xmlrpc.HubRunner

Returns the lockfile information associated with this object.

getMType() - Method in class org.astrogrid.samp.Message

Returns this message's MType.

getMTypes() - Method in class org.astrogrid.samp.gui.SubscribedClientListModel

Returns the list of MTypes which defines the elements of this list.

getMap(String) - Method in class org.astrogrid.samp.SampMap

returns the value for a given key in this map, cast to Map.

getMetadata() - Method in interface org.astrogrid.samp.Client

Returns the currently declared metadata for this client, if any.

getMetadata(String) - Method in interface org.astrogrid.samp.client.HubConnection

Returns the metadata for another registered client.

getMetadata() - Method in class org.astrogrid.samp.client.HubConnector

Returns this client's own metadata.

getMetadata(Object, String) - Method in class org.astrogrid.samp.hub.BasicHubService

getMetadata() - Method in class org.astrogrid.samp.hub.HubClient

getMetadata(Object, String) - Method in interface org.astrogrid.samp.hub.HubService

Returns metadata for a given client.

getMetadata(String) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

getMethod() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer.Request

Returns the request method string.

getName() - Method in class org.astrogrid.samp.Metadata

Returns the value for the application's name.

getName() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Returns the name of this kit.

getParam(String) - Method in class org.astrogrid.samp.Message

Returns the value of a single entry in this message's samp.params map.

getParams() - Method in class org.astrogrid.samp.Message

Returns this message's params map.

getPlatform() - Static method in class org.astrogrid.samp.Platform

Returns a Platform instance for the current system.

getPrivateKey() - Method in class org.astrogrid.samp.RegInfo

Returns the registered client's private key (Standard Profile).

getPrivateKey() - Method in class org.astrogrid.samp.hub.HubClient

Returns this client's private key.

getPrivateReadArgs(File) - Method in class org.astrogrid.samp.Platform

Returns an array of words to Runtime.exec(java.lang.String[]) in order to set permissions on a given file so that it cannot be read by anyone other than its owner.

getReceiveCount() - Method in class org.astrogrid.samp.test.Calculator

Returns the total number of messages received using any delivery pattern.

getReceiver() - Method in class org.astrogrid.samp.hub.HubClient

Returns the receiveer which allows this client to receive callbacks.

getRegInfo() - Method in interface org.astrogrid.samp.client.HubConnection

Returns the registration information associated with this connection.

getRegInfo() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

getRegisterAction() - Method in class org.astrogrid.samp.gui.ConnectorGui

Returns an action which attempts to register with the hub.

getRegisteredClients() - Method in interface org.astrogrid.samp.client.HubConnection

Returns the list of client public IDs for those clients currently registered.

getRegisteredClients(Object) - Method in class org.astrogrid.samp.hub.BasicHubService

getRegisteredClients(Object) - Method in interface org.astrogrid.samp.hub.HubService

Returns a list of the public-ids of all currently registered clients.

getRegisteredClients() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

getRequiredParam(String) - Method in class org.astrogrid.samp.Message

Returns the value of a single entry in this message's samp.params map, throwing an exception if it is not present.

getResult() - Method in class org.astrogrid.samp.Response

Returns the result map.

getSampVersion() - Static method in class org.astrogrid.samp.SampUtils

Returns a string giving the version of the SAMP standard which this software implements.

getSecret() - Method in class org.astrogrid.samp.LockInfo

Returns the value of the LockInfo.SECRET_KEY key.

getSelfId() - Method in class org.astrogrid.samp.RegInfo

Returns the registered client's public client id.

getSendAction(Client) - Method in class org.astrogrid.samp.gui.DefaultSendActionManager

getSendAction(Client) - Method in class org.astrogrid.samp.gui.SendActionManager

Returns an action which can perform a single-client send associated with this object.

getSendCount() - Method in class org.astrogrid.samp.test.Calculator

Returns the total number of messages sent using any delivery pattern.

getServer() - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcServerFactory

Returns an XML-RPC server implementation.

getServer() - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheServerFactory

getServer() - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServerFactory

getServerFactory() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Returns an XML-RPC server factory.

getShowMonitorAction() - Method in class org.astrogrid.samp.gui.ConnectorGui

Returns an action which will display a SAMP hub monitor window.

getSize() - Method in class org.astrogrid.samp.gui.SelectiveClientListModel

getSocket() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Returns the socket on which this server listens.

getSoftwareVersion() - Static method in class org.astrogrid.samp.SampUtils

Returns a string giving the version of this software package.

getStatus() - Method in class org.astrogrid.samp.Response

Returns the status value.

getStatusCode() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer.Response

Returns the 3-digit status code.

getStatusPhrase() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer.Response

Returns the status phrase.

getString(String) - Method in class org.astrogrid.samp.SampMap

Returns the value for a given key in this map, cast to String.

getSubscribedClients(String) - Method in interface org.astrogrid.samp.client.HubConnection

Returns a map of subscriptions for a given MType.

getSubscribedClients(Object, String) - Method in class org.astrogrid.samp.hub.BasicHubService

getSubscribedClients(Object, String) - Method in interface org.astrogrid.samp.hub.HubService

Returns a map of the clients subscribed to a given MType.

getSubscribedClients(String) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

getSubscription(String) - Method in class org.astrogrid.samp.Subscriptions

Returns the map which forms the value for a given MType key.

getSubscription(String) - Method in class org.astrogrid.samp.hub.HubClient

Returns the subscription information for a given MType for this client.

getSubscriptions() - Method in interface org.astrogrid.samp.Client

Returns the currently declared subscriptions for this client, if any.

getSubscriptions() - Method in class org.astrogrid.samp.client.AbstractMessageHandler

getSubscriptions(String) - Method in interface org.astrogrid.samp.client.HubConnection

Returns the subscriptions for another registered client.

getSubscriptions() - Method in class org.astrogrid.samp.client.HubConnector

Returns this client's own subscriptions.

getSubscriptions() - Method in interface org.astrogrid.samp.client.MessageHandler

Returns a Subscriptions map corresponding to the messages handled by this object.

getSubscriptions(Object, String) - Method in class org.astrogrid.samp.hub.BasicHubService

getSubscriptions() - Method in class org.astrogrid.samp.hub.HubClient

getSubscriptions(Object, String) - Method in interface org.astrogrid.samp.hub.HubService

Returns subscriptions for a given client.

getSubscriptions(String) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

getToggleRegisterAction() - Method in class org.astrogrid.samp.gui.ConnectorGui

Returns an action which toggles hub registration.

getUnregisterAction() - Method in class org.astrogrid.samp.gui.ConnectorGui

Returns an action which attempts to unregister from the hub.

getUnusedPort(int) - Static method in class org.astrogrid.samp.SampUtils

Returns an unused port number on the local host.

getUrl(String) - Method in class org.astrogrid.samp.SampMap

Returns the value for a given key in this map as a URL.

getUrl() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer.Request

Returns the request URL string.

getUsertxt() - Method in class org.astrogrid.samp.ErrInfo

Returns the value for the ErrInfo.USERTXT_KEY key.

getVersion() - Method in class org.astrogrid.samp.LockInfo

Returns the value of the LockInfo.VERSION_KEY key.

getXmlrpcUrl() - Method in class org.astrogrid.samp.LockInfo

Returns the value of the LockInfo.XMLRPCURL_KEY key.

H

HDR_CONTENT_TYPE - Static variable in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Header string for MIME content type.

HUBID_KEY - Static variable in class org.astrogrid.samp.RegInfo

Key for client public-id used by hub when sending messages itself.

HttpServer - class org.astrogrid.samp.xmlrpc.internal.HttpServer.

Simple modular HTTP server.

HttpServer(ServerSocket) - Constructor for class org.astrogrid.samp.xmlrpc.internal.HttpServer

Constructs a server based on a given socket.

HttpServer() - Constructor for class org.astrogrid.samp.xmlrpc.internal.HttpServer

Constructs a server based on a default socket, on any free port.

HttpServer.Handler - interface org.astrogrid.samp.xmlrpc.internal.HttpServer.Handler.

Implemented to serve data for some URLs.

HttpServer.Request - class org.astrogrid.samp.xmlrpc.internal.HttpServer.Request.

Represents a parsed HTTP client request.

HttpServer.Request(String, String, Map, byte[]) - Constructor for class org.astrogrid.samp.xmlrpc.internal.HttpServer.Request

Constructor.

HttpServer.Response - class org.astrogrid.samp.xmlrpc.internal.HttpServer.Response.

Represents a response to an HTTP request.

HttpServer.Response(int, String, Map) - Constructor for class org.astrogrid.samp.xmlrpc.internal.HttpServer.Response

Constructor.

HubClient - class org.astrogrid.samp.hub.HubClient.

Represents a client registered with a hub.

HubClient(Object, String) - Constructor for class org.astrogrid.samp.hub.HubClient

Constructor.

HubConnection - interface org.astrogrid.samp.client.HubConnection.

Represents a registered client's connection to a running hub.

HubConnector - class org.astrogrid.samp.client.HubConnector.

Manages a client's connection to SAMP hubs.

HubConnector(ClientProfile) - Constructor for class org.astrogrid.samp.client.HubConnector

Constructs a HubConnector based on a given profile instance.

HubMonitor - class org.astrogrid.samp.gui.HubMonitor.

Client application which uses a HubConnector to connect to any running hub and display information about all currently registered clients.

HubMonitor(ClientProfile, int) - Constructor for class org.astrogrid.samp.gui.HubMonitor

Constructor.

HubRunner - class org.astrogrid.samp.xmlrpc.HubRunner.

Runs a SAMP hub using the SAMP Standard Profile.

HubRunner(SampXmlRpcClientFactory, SampXmlRpcServerFactory, HubService, File) - Constructor for class org.astrogrid.samp.xmlrpc.HubRunner

Constructor.

HubService - interface org.astrogrid.samp.hub.HubService.

Interface defining the work that the hub has to do.

HubServiceException - exception org.astrogrid.samp.hub.HubServiceException.

Exception thrown when some error occurs in a hub service implementation.

HubServiceException() - Constructor for class org.astrogrid.samp.hub.HubServiceException

Constructs an exception with no message.

HubServiceException(String) - Constructor for class org.astrogrid.samp.hub.HubServiceException

Consructs an exception with a given message.

HubServiceException(Throwable) - Constructor for class org.astrogrid.samp.hub.HubServiceException

Constructs an exception with a given cause.

HubServiceException(String, Throwable) - Constructor for class org.astrogrid.samp.hub.HubServiceException

Constructs an exception with a given message and cause.

HubTester - class org.astrogrid.samp.test.HubTester.

Tester for a running hub.

HubTester(ClientProfile) - Constructor for class org.astrogrid.samp.test.HubTester

Constructor.

HubView - class org.astrogrid.samp.gui.HubView.

Component displaying a list of SAMP Clients, usually those registered with a hub.

HubView() - Constructor for class org.astrogrid.samp.gui.HubView

Constructor.

handleCall(String, List) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcHandler

Processes an XML-RPC call.

I

ICONURL_KEY - Static variable in class org.astrogrid.samp.Metadata

Key for the URL of an icon in png, gif or jpeg format.

IMPL_PROP - Static variable in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Property which is examined to determine which implementation to use by default.

INTERNAL - Static variable in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Implementation which requires no external libraries.

InternalClient - class org.astrogrid.samp.xmlrpc.internal.InternalClient.

XML-RPC client implementation suitable for use with SAMP.

InternalClient(URL) - Constructor for class org.astrogrid.samp.xmlrpc.internal.InternalClient

Constructor.

InternalClientFactory - class org.astrogrid.samp.xmlrpc.internal.InternalClientFactory.

Freestanding SampXmlRpcClientFactory implementation.

InternalClientFactory() - Constructor for class org.astrogrid.samp.xmlrpc.internal.InternalClientFactory

InternalServer - class org.astrogrid.samp.xmlrpc.internal.InternalServer.

SampXmlRpcServer implementation without external dependencies.

InternalServer(HttpServer, String) - Constructor for class org.astrogrid.samp.xmlrpc.internal.InternalServer

Constructor based on a given HTTP server.

InternalServer() - Constructor for class org.astrogrid.samp.xmlrpc.internal.InternalServer

Constructs a server running with default characteristics on any free port.

InternalServerFactory - class org.astrogrid.samp.xmlrpc.internal.InternalServerFactory.

Freestanding SampXmlRpcServerFactory implementation.

InternalServerFactory() - Constructor for class org.astrogrid.samp.xmlrpc.internal.InternalServerFactory

init() - Method in class org.astrogrid.samp.gui.SelectiveClientListModel

Must be called by subclass prior to use.

intervalAdded(ListDataEvent) - Method in class org.astrogrid.samp.gui.ClientLabeller

intervalRemoved(ListDataEvent) - Method in class org.astrogrid.samp.gui.ClientLabeller

isAvailable() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Indicates whether this object is ready for use.

isCallable() - Method in class org.astrogrid.samp.hub.HubClient

Indicates whether this client is callable.

isConnected() - Method in class org.astrogrid.samp.client.HubConnector

Indicates whether this connector is currently registered with a running hub.

isIncluded(Client) - Method in class org.astrogrid.samp.gui.SelectiveClientListModel

Implement this method to determine which clients are included in this list.

isIncluded(Client) - Method in class org.astrogrid.samp.gui.SubscribedClientListModel

Returns true if client is subscribed to one of this model's MTypes.

isOK() - Method in class org.astrogrid.samp.Response

Indicates whether the result was an unequivocal success.

isRunning() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Indicates whether this server is currently running.

isSubscribed(String) - Method in class org.astrogrid.samp.Subscriptions

Determines whether a given (non-wildcarded) MType is subscribed to by this object.

isSubscribed(String) - Method in class org.astrogrid.samp.hub.HubClient

Indicates whether this client is subscribed to a given MType.

J

JSamp - class org.astrogrid.samp.JSamp.

Convenience class for invoking JSAMP command-line applications.

K

KNOWN_IMPLS - Static variable in class org.astrogrid.samp.xmlrpc.XmlRpcKit

Array of available known implementations of this class.

L

LOCALHOST_PROP - Static variable in class org.astrogrid.samp.SampUtils

LOCKFILE_NAME - Static variable in class org.astrogrid.samp.SampUtils

LockInfo - class org.astrogrid.samp.LockInfo.

Represents the information read from a SAMP Standard Profile Lockfile.

LockInfo() - Constructor for class org.astrogrid.samp.LockInfo

Constructs an empty LockInfo.

LockInfo(Map) - Constructor for class org.astrogrid.samp.LockInfo

Constructs a LockInfo based on an existing map.

LockInfo(String, String) - Constructor for class org.astrogrid.samp.LockInfo

Constructs a LockInfo from a given SAMP secret and XML-RPC URL.

LockWriter - class org.astrogrid.samp.hub.LockWriter.

Writes records to a SAMP Standard Profile hub lockfile.

LockWriter() - Constructor for class org.astrogrid.samp.hub.LockWriter

Constructs a writer for writing to the lockfile in the standard location (SampUtils.getLockFile()).

LockWriter(OutputStream) - Constructor for class org.astrogrid.samp.hub.LockWriter

Constructs a writer for writing to a given output stream.

logger_ - Static variable in class org.astrogrid.samp.test.MessageSender

M

MAX_TIMEOUT - Static variable in class org.astrogrid.samp.hub.BasicHubService

The maximum timeout for a synchronous call prermitted in seconds.

MAX_WAITERS - Static variable in class org.astrogrid.samp.hub.BasicHubService

The maximum number of concurrently pending synchronous calls.

MTYPE_KEY - Static variable in class org.astrogrid.samp.Message

Key for message MType.

Message - class org.astrogrid.samp.Message.

Represents an encoded SAMP Message.

Message() - Constructor for class org.astrogrid.samp.Message

Constructs an empty message.

Message(Map) - Constructor for class org.astrogrid.samp.Message

Constructs a message based on an existing map.

Message(String, Map) - Constructor for class org.astrogrid.samp.Message

Constructs a message with a given MType and params map.

Message(String) - Constructor for class org.astrogrid.samp.Message

Constructs a message with a given MType.

MessageHandler - interface org.astrogrid.samp.client.MessageHandler.

Interface for a client which wishes to receive messages.

MessageSender - class org.astrogrid.samp.test.MessageSender.

Sends a message to one or more other SAMP clients.

MessageSender() - Constructor for class org.astrogrid.samp.test.MessageSender

Metadata - class org.astrogrid.samp.Metadata.

Represents the application metadata associated with a SAMP client.

Metadata() - Constructor for class org.astrogrid.samp.Metadata

Constructs an empty Metadata map.

Metadata(Map) - Constructor for class org.astrogrid.samp.Metadata

Constructs a Metadata map based on a given map.

main(String[]) - Static method in class org.astrogrid.samp.JSamp

Main method.

main(String[]) - Static method in class org.astrogrid.samp.gui.HubMonitor

Displays a HubMonitor in a window.

main(String[]) - Static method in class org.astrogrid.samp.test.CalcStorm

Main method.

main(String[]) - Static method in class org.astrogrid.samp.test.HubTester

Main method.

main(String[]) - Static method in class org.astrogrid.samp.test.MessageSender

Main method.

main(String[]) - Static method in class org.astrogrid.samp.test.Snooper

Main method.

main(String[]) - Static method in class org.astrogrid.samp.xmlrpc.HubRunner

Main method.

matchLevel(String, String) - Static method in class org.astrogrid.samp.Subscriptions

Performs wildcard matching of MTypes.

N

NAME_KEY - Static variable in class org.astrogrid.samp.Metadata

Key for application name.

NOTIFY_MODE - Static variable in class org.astrogrid.samp.test.Calculator

Sends messages using the Notify delivery pattern.

notify(String, Map) - Method in interface org.astrogrid.samp.client.HubConnection

Sends a message to a given client without wanting a response.

notify(Object, String, Map) - Method in class org.astrogrid.samp.hub.BasicHubService

notify(Object, String, Map) - Method in interface org.astrogrid.samp.hub.HubService

Sends a message to a given client without wanting a response.

notify(String, Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

notifyAll(Map) - Method in interface org.astrogrid.samp.client.HubConnection

Sends a message to all subscribed clients without wanting a response.

notifyAll(Object, Map) - Method in class org.astrogrid.samp.hub.BasicHubService

notifyAll(Object, Map) - Method in interface org.astrogrid.samp.hub.HubService

Sends a message to all subscribed clients without wanting a response.

notifyAll(Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

O

OK_STATUS - Static variable in class org.astrogrid.samp.Response

Response.STATUS_KEY value indicating success.

openURL(URL) - Method in class org.astrogrid.samp.gui.ClientPanel

Attempts to open a URL in some kind of external browser.

org.astrogrid.samp - package org.astrogrid.samp

Classes common to SAMP hub and client code.

org.astrogrid.samp.client - package org.astrogrid.samp.client

Classes required only for SAMP clients.

org.astrogrid.samp.gui - package org.astrogrid.samp.gui

Classes required only for graphical components based on SAMP classes.

org.astrogrid.samp.hub - package org.astrogrid.samp.hub

Classes required only for running a SAMP hub.

org.astrogrid.samp.test - package org.astrogrid.samp.test

Classes for testing.

org.astrogrid.samp.xmlrpc - package org.astrogrid.samp.xmlrpc

Classes relating to Standard Profile and XML-RPC pluggable implementation layer.

org.astrogrid.samp.xmlrpc.apache - package org.astrogrid.samp.xmlrpc.apache

Implementation of pluggable XML-RPC layer using Apache XML-RPC.

org.astrogrid.samp.xmlrpc.internal - package org.astrogrid.samp.xmlrpc.internal

Implementation of pluggable XML-RPC layer which requires no external dependencies.

ownsTag(String) - Method in interface org.astrogrid.samp.client.ResponseHandler

Indicates whether this handler will process the response with a given message tag.

P

PARAMS_KEY - Static variable in class org.astrogrid.samp.Message

Key for map of parameters used by this message.

PRIVATEKEY_KEY - Static variable in class org.astrogrid.samp.RegInfo

Key for private-key token used for communications between hub and registering client (Standard Profile).

Platform - class org.astrogrid.samp.Platform.

Platform-dependent features required by the SAMP implementation.

Platform(String) - Constructor for class org.astrogrid.samp.Platform

Constructor.

ping() - Method in interface org.astrogrid.samp.client.HubConnection

Tests whether the connection is currently open.

ping() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

processCall(HubConnection, String, Message) - Method in class org.astrogrid.samp.client.AbstractMessageHandler

Implements message processing.

put(Object, Object) - Method in class org.astrogrid.samp.SampMap

R

RANDOM_MODE - Static variable in class org.astrogrid.samp.test.Calculator

Sends messages using a random choice of one of the other modes.

RESULT_KEY - Static variable in class org.astrogrid.samp.Response

Key for result map.

Receiver - interface org.astrogrid.samp.hub.Receiver.

Interface describing how a hub can invoke callbacks on a client.

RegInfo - class org.astrogrid.samp.RegInfo.

Represents information provided to a client at registration by the hub.

RegInfo() - Constructor for class org.astrogrid.samp.RegInfo

Constructs an empty RegInfo.

RegInfo(Map) - Constructor for class org.astrogrid.samp.RegInfo

Constructs a RegInfo based on an existing map.

Response - class org.astrogrid.samp.Response.

Represents an encoded SAMP response.

Response() - Constructor for class org.astrogrid.samp.Response

Constructs an empty response.

Response(Map) - Constructor for class org.astrogrid.samp.Response

Constructs a response based on an existing map.

Response(String, Map, ErrInfo) - Constructor for class org.astrogrid.samp.Response

Constructs a response with given status, result and error.

ResponseHandler - interface org.astrogrid.samp.client.ResponseHandler.

Interface for a client which wishes to receive responses to message it has sent asynchrnonously using call or callAll.

readLockFile() - Static method in class org.astrogrid.samp.LockInfo

Returns the LockInfo as read from the lockfile found in the usual place SampUtils.getLockFile().

readLockFile(File) - Static method in class org.astrogrid.samp.LockInfo

Returns a LockInfo as read from a lockfile at a given location.

readLockFile(InputStream) - Static method in class org.astrogrid.samp.LockInfo

Returns the LockInfo read from a given stream.

receiveCall(HubConnection, String, String, Message) - Method in class org.astrogrid.samp.client.AbstractMessageHandler

Calls AbstractMessageHandler.processCall(org.astrogrid.samp.client.HubConnection, java.lang.String, org.astrogrid.samp.Message) and uses its return value to send a reply back to the hub.

receiveCall(String, String, Message) - Method in interface org.astrogrid.samp.client.CallableClient

Receives a message for which a response is required.

receiveCall(HubConnection, String, String, Message) - Method in interface org.astrogrid.samp.client.MessageHandler

Processes a message which does require a response.

receiveCall(String, String, Map) - Method in interface org.astrogrid.samp.hub.Receiver

Receives a message requiring a response from the hub.

receiveCall(String, String, Message) - Method in class org.astrogrid.samp.test.Calculator

receiveNotification(HubConnection, String, Message) - Method in class org.astrogrid.samp.client.AbstractMessageHandler

Calls AbstractMessageHandler.processCall(org.astrogrid.samp.client.HubConnection, java.lang.String, org.astrogrid.samp.Message) and discards the result.

receiveNotification(String, Message) - Method in interface org.astrogrid.samp.client.CallableClient

Receives a message for which no response is required.

receiveNotification(HubConnection, String, Message) - Method in interface org.astrogrid.samp.client.MessageHandler

Processes a message which does not require a response.

receiveNotification(String, Map) - Method in interface org.astrogrid.samp.hub.Receiver

Receives a message not requiring a response from the hub.

receiveNotification(String, Message) - Method in class org.astrogrid.samp.test.Calculator

receiveResponse(String, String, Response) - Method in interface org.astrogrid.samp.client.CallableClient

Receives a response to a message previously sent by this client.

receiveResponse(HubConnection, String, String, Response) - Method in interface org.astrogrid.samp.client.ResponseHandler

Processes a response to an earlier message.

receiveResponse(String, String, Map) - Method in interface org.astrogrid.samp.hub.Receiver

Receives a response from the hub corresponding to a previously sent message.

receiveResponse(String, String, Response) - Method in class org.astrogrid.samp.test.Calculator

refresh() - Method in class org.astrogrid.samp.gui.SelectiveClientListModel

Recalculates the inclusions.

register() - Method in interface org.astrogrid.samp.client.ClientProfile

Attempts to register with a SAMP hub and return a corresponding connection object.

register() - Method in class org.astrogrid.samp.hub.BasicHubService

Returns a RegInfo suitable for use with the SAMP Standard Profile, in that it contains a privateKey string.

register() - Method in interface org.astrogrid.samp.hub.HubService

Registers a new client and returns a map with registration information.

register() - Method in class org.astrogrid.samp.xmlrpc.StandardClientProfile

remove(HubClient) - Method in interface org.astrogrid.samp.hub.ClientSet

Removes a client from the set.

removeConnectionListener(ChangeListener) - Method in class org.astrogrid.samp.client.HubConnector

Removes a listener previously added by HubConnector.addConnectionListener(javax.swing.event.ChangeListener).

removeHandler(SampXmlRpcHandler) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcServer

Removes a previously-added handler.

removeHandler(SampXmlRpcHandler) - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheServer

removeHandler(HttpServer.Handler) - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Removes a handler previously added by HttpServer.addHandler(org.astrogrid.samp.xmlrpc.internal.HttpServer.Handler).

removeHandler(SampXmlRpcHandler) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServer

removeMessageHandler(MessageHandler) - Method in class org.astrogrid.samp.client.HubConnector

Removes a previously-added MessageHandler to this connector.

removeResponseHandler(ResponseHandler) - Method in class org.astrogrid.samp.client.HubConnector

Removes a ResponseHandler from this connector.

reply(String, Map) - Method in interface org.astrogrid.samp.client.HubConnection

Supplies a response to a previously received message.

reply(Object, String, Map) - Method in class org.astrogrid.samp.hub.BasicHubService

reply(Object, String, Map) - Method in interface org.astrogrid.samp.hub.HubService

Responds to a previously sent message.

reply(String, Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

run() - Method in class org.astrogrid.samp.test.CalcStorm

Runs a lot of calculators at once all talking to each other.

run() - Method in class org.astrogrid.samp.test.HubTester

Perform a wide variety of tests on a running hub.

runExternalHub(boolean) - Static method in class org.astrogrid.samp.xmlrpc.HubRunner

Static method which will attempt to start a hub running in an external JVM.

runHub(boolean, XmlRpcKit) - Static method in class org.astrogrid.samp.xmlrpc.HubRunner

Static method which may be used to start a SAMP hub programmatically.

runMain(String[]) - Static method in class org.astrogrid.samp.JSamp

Does the work for the main method.

runMain(String[]) - Static method in class org.astrogrid.samp.gui.HubMonitor

Does the work for the main method.

runMain(String[]) - Static method in class org.astrogrid.samp.test.CalcStorm

Does the work for the main method.

runMain(String[]) - Static method in class org.astrogrid.samp.test.HubTester

Does the work for the main method.

runMain(String[]) - Static method in class org.astrogrid.samp.test.MessageSender

Does the work for the main method.

runMain(String[]) - Static method in class org.astrogrid.samp.test.Snooper

Does the work for the main method.

runMain(String[]) - Static method in class org.astrogrid.samp.xmlrpc.HubRunner

Does the work for running the HubRunner.main(java.lang.String[]) method.

S

SECRET_KEY - Static variable in class org.astrogrid.samp.LockInfo

Key for opaque text string required by the hub for registration.

SELFID_KEY - Static variable in class org.astrogrid.samp.RegInfo

Key for client public-id owned by the registering application.

STATUS_KEY - Static variable in class org.astrogrid.samp.Response

Key for response status.

STATUS_OK - Static variable in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Status code for OK (200).

SYNCH_MODE - Static variable in class org.astrogrid.samp.test.Calculator

Sends messages using the Asynchronous Call/Response delivery pattern.

SampException - exception org.astrogrid.samp.client.SampException.

Exception thrown when some error occurs in SAMP processing.

SampException() - Constructor for class org.astrogrid.samp.client.SampException

Constructs an exception with no message.

SampException(String) - Constructor for class org.astrogrid.samp.client.SampException

Consructs an exception with a given message.

SampException(Throwable) - Constructor for class org.astrogrid.samp.client.SampException

Constructs an exception with a given cause.

SampException(String, Throwable) - Constructor for class org.astrogrid.samp.client.SampException

Constructs an exception with a given message and cause.

SampMap - class org.astrogrid.samp.SampMap.

Abstract superclass for objects represented within the SAMP package as key-value maps.

SampMap(String[]) - Constructor for class org.astrogrid.samp.SampMap

Constructor.

SampUtils - class org.astrogrid.samp.SampUtils.

Contains static utility methods for use with the SAMP toolkit.

SampXmlRpcClient - interface org.astrogrid.samp.xmlrpc.SampXmlRpcClient.

Interface for a client which can make XML-RPC calls for SAMP.

SampXmlRpcClientFactory - interface org.astrogrid.samp.xmlrpc.SampXmlRpcClientFactory.

Defines a factory which can create clients for communication with XML-RPC servers.

SampXmlRpcHandler - interface org.astrogrid.samp.xmlrpc.SampXmlRpcHandler.

Interface for an object which can process certain XML-RPC requests.

SampXmlRpcServer - interface org.astrogrid.samp.xmlrpc.SampXmlRpcServer.

Interface for a server which can respond to XML-RPC calls for SAMP.

SampXmlRpcServerFactory - interface org.astrogrid.samp.xmlrpc.SampXmlRpcServerFactory.

Defines a factory for SampXmlRpcServer instances.

SelectiveClientListModel - class org.astrogrid.samp.gui.SelectiveClientListModel.

ListModel implementation which sits on top of an existing ListModel containing Clients, but only includes a subset of its elements.

SelectiveClientListModel(ListModel) - Constructor for class org.astrogrid.samp.gui.SelectiveClientListModel

Constructor.

SendActionManager - class org.astrogrid.samp.gui.SendActionManager.

Manages actions to send SAMP messages to one or all recipients.

SendActionManager(HubConnector, ListModel) - Constructor for class org.astrogrid.samp.gui.SendActionManager

Constructor.

Snooper - class org.astrogrid.samp.test.Snooper.

Subscribes to SAMP messages and logs any received to an output stream.

Snooper(ClientProfile, Subscriptions, OutputStream, int) - Constructor for class org.astrogrid.samp.test.Snooper

Constructor.

StandardClientProfile - class org.astrogrid.samp.xmlrpc.StandardClientProfile.

Standard Profile implementation of ClientProfile.

StandardClientProfile(SampXmlRpcClientFactory, SampXmlRpcServerFactory) - Constructor for class org.astrogrid.samp.xmlrpc.StandardClientProfile

Constructs a profile given client and server factory implementations.

StandardClientProfile(XmlRpcKit) - Constructor for class org.astrogrid.samp.xmlrpc.StandardClientProfile

Constructs a profile given an XmlRpcKit object.

SubscribedClientListModel - class org.astrogrid.samp.gui.SubscribedClientListModel.

Selective client list model which contains only those non-self clients which are subscribed to one or more of a given list of MTypes.

SubscribedClientListModel(HubConnector, String[]) - Constructor for class org.astrogrid.samp.gui.SubscribedClientListModel

Constructor for multiple MTypes.

SubscribedClientListModel(HubConnector, String) - Constructor for class org.astrogrid.samp.gui.SubscribedClientListModel

Constructor for single MType.

Subscriptions - class org.astrogrid.samp.Subscriptions.

Represents the set of subscribed messages for a SAMP client.

Subscriptions() - Constructor for class org.astrogrid.samp.Subscriptions

Constructs an empty subscriptions object.

Subscriptions(Map) - Constructor for class org.astrogrid.samp.Subscriptions

Constructs a subscriptions object based on an existing map.

sendMessage(String, Calculator.SendMode) - Method in class org.astrogrid.samp.test.Calculator

Sends a randomly generated message in a randomly generated way to a given receiver.

serve(HttpServer.Request) - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Does the work for providing output corresponding to a given HTTP request.

serveRequest(HttpServer.Request) - Method in interface org.astrogrid.samp.xmlrpc.internal.HttpServer.Handler

Provides a response to an HTTP request.

setActive(boolean) - Method in class org.astrogrid.samp.client.HubConnector

Sets whether this connector is active or not.

setAutoconnect(int) - Method in class org.astrogrid.samp.client.HubConnector

Sets the interval at which this connector attempts to connect to a hub if no connection currently exists.

setCallable(CallableClient) - Method in interface org.astrogrid.samp.client.HubConnection

Tells the hub how it can perform callbacks on the client by providing a CallableClient object.

setCallable(CallableClient) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

setClient(Client) - Method in class org.astrogrid.samp.gui.ClientPanel

Updates this component to display the current state of a given client.

setClientListModel(ListModel) - Method in class org.astrogrid.samp.gui.HubView

Sets the client list model which is displayed in this component.

setCode(String) - Method in class org.astrogrid.samp.ErrInfo

Sets the value for the ErrInfo.CODE_KEY key.

setDaemon(boolean) - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Determines whether the server thread will be a daemon thread or not.

setDebugtxt(String) - Method in class org.astrogrid.samp.ErrInfo

Sets the value for the ErrInfo.DEBUGTXT_KEY key.

setDescriptionHtml(String) - Method in class org.astrogrid.samp.Metadata

Sets an HTML description of the application.

setDescriptionText(String) - Method in class org.astrogrid.samp.Metadata

Sets a short description of the application.

setDocumentationUrl(String) - Method in class org.astrogrid.samp.Metadata

Sets a URL for a documentation web page.

setEnabled(boolean) - Method in class org.astrogrid.samp.gui.SendActionManager

Sets the enabled status of this object.

setErrInfo(Map) - Method in class org.astrogrid.samp.Response

Sets the error object.

setErrortxt(String) - Method in class org.astrogrid.samp.ErrInfo

Sets the value for the ErrInfo.ERRORTXT_KEY key.

setIconUrl(String) - Method in class org.astrogrid.samp.Metadata

Sets a URL for a gif, png or jpeg icon identifying the application.

setLockPermissions(File) - Static method in class org.astrogrid.samp.hub.LockWriter

Sets the permissions on a given file suitably for a SAMP Standard Profile lockfile.

setMTypes(String[]) - Method in class org.astrogrid.samp.gui.SubscribedClientListModel

Sets the list of MTypes which defines the elements of this list.

setMetadata(Metadata) - Method in class org.astrogrid.samp.gui.ClientPanel

Updates this component's metadata panel to display the current state of a given metadata object.

setMetadata(Map) - Method in class org.astrogrid.samp.hub.HubClient

Sets this client's metadata map.

setName(String) - Method in class org.astrogrid.samp.Metadata

Sets the value for the application's name.

setParams(Map) - Method in class org.astrogrid.samp.Message

Sets this message's params map.

setPrivateRead(File) - Method in class org.astrogrid.samp.Platform

Sets file permissions on a given file so that it cannot be read by anyone other than its owner.

setReceiver(Object, Receiver) - Method in class org.astrogrid.samp.hub.BasicHubService

setReceiver(Receiver) - Method in class org.astrogrid.samp.hub.HubClient

Sets the receiver which allows this client to receive callbacks.

setReceiver(Object, Receiver) - Method in interface org.astrogrid.samp.hub.HubService

Sets a receiver object to handle callbacks on behalf of the calling client.

setResult(Map) - Method in class org.astrogrid.samp.Response

Sets the result map.

setStatus(String) - Method in class org.astrogrid.samp.Response

Sets the status value.

setSubscriptions(Map) - Method in class org.astrogrid.samp.client.AbstractMessageHandler

Sets the subscriptions map.

setSubscriptions(Subscriptions) - Method in class org.astrogrid.samp.gui.ClientPanel

Updates this component's subscriptions panel to display the current state of a given subscriptions object.

setSubscriptions(Map) - Method in class org.astrogrid.samp.hub.HubClient

Sets this client's subscriptions list.

setUseNicknames(boolean) - Method in class org.astrogrid.samp.gui.ClientListCellRenderer

Determine whether the textual representation of clients uses a nickname-type format or not.

setUsertxt(String) - Method in class org.astrogrid.samp.ErrInfo

Sets the value for the ErrInfo.USERTXT_KEY key.

showError(Component, String, String, Throwable) - Static method in class org.astrogrid.samp.gui.ErrorDialog

Pops up a window which shows the content of a exception.

shutdown() - Method in class org.astrogrid.samp.hub.BasicHubService

shutdown() - Method in interface org.astrogrid.samp.hub.HubService

Tidies up any resources owned by this object.

shutdown() - Method in class org.astrogrid.samp.xmlrpc.HubRunner

Shuts down the hub and tidies up.

start() - Method in class org.astrogrid.samp.gui.GuiHubService

start() - Method in class org.astrogrid.samp.hub.BasicHubService

start() - Method in interface org.astrogrid.samp.hub.HubService

Begin operation.

start() - Method in class org.astrogrid.samp.xmlrpc.HubRunner

Starts the hub and writes the lockfile.

start() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Starts the server if it is not already started.

stop() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer

Stops the server if it is currently running.

T

TestException - exception org.astrogrid.samp.test.TestException.

Exception thrown by a failed test.

TestException() - Constructor for class org.astrogrid.samp.test.TestException

TestException(String) - Constructor for class org.astrogrid.samp.test.TestException

TestException(String, Throwable) - Constructor for class org.astrogrid.samp.test.TestException

TestException(Throwable) - Constructor for class org.astrogrid.samp.test.TestException

Tester - class org.astrogrid.samp.test.Tester.

No-frills test case superclass.

Tester() - Constructor for class org.astrogrid.samp.test.Tester

toString() - Method in class org.astrogrid.samp.hub.HubClient

toString() - Method in class org.astrogrid.samp.test.Calculator.SendMode

Returns the name of this mode.

toString() - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer.Request

U

USERTXT_KEY - Static variable in class org.astrogrid.samp.ErrInfo

Key for free-form text given more information about the error.

unregister() - Method in interface org.astrogrid.samp.client.HubConnection

Unregisters the client and terminates this connection.

unregister(Object) - Method in class org.astrogrid.samp.hub.BasicHubService

unregister(Object) - Method in interface org.astrogrid.samp.hub.HubService

Unregisters a registered client.

unregister() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

updateState() - Method in class org.astrogrid.samp.gui.SendActionManager

Updates the state of actions managed by this object when the list of registered listeners has changed.

V

VERSION_KEY - Static variable in class org.astrogrid.samp.LockInfo

Key for the SAMP Standard Profile version implemented by the hub.

W

WARNING_STATUS - Static variable in class org.astrogrid.samp.Response

Response.STATUS_KEY value indicating partial success.

writeAssignment(String, String) - Method in class org.astrogrid.samp.hub.LockWriter

Writes a single assignment to the lockfile.

writeAssignments(Map) - Method in class org.astrogrid.samp.hub.LockWriter

Writes all the assignments in a given map to the lockfile.

writeBody(OutputStream) - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer.Response

Implemented to generate the bytes in the body of the response.

writeComment(String) - Method in class org.astrogrid.samp.hub.LockWriter

Writes a comment line to the lockfile.

writeLine() - Method in class org.astrogrid.samp.hub.LockWriter

Writes a blank line to the lockfile.

writeLine(String) - Method in class org.astrogrid.samp.hub.LockWriter

Writes a line of text to the lockfile, terminated with a line-end.

writeResponse(OutputStream) - Method in class org.astrogrid.samp.xmlrpc.internal.HttpServer.Response

Writes this response to an output stream in a way suitable for replying to the client.

X

XMLRPCURL_KEY - Static variable in class org.astrogrid.samp.LockInfo

Key for XML-RPC endpoint for communication with the hub.

XmlRpcHubConnection - class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection.

HubConnection implementation based on XML-RPC as per the SAMP Standard Profile.

XmlRpcHubConnection(SampXmlRpcClient, SampXmlRpcServerFactory, String) - Constructor for class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

Constructor.

XmlRpcKit - class org.astrogrid.samp.xmlrpc.XmlRpcKit.

Encapsulates the provision of XML-RPC client and server capabilities.

XmlRpcKit() - Constructor for class org.astrogrid.samp.xmlrpc.XmlRpcKit

A B C D E F G H I J K L M N O P R S T U V W X