Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractCallActionManager - Class in org.astrogrid.samp.gui
-
Partial SendActionManager implementation which uses the Asynchronous Call/Response delivery pattern.
- AbstractCallActionManager(Component, GuiHubConnector, ListModel) - Constructor for class org.astrogrid.samp.gui.AbstractCallActionManager
-
Constructor.
- AbstractMessageHandler - Class in org.astrogrid.samp.client
-
Partial implementation of MessageHandler interface which helps to ensure correct client behaviour.
- AbstractMessageHandler(String) - Constructor for class org.astrogrid.samp.client.AbstractMessageHandler
-
Constructor using a single subscribed MType.
- AbstractMessageHandler(String[]) - Constructor for class org.astrogrid.samp.client.AbstractMessageHandler
-
Constructor using a given list of subscribed MTypes.
- AbstractMessageHandler(Map) - Constructor for class org.astrogrid.samp.client.AbstractMessageHandler
-
Constructor using a given subscriptions map.
- ActorHandler - Class in org.astrogrid.samp.xmlrpc
-
Utility class to facilitate constructing a SampXmlRpcHandler which handles particular named methods.
- ActorHandler(String, Class, Object) - Constructor for class org.astrogrid.samp.xmlrpc.ActorHandler
-
Constructor.
- add(HubClient) - Method in class org.astrogrid.samp.hub.BasicClientSet
- add(HubClient) - Method in interface org.astrogrid.samp.hub.ClientSet
-
Adds a new client to the set.
- addChangeListener(ChangeListener) - Method in class org.astrogrid.samp.gui.Transmission
-
Adds a listener which will be notified if the state of this transmission changes (if a response or failure is signalled).
- addClient(Client) - Method in class org.astrogrid.samp.client.TrackedClientSet
-
Adds a client to this model.
- addConnectionListener(ChangeListener) - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Adds a listener which will be notified when this connector registers or unregisters with a hub.
- addHandler(HttpServer.Handler) - Method in class org.astrogrid.samp.httpd.HttpServer
-
Adds a handler which can serve some requests going through this server.
- addHandler(SampXmlRpcHandler) - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheServer
- addHandler(SampXmlRpcHandler) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServer
- addHandler(SampXmlRpcHandler) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcServer
-
Adds a handler which can service certain XML-RPC methods.
- addIcon(Image, String, PopupMenu, ActionListener) - Method in class org.astrogrid.samp.gui.SysTray
-
Adds an icon to the system tray.
- addLocalUrl(URL) - Method in class org.astrogrid.samp.httpd.MultiURLMapperHandler
-
Adds a local URL to the list of those which can be served by this handler, and returns the public URL at which it will be available.
- addMessageHandler(MessageHandler) - Method in class org.astrogrid.samp.client.HubConnector
-
Adds a MessageHandler to this connector, which allows it to respond to incoming messages.
- addMType(String) - Method in class org.astrogrid.samp.Subscriptions
-
Adds a subscription to a given MType.
- addParam(String, Object) - Method in class org.astrogrid.samp.Message
-
Sets the value for a single entry in this message's
samp.params
map. - addResource(String, ServerResource) - Method in class org.astrogrid.samp.httpd.ResourceHandler
-
Adds a resource to this server.
- 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.
- adviceLines() - Method in interface org.astrogrid.samp.web.AuthResourceBundle.Content
-
Returns lines with advice on whether you should accept or decline.
- ALLOW_ALL - Static variable in class org.astrogrid.samp.web.ListMessageRestriction
-
MessageRestriction that permits all MTypes, except as overridden by
x-samp.mostly-harmless
annotations. - APACHE - Static variable in class org.astrogrid.samp.xmlrpc.XmlRpcKit
-
Implementation based on Apache XML-RPC.
- ApacheClient - Class in org.astrogrid.samp.xmlrpc.apache
-
SampXmlRpcClient implementation based on Apache XMLRPC classes.
- ApacheClient(XmlRpcClient) - Constructor for class org.astrogrid.samp.xmlrpc.apache.ApacheClient
-
Constructor.
- ApacheClientFactory - Class in org.astrogrid.samp.xmlrpc.apache
-
SampXmlRpcClientFactory implementation based on Apache XMLRPC classes.
- ApacheClientFactory() - Constructor for class org.astrogrid.samp.xmlrpc.apache.ApacheClientFactory
- ApacheServer - Class in org.astrogrid.samp.xmlrpc.apache
-
SampXmlRpcServer implementation based on Apache XML-RPC library.
- ApacheServer() - Constructor for class org.astrogrid.samp.xmlrpc.apache.ApacheServer
-
Constructs a new server starting up a new WebServer object.
- ApacheServer(WebServer, int) - Constructor for class org.astrogrid.samp.xmlrpc.apache.ApacheServer
-
Constructs a new server based on a given WebServer object.
- ApacheServerFactory - Class in org.astrogrid.samp.xmlrpc.apache
-
SampXmlRpcServerFactory implementation which uses Apache classes.
- ApacheServerFactory() - Constructor for class org.astrogrid.samp.xmlrpc.apache.ApacheServerFactory
- appIntroductionLines() - Method in interface org.astrogrid.samp.web.AuthResourceBundle.Content
-
Returns lines introducing the registration request.
- 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.xmlrpc.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.
- assertEquals(int, int) - Static method in class org.astrogrid.samp.test.Tester
-
Tests integer equality.
- assertEquals(Object, Object) - Static method in class org.astrogrid.samp.test.Tester
-
Tests object equality.
- assertTrue(boolean) - Static method in class org.astrogrid.samp.test.Tester
-
Tests an assertion.
- asSubscriptions(Map) - Static method in class org.astrogrid.samp.Subscriptions
-
Returns a given map in the form of a Subscriptions object.
- ASYNCH_MODE - Static variable in class org.astrogrid.samp.test.Calculator
-
Sends messages using the Synchronous Call/Response delivery pattern.
- authorize(String) - Method in interface org.astrogrid.samp.web.OriginAuthorizer
-
Indicates whether a client with a given origin is permitted to access resources.
- authorize(HttpServer.Request, Map) - Method in interface org.astrogrid.samp.web.ClientAuthorizer
-
Indicates whether an HTTP request representing an otherwise unauthorized connection attempt will be permitted access to sensitive system resources.
- authorize(HttpServer.Request, Map) - Method in class org.astrogrid.samp.web.ExtremeSwingClientAuthorizer
- authorize(HttpServer.Request, Map) - Method in class org.astrogrid.samp.web.HubSwingClientAuthorizer
- authorizeAll() - Method in interface org.astrogrid.samp.web.OriginAuthorizer
-
Indicates whether clients from arbitrary origins (including none) are permitted to access resources.
- AuthResourceBundle - Class in org.astrogrid.samp.web
-
ResourceBundle for internationalising the Web Profile authorization dialogue.
- AuthResourceBundle() - Constructor for class org.astrogrid.samp.web.AuthResourceBundle
-
Constructs default (English) instance.
- AuthResourceBundle(AuthResourceBundle.Content) - Constructor for class org.astrogrid.samp.web.AuthResourceBundle
-
Constructs a bundle based on a Content implementation.
- AuthResourceBundle_de - Class in org.astrogrid.samp.web
-
AuthResourceBundle with German text.
- AuthResourceBundle_de() - Constructor for class org.astrogrid.samp.web.AuthResourceBundle_de
-
Constructor.
- AuthResourceBundle_en - Class in org.astrogrid.samp.web
-
AuthResourceBundle with English text.
- AuthResourceBundle_en() - Constructor for class org.astrogrid.samp.web.AuthResourceBundle_en
-
Constructor.
- AuthResourceBundle_fr - Class in org.astrogrid.samp.web
-
AuthResourceBundle with French text.
- AuthResourceBundle_fr() - Constructor for class org.astrogrid.samp.web.AuthResourceBundle_fr
-
Constructor.
- AuthResourceBundle_it - Class in org.astrogrid.samp.web
-
AuthResourceBundle with English text.
- AuthResourceBundle_it() - Constructor for class org.astrogrid.samp.web.AuthResourceBundle_it
-
Constructor.
- AuthResourceBundle.Content - Interface in org.astrogrid.samp.web
-
Defines the keys and value types required for a bundle of this class.
B
- BasicClientSet - Class in org.astrogrid.samp.hub
-
Basic ClientSet implementation.
- BasicClientSet(Comparator) - Constructor for class org.astrogrid.samp.hub.BasicClientSet
-
Constructor.
- BasicHubService - Class in org.astrogrid.samp.hub
-
HubService implementation.
- BasicHubService(Random) - Constructor for class org.astrogrid.samp.hub.BasicHubService
-
Constructor.
- Bridge - Class in org.astrogrid.samp.bridge
-
Runs a bridging service between two or more hubs.
- Bridge(ClientProfile[]) - Constructor for class org.astrogrid.samp.bridge.Bridge
-
Constructor.
- BROADCAST_TARGET - Static variable in class org.astrogrid.samp.gui.SendActionManager
-
ComboBox element indicating broadcast to all clients.
C
- CalcStorm - Class in org.astrogrid.samp.test
-
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 in org.astrogrid.samp.test
-
Test client.
- Calculator(HubConnection, Random) - Constructor for class org.astrogrid.samp.test.Calculator
-
Constructor.
- Calculator.SendMode - Class in org.astrogrid.samp.test
-
Represents a delivery pattern.
- call(String, String, Map) - Method in interface org.astrogrid.samp.client.HubConnection
-
Sends a message to a given client expecting a response.
- call(String, String, Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- call(String, Map, ResultHandler, int) - Method in class org.astrogrid.samp.client.HubConnector
-
Sends a message asynchronously to a single client, making a callback on a supplied ResultHandler object when the result arrives.
- call(HubClient, String, String, Map) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
call
method of connections registered with this service. - CallableClient - Interface in org.astrogrid.samp.client
-
Defines callbacks which the hub can make on a callable client.
- callAll(String, Map) - Method in interface org.astrogrid.samp.client.HubConnection
-
Sends a message to all subscribed clients expecting responses.
- callAll(String, Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- callAll(Map, ResultHandler, int) - Method in class org.astrogrid.samp.client.HubConnector
-
Sends a message asynchronously to all subscribed clients, making callbacks on a supplied ResultHandler object when the results arrive.
- callAll(HubClient, String, Map) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
call
method of connections registered with this service. - callAndForget(String, List) - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheClient
- callAndForget(String, List) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalClient
- callAndForget(String, List) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcClient
-
Sends a call, but does not wait around for the response.
- callAndWait(String, List) - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheClient
- callAndWait(String, List) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalClient
- 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 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(String, Map, int) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- callAndWait(HubClient, String, Map, int) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
callAndWait
method of connections registered with this service. - canHandleCall(String) - Method in class org.astrogrid.samp.xmlrpc.ActorHandler
- 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.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
- check() - Method in class org.astrogrid.samp.xmlrpc.LockInfo
- checkExternalHubAvailability() - Static method in class org.astrogrid.samp.hub.Hub
-
Attempts to determine whether an external hub can be started using
runExternalHub
. - checkExternalHubAvailability() - Static method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Attempts to determine whether an external hub can be started using
HubRunner.runExternalHub(org.astrogrid.samp.xmlrpc.HubMode)
. - 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 is a legal URL.
- Client - Interface in org.astrogrid.samp
-
Describes an application registered with a SAMP hub.
- CLIENT_GUI - Static variable in class org.astrogrid.samp.hub.HubServiceMode
-
Hub mode with a GUI representation of connected clients.
- CLIENT_GUI - Static variable in class org.astrogrid.samp.xmlrpc.HubMode
-
Deprecated.Hub mode with a GUI representation of connected clients.
- CLIENT_SEQUENCE - Static variable in class org.astrogrid.samp.ShutdownManager
-
Shutdown sequence value for client hooks.
- ClientAuthorizer - Interface in org.astrogrid.samp.web
-
Defines authorization functionality which is used to determine whether a client is permitted to register with the hub.
- ClientAuthorizers - Class in org.astrogrid.samp.web
-
Utility class containing ClientAuthorizer implementations.
- ClientPanel - Class in org.astrogrid.samp.gui
-
Component which displays details about a
Client
. - ClientPanel(boolean) - Constructor for class org.astrogrid.samp.gui.ClientPanel
-
Constructor.
- ClientProfile - Interface in org.astrogrid.samp.client
-
Defines an object that can be used to register with a running SAMP hub.
- ClientSet - Interface in org.astrogrid.samp.hub
-
Data structure for keeping track of clients currently registered with a hub.
- close() - Method in class org.astrogrid.samp.hub.LockWriter
-
Closes the output stream.
- CODE_KEY - Static variable in class org.astrogrid.samp.ErrInfo
-
Key for a numeric or textual code identifying the error.
- computeSubscriptions() - Method in class org.astrogrid.samp.client.HubConnector
-
Works out the subscriptions map for this connector.
- ConfigHubProfile - Interface in org.astrogrid.samp.hub
-
Marks a HubProfile that can also provide GUI-based configuration.
- configureConnection(HubConnection) - Method in class org.astrogrid.samp.client.HubConnector
-
Configures a connection with a hub in accordance with the state of this object.
- connectionChanged(boolean) - Method in class org.astrogrid.samp.client.HubConnector
-
Method which is called every time this connector changes its connection status (from disconnected to connected, or vice versa).
- connectionChanged(boolean) - Method in class org.astrogrid.samp.gui.GuiHubConnector
- containsClient(HubClient) - Method in class org.astrogrid.samp.hub.BasicClientSet
- containsClient(HubClient) - Method in interface org.astrogrid.samp.hub.ClientSet
-
Indicates whether a given client is currently a member of this set.
- copy(InputStream, OutputStream) - Static method in class org.astrogrid.samp.httpd.UtilServer
-
Copies the content of an input stream to an output stream.
- CorsHttpServer - Class in org.astrogrid.samp.web
-
HttpServer which allows or rejects cross-origin access according to the W3C Cross-Origin Resource Sharing standard.
- CorsHttpServer(ServerSocket, OriginAuthorizer) - Constructor for class org.astrogrid.samp.web.CorsHttpServer
-
Constructor.
- create405Response(String[]) - Static method in class org.astrogrid.samp.httpd.HttpServer
-
Creates an HTTP response indicating that the requested method (GET, POST, etc) is not supported.
- createBox(int) - Method in class org.astrogrid.samp.gui.TransmissionListIcon
- createBroadcastAction() - Method in class org.astrogrid.samp.gui.AbstractCallActionManager
-
Must be implemented by concrete subclasses.
- createBroadcastAction() - Method in class org.astrogrid.samp.gui.IndividualCallActionManager
- createBroadcastAction() - Method in class org.astrogrid.samp.gui.NotifyActionManager
- createBroadcastAction() - Method in class org.astrogrid.samp.gui.SendActionManager
-
Returns a new action for broadcast associated with this object.
- createBroadcastAction() - Method in class org.astrogrid.samp.gui.UniformCallActionManager
- createCall(Document) - Static method in class org.astrogrid.samp.xmlrpc.internal.XmlRpcCall
-
Constructs an XmlRpcCall instance from a document with a methodCall element at top level.
- createClient(String, ProfileToken) - Method in class org.astrogrid.samp.gui.MessageTrackerHubService
- createClient(String, ProfileToken) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Factory method used to create all the client objects which will be used by this hub service.
- createClient(URL) - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheClientFactory
- createClient(URL) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalClientFactory
- createClient(URL) - Method in class org.astrogrid.samp.xmlrpc.internal.RpcLoggingInternalClientFactory
- createClient(URL) - Method in class org.astrogrid.samp.xmlrpc.internal.XmlLoggingInternalClientFactory
- createClient(URL) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcClientFactory
-
Returns an XML-RPC client implementation.
- createClientBox(boolean, int) - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Creates a component which shows an icon for each registered client.
- createClientListCellRenderer() - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Returns a list cell renderer suitable for use with the client list model returned by
GuiHubConnector.getClientListModel()
. - createClientListCellRenderer() - Method in class org.astrogrid.samp.gui.MessageTrackerHubConnector
- createClientSet() - Method in class org.astrogrid.samp.gui.GuiHubService
- createClientSet() - Method in class org.astrogrid.samp.gui.MessageTrackerHubService
- createClientSet() - Method in class org.astrogrid.samp.hub.BasicHubService
-
Factory method used to create the client set used by this hub service.
- createConnection() - Method in class org.astrogrid.samp.client.HubConnector
-
Invoked by this class to create a hub connection.
- createConnection() - Method in class org.astrogrid.samp.gui.MessageTrackerHubConnector
- createConnection(HubClient) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Returns a new HubConnection for use by a given hub client.
- createConnectionIndicator() - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Creates a component which indicates whether this connector is currently connected or not, using default icons.
- createConnectionIndicator(Icon, Icon) - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Creates a component which indicates whether this connector is currently connected or not, using supplied icons.
- createDefaultMetadata() - Static method in class org.astrogrid.samp.test.Snooper
-
Returns the default metadata for the Snooper client.
- createDefaultProfiles(boolean) - Static method in class org.astrogrid.samp.hub.Hub
-
Returns an array of default Hub Profiles.
- createEmptyIcon(int) - Static method in class org.astrogrid.samp.gui.IconStore
-
Returns an icon with no content but a given size.
- createErrorResponse(int, String) - Static method in class org.astrogrid.samp.httpd.HttpServer
-
Utility method to create an error response.
- createErrorResponse(int, String, Throwable) - Static method in class org.astrogrid.samp.httpd.HttpServer
-
Utility method to create an error response given an exception.
- createErrorResponse(ErrInfo) - Static method in class org.astrogrid.samp.Response
-
Returns a new response which is an error.
- createFixedClientAuthorizer(boolean) - Static method in class org.astrogrid.samp.web.ClientAuthorizers
-
Returns a new authorizer instance which always produces the same authorization status.
- createFixedOriginAuthorizer(boolean, boolean) - Static method in class org.astrogrid.samp.web.OriginAuthorizers
-
Returns an OriginAuthorizer with fixed responses, regardless of input.
- createFlashPolicyHandler(OriginAuthorizer) - Static method in class org.astrogrid.samp.web.OpenPolicyResourceHandler
-
Returns a handler which can serve the /crossdomain.xml file used by Adobe Flash.
- createHubAction(boolean, HubServiceMode) - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Returns an action which will start up a SAMP hub.
- createHubMessageHandlers() - Method in class org.astrogrid.samp.hub.BasicHubService
-
Constructs a list of MessageHandlers to use for the client provided by the Hub.
- createHubPanel() - Method in class org.astrogrid.samp.gui.GuiHubService
-
Creates a new component containing a display of the current hub internal state.
- createHubPanel() - Method in class org.astrogrid.samp.gui.MessageTrackerHubService
- createHubProfile(List) - Method in interface org.astrogrid.samp.hub.HubProfileFactory
-
Creates a HubProfile perhaps configured using a supplied list of flags.
- createHubProfile(List) - Method in class org.astrogrid.samp.web.WebHubProfileFactory
- createHubProfile(List) - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfileFactory
- createHubWindow() - Method in class org.astrogrid.samp.gui.GuiHubService
-
Creates a new window which maintains a display of the current hub internal state.
- createKeyGenerator() - Static method in class org.astrogrid.samp.web.WebHubProfile
-
Convenience method to return a new key generator suitable for use with a WebHubProfile.
- createLoggingClientAuthorizer(ClientAuthorizer, Level, Level) - Static method in class org.astrogrid.samp.web.ClientAuthorizers
-
Returns a new authorizer instance based on an existing one which logs authorization results through the logging system.
- createLoggingOriginAuthorizer(OriginAuthorizer, Level, Level) - Static method in class org.astrogrid.samp.web.OriginAuthorizers
-
Returns an OriginAuthorizer based on an existing one which logs responses.
- createMemoryOriginAuthorizer(OriginAuthorizer) - Static method in class org.astrogrid.samp.web.OriginAuthorizers
-
Returns an OriginAuthorizer based on an existing one which caches responses.
- createMenus() - Method in class org.astrogrid.samp.gui.GuiHubService
-
Returns an array of menus which may be added to a window containing this service's window.
- createMessage() - Method in class org.astrogrid.samp.gui.NotifyActionManager
-
Generates the message which is sent to one or all clients by this object's actions.
- createMessage() - Method in class org.astrogrid.samp.gui.UniformCallActionManager
-
Generates the message which is sent to one or all clients by this object's actions.
- createMessage(URL) - Method in class org.astrogrid.samp.util.ResourceType
-
Returns a Message object that will forward a given URL to SAMP clients.
- createMessage(Client) - Method in class org.astrogrid.samp.gui.AbstractCallActionManager
-
Returns the Message object which is to be transmitted by this manager to a given client.
- createMessage(Client) - Method in class org.astrogrid.samp.gui.IndividualCallActionManager
- createMessage(Client) - Method in class org.astrogrid.samp.gui.UniformCallActionManager
-
Implemented simply by calling
UniformCallActionManager.createMessage()
. - createMessageBox(int) - Method in class org.astrogrid.samp.gui.MessageTrackerHubConnector
-
Returns a component which displays messages currently being sent/received by this connector.
- createMessageBox(int, ListModel, ListModel) - Static method in class org.astrogrid.samp.gui.MessageTrackerHubConnector
-
Returns a component which displays messages in receiver and/or sender list models.
- createMinimalIcon(int) - Static method in class org.astrogrid.samp.gui.IconStore
-
Returns an icon which indicates a shape but doesn't look like much.
- createMonitorPanel() - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Returns a new component which displays status for this connector.
- createMonitorPanel() - Method in class org.astrogrid.samp.gui.MessageTrackerHubConnector
- createNonLocalErrorResponse(HttpServer.Request) - Static method in class org.astrogrid.samp.web.CorsHttpServer
-
Returns an HTTP error response complaining about attempted access from a disallowed host.
- createPolicyHandler(String, URL, String, OriginAuthorizer) - Static method in class org.astrogrid.samp.web.OpenPolicyResourceHandler
-
Creates a handler suitable for serving static cross-origin policy files.
- createPresentation(HttpServer.Request, Map, AuthResourceBundle.Content) - Method in interface org.astrogrid.samp.web.CredentialPresenter
-
Returns an object which contains user-directed credential messages, given available information from the registration request.
- createPresentation(HttpServer.Request, Map, AuthResourceBundle.Content) - Method in class org.astrogrid.samp.web.WebCredentialPresenter
- createRandom() - Static method in class org.astrogrid.samp.hub.KeyGenerator
-
Returns a new, randomly seeded, Random object.
- 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.
- createRegisterAction() - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Returns an action which attempts to register with the hub.
- createRegisterOrHubAction(Component, Action[]) - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Returns a new action which will register with a hub if one is running, and if not, will offer to start a hub.
- createResponse(Map) - Method in class org.astrogrid.samp.client.AbstractMessageHandler
-
Invoked by
receiveCall
to create a success response from the result of callingprocessCall
. - createResultHandler(HubConnection, Message, Client[]) - Method in class org.astrogrid.samp.gui.AbstractCallActionManager
-
Returns an object which will be informed of the results of a single- or multiple-recipient send as they arrive.
- createSampXmlRpcServer() - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Returns a new internal server.
- createSecret() - Method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Used to generate the registration password.
- createSecret() - Static method in class org.astrogrid.samp.xmlrpc.StandardHubProfile
-
Returns a string suitable for use as a Standard Profile Secret.
- createSendMenu() - Method in class org.astrogrid.samp.gui.NotifyActionManager
-
Returns a new menu for targetted sends with a title suitable for this object.
- createSendMenu() - Method in class org.astrogrid.samp.gui.UniformCallActionManager
-
Returns a new targetted send menu with a title suitable for this object.
- 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.
- createServerSocket(int) - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Creates a socket on a given port to be used by the server this object produces.
- createShowMonitorAction() - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Returns an action which will display a SAMP hub monitor window.
- createSilverlightPolicyHandler(OriginAuthorizer) - Static method in class org.astrogrid.samp.web.OpenPolicyResourceHandler
-
Returns a handler which can serve the /clientaccesspolicy.xml file used by Microsoft Silverlight.
- createSuccessResponse(Map) - Static method in class org.astrogrid.samp.Response
-
Returns a new response which is a success.
- createTag() - Method in class org.astrogrid.samp.gui.AbstractCallActionManager
-
Creates and returns a new tag which will be attached to an outgoing message, and updates internal structures so that it will be recognised in the future.
- createTag(Object) - Method in class org.astrogrid.samp.client.HubConnector
-
Generates a new
msgTag
for use with this connector. - createTargetAction(ComboBoxModel) - Method in class org.astrogrid.samp.gui.SendActionManager
-
Returns an action suitable for sending the message represented by this manager to a target selected by a supplied ComboBoxModel.
- createTargetSelector() - Method in class org.astrogrid.samp.gui.SendActionManager
-
Returns a new ComboBoxModel containing selections for each suitable client and an additional selection for broadcast to all clients.
- createToggleRegisterAction() - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Returns an action which toggles hub registration.
- createUnregisterAction() - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Returns an action which attempts to unregister from the hub.
- CredentialPresenter - Interface in org.astrogrid.samp.web
-
Extracts credentials for presentation to the user from available information, so that the user can decide whether to allow registration.
- CredentialPresenter.Presentation - Interface in org.astrogrid.samp.web
-
Aggregates credential information to be presented to the user.
D
- DataException - Exception in org.astrogrid.samp
-
Unchecked exception thrown when a data structure for use with SAMP does not have the correct form.
- DataException() - Constructor for exception org.astrogrid.samp.DataException
-
Constructs an exception with no message.
- DataException(String) - Constructor for exception org.astrogrid.samp.DataException
-
Consructs an exception with a given message.
- DataException(String, Throwable) - Constructor for exception org.astrogrid.samp.DataException
-
Constructs an exception with a given message and cause.
- DataException(Throwable) - Constructor for exception org.astrogrid.samp.DataException
-
Constructs an exception with a given cause.
- DEBUGTXT_KEY - Static variable in class org.astrogrid.samp.ErrInfo
-
Key for debugging information such as a stack trace.
- 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(Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- declareMetadata(HubClient, Map) - Method in class org.astrogrid.samp.gui.GuiHubService
- declareMetadata(HubClient, Map) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
declareMetadata
method of connections registered with this service. - 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(Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- declareSubscriptions(HubClient, Map) - Method in class org.astrogrid.samp.gui.GuiHubService
- declareSubscriptions(HubClient, Map) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
declareSubscriptions
method of connections registered with this service. - 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. - DEFAULT - Static variable in class org.astrogrid.samp.web.ListMessageRestriction
-
Default MessageRestriction implementation.
- DEFAULT_SAFE_MTYPES - Static variable in class org.astrogrid.samp.web.ListMessageRestriction
-
Default list of MType patterns returned by
ListMessageRestriction.getSafeMTypes()
. - DEFAULT_VERSION_VALUE - Static variable in class org.astrogrid.samp.xmlrpc.LockInfo
-
SAMP Standard Profile version for this toolkit implementation.
- DefaultClientProfile - Class in org.astrogrid.samp.client
-
Factory which supplies the default ClientProfile for use by SAMP clients.
- DENY_ALL - Static variable in class org.astrogrid.samp.web.ListMessageRestriction
-
MessageRestriction that blocks all MTypes, except as overridden by
x-samp.mostly-harmless
annotations. - 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.
- deserializeResponse(InputStream) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalClient
-
Deserializes an XML-RPC
methodResponse
document to a Java object. - deserializeResponse(InputStream) - Method in class org.astrogrid.samp.xmlrpc.internal.RpcLoggingInternalClient
- deserializeResponse(InputStream) - Method in class org.astrogrid.samp.xmlrpc.internal.XmlLoggingInternalClient
- DirectoryMapperHandler - Class in org.astrogrid.samp.httpd
-
Handler implementation which allows the server to serve a directory full of resources.
- DirectoryMapperHandler(String, String) - Constructor for class org.astrogrid.samp.httpd.DirectoryMapperHandler
-
Constructor.
- disconnect() - Method in class org.astrogrid.samp.client.HubConnector
-
Unregisters from the currently connected hub, if any.
- disconnect(String, String) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Forcibly disconnects a given client.
- disconnectAll(ProfileToken) - Method in class org.astrogrid.samp.hub.BasicHubService
- disconnectAll(ProfileToken) - Method in class org.astrogrid.samp.hub.FacadeHubService
- disconnectAll(ProfileToken) - Method in interface org.astrogrid.samp.hub.HubService
-
Forcibly terminates any connections created by a previous call of
HubService.register(org.astrogrid.samp.hub.ProfileToken)
with a particularprofileToken
. - dispose() - Method in class org.astrogrid.samp.gui.AbstractCallActionManager
-
Releases resources associated with this object.
- 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)
. - DOCURL_KEY - Static variable in class org.astrogrid.samp.Metadata
-
Key for the URL of a documentation web page.
- done() - Method in class org.astrogrid.samp.client.LogResultHandler
- done() - Method in interface org.astrogrid.samp.client.ResultHandler
-
Called when no more
ResultHandler.result(org.astrogrid.samp.Client, org.astrogrid.samp.Response)
invocations will be made, either because all have been received or for some other reason, such as a timeout or the hub shutting down. - done() - Method in class org.astrogrid.samp.gui.PopupResultHandler
E
- EMPTY - Static variable in class org.astrogrid.samp.SampMap
- 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
- ErrInfo - Class in org.astrogrid.samp
-
Represents the error information associated with a SAMP response.
- ErrInfo() - Constructor for class org.astrogrid.samp.ErrInfo
-
Constructs an empty ErrInfo.
- ErrInfo(String) - Constructor for class org.astrogrid.samp.ErrInfo
-
Constructs an ErrInfo with a given
ErrInfo.ERRORTXT_KEY
value. - 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.
- 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. - ErrorDialog - Class in org.astrogrid.samp.gui
-
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.
- ERRORTXT_KEY - Static variable in class org.astrogrid.samp.ErrInfo
-
Key for short description of what went wrong.
- exec(String, Object[]) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
-
Makes an XML-RPC call to the SAMP hub represented by this connection.
- exportFile(File) - Method in class org.astrogrid.samp.httpd.UtilServer
-
Exposes a file in the local filesystem as a publicly visible URL.
- exportResource(String) - Method in class org.astrogrid.samp.httpd.UtilServer
-
Deprecated.
- exportResource(URL) - Method in class org.astrogrid.samp.httpd.UtilServer
-
Exposes a resource from a given URL as a publicly visible URL.
- exportUrls(int, String) - Method in class org.astrogrid.samp.bridge.Bridge
-
Sets up a URL exporter for one of the hubs.
- EXTRAHOSTS_PROP - Static variable in class org.astrogrid.samp.web.CorsHttpServer
-
System property ("jsamp.web.extrahosts") which can be used to supply host addresses explicitly permitted to connect via the Web Profile alongside the local host.
- EXTRAHUBPROFILES_PROP - Static variable in class org.astrogrid.samp.hub.Hub
-
System property name for supplying default profiles ("jsamp.hub.profiles.extra") additional to those in
Hub.HUBPROFILES_PROP
which will be supported by the hub but switched off at hub startup time. - ExtremeSwingClientAuthorizer - Class in org.astrogrid.samp.web
-
Client authorizer implementation that does its very best to discourage users from accepting regitrations.
- ExtremeSwingClientAuthorizer(Component) - Constructor for class org.astrogrid.samp.web.ExtremeSwingClientAuthorizer
-
Constructor.
F
- FACADE - Static variable in class org.astrogrid.samp.hub.HubServiceMode
-
Hub Mode which piggy-backs on an existing hub using the default client profile.
- FacadeHubService - Class in org.astrogrid.samp.hub
-
HubService that provides hub functionality by accessing an existing hub service.
- FacadeHubService(ClientProfile) - Constructor for class org.astrogrid.samp.hub.FacadeHubService
-
Constructor.
- fail() - Static method in class org.astrogrid.samp.test.Tester
-
Fails a test.
- FALSE - Static variable in class org.astrogrid.samp.web.ClientAuthorizers
-
Authorizer which always denies access, with INFO logging either way.
- FALSE - Static variable in class org.astrogrid.samp.web.OriginAuthorizers
-
OriginAuthorizer which always denies access.
- fileToUrl(File) - Static method in class org.astrogrid.samp.SampUtils
-
Turns a File into a URL.
- flush() - Method in class org.astrogrid.samp.test.Calculator
-
Waits until all the responses this client is expecting to get have been safely received.
- forceLog(Logger, Level, String, Throwable) - Static method in class org.astrogrid.samp.ShutdownManager
-
Writes a log-like message directly to standard error if it has an appropriate level.
- formatObject(Object, int) - Static method in class org.astrogrid.samp.SampUtils
-
Pretty-prints a SAMP object.
- fromJson(String) - Static method in class org.astrogrid.samp.SampUtils
-
Parses JSON text to give a SAMP object.
G
- getActor() - Method in class org.astrogrid.samp.xmlrpc.ActorHandler
-
Returns the implementation object for this handler.
- getAppName(Map) - Static method in class org.astrogrid.samp.web.ClientAuthorizers
-
Returns the mandatory application name entry from the security map supplied explicitly by clients wishing to register.
- getAuthContent(ResourceBundle) - Static method in class org.astrogrid.samp.web.AuthResourceBundle
-
Returns a Content object based on a bundle which has the keys that AuthResourceBundle is supposed to have.
- getAuthEntries() - Method in interface org.astrogrid.samp.web.CredentialPresenter.Presentation
-
Returns an ordered map of String->String entries containing name, value pairs.
- getAuthLines() - Method in interface org.astrogrid.samp.web.CredentialPresenter.Presentation
-
Returns an array of "message" objects providing additional information for the user.
- getAvailableModes() - Static method in class org.astrogrid.samp.hub.HubServiceMode
-
Returns an array of the hub modes which can actually be used.
- getAvailableModes() - Static method in class org.astrogrid.samp.xmlrpc.HubMode
-
Deprecated.Returns an array of the hub modes which can actually be used.
- getBasePath(String) - Method in class org.astrogrid.samp.httpd.UtilServer
-
May be used to return a unique base path for use with this class's HttpServer.
- getBaseUrl() - Method in class org.astrogrid.samp.httpd.HttpServer
-
Returns the base URL for this server.
- getBaseUrl() - Method in class org.astrogrid.samp.httpd.MultiURLMapperHandler
-
Returns the base URL for resources served by this handler.
- getBaseUrl() - Method in class org.astrogrid.samp.httpd.URLMapperHandler
-
Returns the base URL for this handler.
- getBody() - Method in class org.astrogrid.samp.httpd.HttpServer.Request
-
Returns the body of the HTTP request if there was one.
- getBridgeClients() - Method in class org.astrogrid.samp.bridge.Bridge
-
Returns the hub connectors representing the bridge client running on each linked hub.
- getBroadcastAction() - Method in class org.astrogrid.samp.gui.SendActionManager
-
Returns an action which will broadcast a message to all suitable registered applications.
- getBroadcastIcon() - Static method in class org.astrogrid.samp.gui.SendActionManager
-
Returns an icon suitable for depicting a general broadcast send.
- getCallable() - Method in class org.astrogrid.samp.hub.HubClient
-
Returns the callable object which allows this client to receive callbacks.
- getChild(Node) - Static method in class org.astrogrid.samp.xmlrpc.internal.XmlUtils
-
Returns the single element child of a DOM node.
- getChild(Node, String) - Static method in class org.astrogrid.samp.xmlrpc.internal.XmlUtils
-
Returns the single child element of a DOM node, which has a given known name.
- getChildren(Node) - Static method in class org.astrogrid.samp.xmlrpc.internal.XmlUtils
-
Returns an array of all the Element children of a DOM node.
- 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.
- getClientKey() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
-
Returns an object which is used as the first argument of most XML-RPC calls to the hub.
- getClientList() - Method in class org.astrogrid.samp.gui.HubView
-
Returns the JList component which houses the active list of clients.
- getClientListModel() - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Returns a ListModel containing the registered clients.
- getClientListModel() - Method in class org.astrogrid.samp.gui.GuiHubService
-
Returns a ListModel containing information about clients currently registered with this hub.
- getClientListModel() - Method in class org.astrogrid.samp.gui.SendActionManager
-
Returns the client list to which this manager will offer sends.
- 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.
- getClientMap() - Method in class org.astrogrid.samp.client.TrackedClientSet
-
Returns an unmodifiable Map representing the client list.
- getClients() - Method in class org.astrogrid.samp.hub.BasicClientSet
- getClients() - Method in interface org.astrogrid.samp.hub.ClientSet
-
Returns an array of all the currently contained clients.
- getClientSelectionModel() - Method in class org.astrogrid.samp.gui.GuiHubService
-
Returns the selection model corresponding to this service's client list model.
- getClientSelectionModel() - Method in class org.astrogrid.samp.gui.MessageTrackerHubService
- getClientSet() - Method in class org.astrogrid.samp.client.HubConnector
-
Returns the tracked client set implementation which is used to keep track of the currently registered clients.
- getClientSet() - Method in class org.astrogrid.samp.hub.BasicHubService
-
Returns the structure which keeps track of registered clients.
- getCode() - Method in class org.astrogrid.samp.ErrInfo
-
Returns the value for the
ErrInfo.CODE_KEY
key. - getConfigModels() - Method in interface org.astrogrid.samp.hub.ConfigHubProfile
-
Returns some toggle button models for hub profile configuration.
- getConfigModels() - Method in class org.astrogrid.samp.web.WebHubProfile
- 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.
- getConnector() - Method in class org.astrogrid.samp.gui.SendActionManager
-
Returns this manager's hub connector.
- getContentLength() - Method in interface org.astrogrid.samp.httpd.ServerResource
-
Returns the number of bytes in this resource, if known.
- getContentType() - Method in interface org.astrogrid.samp.httpd.ServerResource
-
Returns the MIME type of this resource.
- getDebugtxt() - Method in class org.astrogrid.samp.ErrInfo
-
Returns the value for the
ErrInfo.DEBUGTXT_KEY
key. - getDefaultAppName() - Static method in class org.astrogrid.samp.web.WebClientProfile
-
Returns the default application name used by this profile if none is supplied explicitly.
- getDefaultHubEndpoint() - Static method in class org.astrogrid.samp.web.WebClientProfile
-
Returns the hub XML-RPC endpoint defined by the Web Profile.
- getDefaultLockUrl() - Static method in class org.astrogrid.samp.xmlrpc.StandardClientProfile
-
Returns the lockfile URL which will be used in absence of any SAMP_HUB environment variable.
- getDefaultProfileClasses(boolean) - Static method in class org.astrogrid.samp.hub.Hub
-
Returns a copy of the default set of HubProfile classes used when a hub is run and the list of profiles is not set explicitly.
- 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.
- getDoneTime() - Method in class org.astrogrid.samp.gui.Transmission
-
Returns the epoch at which this transmission was completed.
- getElementAt(int) - Method in class org.astrogrid.samp.gui.SelectiveClientListModel
- getEndpoint() - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheServer
- getEndpoint() - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServer
- getEndpoint() - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcServer
-
Returns the server's endpoint.
- getEnv(String) - Method in class org.astrogrid.samp.Platform
-
Returns the value of an environment variable.
- getErrInfo() - Method in class org.astrogrid.samp.Response
-
Returns the error object.
- getError() - Method in class org.astrogrid.samp.gui.Transmission
-
Returns a Throwable which prevented normal resolution of this transmission.
- getErrortxt() - Method in class org.astrogrid.samp.ErrInfo
-
Returns the value for the
ErrInfo.ERRORTXT_KEY
key. - getFaultBytes(Throwable) - Static method in class org.astrogrid.samp.xmlrpc.internal.InternalServer
-
Turns an exception into an array of bytes giving an XML-RPC methodResponse (fault) document.
- getFlagsUsage() - Method in interface org.astrogrid.samp.hub.HubProfileFactory
-
Returns an array of strings, each describing one command-line flag which will be consumed by the
createProfile
method. - getFlagsUsage() - Method in class org.astrogrid.samp.web.WebHubProfileFactory
- getFlagsUsage() - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfileFactory
- getFromPublicId(String) - Method in class org.astrogrid.samp.hub.BasicClientSet
- getFromPublicId(String) - Method in interface org.astrogrid.samp.hub.ClientSet
-
Returns the client in the set corresponding to a given public ID.
- getGetenvArgs(String) - Method in class org.astrogrid.samp.Platform
-
Returns an array of words to pass to
Runtime.exec(java.lang.String[])
in order to read an environment variable name. - getHeader(Map, String) - Static method in class org.astrogrid.samp.httpd.HttpServer
-
Returns a header value from a header map.
- getHeaderMap() - Method in class org.astrogrid.samp.httpd.HttpServer.Request
-
Returns a map of key-value pairs representing HTTP request headers.
- getHeaderMap() - Method in class org.astrogrid.samp.httpd.HttpServer.Response
-
Returns a map of key-value pairs representing HTTP response headers.
- getHomeDirectory() - Method in class org.astrogrid.samp.Platform
-
Returns SAMP's definition of the "home" directory.
- getHttpServer() - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServer
-
Returns the HTTP server hosting this XML-RPC server.
- getHub() - Method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Returns the HubService object used by this runner.
- getHubConnector() - Method in class org.astrogrid.samp.gui.HubMonitor
-
Returns this monitor's HubConnector.
- getHubEndpoint() - Method in class org.astrogrid.samp.web.WebClientProfile
-
Returns the hub XML-RPC endpoint used by this profile.
- getHubId() - Method in class org.astrogrid.samp.RegInfo
-
Returns the hub's own public client id.
- getHubProfileClass() - Method in interface org.astrogrid.samp.hub.HubProfileFactory
-
Returns a HubProfile subclass with a no-arg constructor which, when invoked, will produce a basic instance of the HubProfile represented by this factory.
- getHubProfileClass() - Method in class org.astrogrid.samp.web.WebHubProfileFactory
- getHubProfileClass() - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfileFactory
- getHubService() - Method in class org.astrogrid.samp.hub.Hub
-
Returns the hub service associated with this hub.
- getIcon(int) - Method in class org.astrogrid.samp.gui.Transmission.Status
-
Returns a little icon representing status.
- getIcon(String) - Method in class org.astrogrid.samp.gui.IconStore
-
Returns the icon supplied by the graphic file at a given URL.
- getIcon(Client) - Method in class org.astrogrid.samp.gui.IconStore
-
Returns the icon associated with a given client.
- getIconHeight() - Method in class org.astrogrid.samp.gui.TransmissionListIcon
- getIconUrl() - Method in class org.astrogrid.samp.Metadata
-
Returns a URL for a gif, png or jpeg icon identifying the application.
- getIconWidth() - Method in class org.astrogrid.samp.gui.TransmissionListIcon
- getId() - Method in interface org.astrogrid.samp.Client
-
Returns the public identifier for this client.
- getId() - Method in class org.astrogrid.samp.hub.HubClient
- getIdComparator() - Method in class org.astrogrid.samp.hub.BasicHubService
-
Returns a comparator which will order client IDs.
- getInstance() - Static method in class org.astrogrid.samp.gui.SysTray
-
Returns an instance of this class.
- getInstance() - Static method in class org.astrogrid.samp.httpd.UtilServer
-
Returns the default instance of this class.
- getInstance() - Static method in class org.astrogrid.samp.ShutdownManager
-
Returns sole instance of this class.
- getInstance() - Static method in class org.astrogrid.samp.web.WebClientProfile
-
Returns a default instance of this profile.
- 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.
- getKeys() - Method in class org.astrogrid.samp.web.AuthResourceBundle
- getKnownHubProfileFactories() - Static method in class org.astrogrid.samp.hub.Hub
-
Returns a standard list of known HubProfileFactories.
- getKnownResourceTypes() - Static method in class org.astrogrid.samp.util.ResourceType
-
Returns the known resource types.
- getList(String) - Method in class org.astrogrid.samp.SampMap
-
Returns the value for a given key in this map, cast to List.
- 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.
- getLockInfo() - Method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Returns the lockfile information associated with this object.
- getLockInfo() - Method in class org.astrogrid.samp.xmlrpc.StandardClientProfile
-
Returns the LockInfo which indicates how to locate the hub.
- getLockInfo() - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfile
-
Returns the lockfile information associated with this object.
- getLockUrl() - Static method in class org.astrogrid.samp.xmlrpc.StandardClientProfile
-
Returns the location of the Standard Profile lockfile.
- getLogType() - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Returns the type of logging to use.
- getMap(String) - Method in class org.astrogrid.samp.SampMap
-
returns the value for a given key in this map, cast to Map.
- getMapperHandler() - Method in class org.astrogrid.samp.httpd.UtilServer
-
Returns a handler for mapping local to external URLs associated with this server.
- getMessage() - Method in class org.astrogrid.samp.gui.Transmission
-
Returns the message which was sent.
- getMessageId() - Method in class org.astrogrid.samp.gui.Transmission
-
Returns the message ID associated with this message.
- getMessageRestriction() - Method in interface org.astrogrid.samp.hub.ProfileToken
-
Returns a MessageRestriction object which controls what messages may be sent by clients registering under ths profile.
- getMessageRestriction() - Method in class org.astrogrid.samp.web.WebHubProfile
- getMessageRestriction() - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfile
- getMessageTag() - Method in class org.astrogrid.samp.gui.Transmission
-
Returns the message tag corresponding to this transmission.
- getMetadata() - Method in interface org.astrogrid.samp.Client
-
Returns the currently declared metadata for this client, if any.
- getMetadata() - Method in class org.astrogrid.samp.client.HubConnector
-
Returns this client's own metadata.
- getMetadata() - Method in class org.astrogrid.samp.hub.HubClient
- getMetadata(String) - Method in interface org.astrogrid.samp.client.HubConnection
-
Returns the metadata for another registered client.
- getMetadata(String) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- getMetadata(HubClient, String) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
getMetadata
method of connections registered with this service. - getMethod() - Method in class org.astrogrid.samp.httpd.HttpServer.Request
-
Returns the request method string.
- getMethodName() - Method in class org.astrogrid.samp.xmlrpc.internal.XmlRpcCall
-
Returns the method name.
- getModeFromName(String) - Static method in class org.astrogrid.samp.hub.HubServiceMode
-
Returns one of the known modes which has a name as given.
- getModeFromName(String) - Static method in class org.astrogrid.samp.xmlrpc.HubMode
-
Deprecated.Returns one of the known modes which has a name as given.
- getMType() - Method in class org.astrogrid.samp.Message
-
Returns this message's MType.
- getMType() - Method in class org.astrogrid.samp.util.ResourceType
-
Returns the MType of the message to be constructed.
- getMTypes() - Method in class org.astrogrid.samp.gui.SubscribedClientListModel
-
Returns the list of MTypes which defines the elements of this list.
- getName() - Method in interface org.astrogrid.samp.hub.HubProfileFactory
-
Returns the name used to identify this profile.
- getName() - Method in class org.astrogrid.samp.Metadata
-
Returns the value for the application's name.
- getName() - Method in class org.astrogrid.samp.util.ResourceType
-
Returns the name of this resource type.
- getName() - Method in class org.astrogrid.samp.web.WebHubProfileFactory
-
Returns "web".
- getName() - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfileFactory
-
Returns "std".
- getName() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcKit
-
Returns the name of this kit.
- getOriginAuthorizer() - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Returns the authorization policy for external origins.
- 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.
- getParams() - Method in class org.astrogrid.samp.xmlrpc.internal.XmlRpcCall
-
Returns the parameter list.
- getPlatform() - Static method in class org.astrogrid.samp.Platform
-
Returns a
Platform
instance for the current system. - getPort() - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Returns the port number the server will run on.
- getPrivateKey() - Method in class org.astrogrid.samp.RegInfo
-
Returns the registered client's private key (Standard Profile).
- getPrivateReadArgs(File) - Method in class org.astrogrid.samp.Platform
-
Returns an array of words to pass 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. - getProfile() - Static method in class org.astrogrid.samp.client.DefaultClientProfile
-
Returns a ClientProfile instance suitable for general purpose use.
- getProfileName() - Method in interface org.astrogrid.samp.hub.HubProfile
-
Returns the name of this profile.
- getProfileName() - Method in interface org.astrogrid.samp.hub.ProfileToken
-
Returns the name by which this token is to be identified.
- getProfileName() - Method in class org.astrogrid.samp.web.WebHubProfile
- getProfileName() - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfile
- getProfiles() - Method in class org.astrogrid.samp.bridge.Bridge
-
Returns the client profiles which define the hubs this bridge links.
- getProfileToken() - Method in class org.astrogrid.samp.hub.HubClient
-
Returns a token identifying the source of this client's connection to the hub.
- 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.gui.Transmission
-
Returns the client to which this transmission was sent.
- 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
- getRegisteredClients() - Method in interface org.astrogrid.samp.client.HubConnection
-
Returns the list of client public IDs for those clients currently registered.
- getRegisteredClients() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- getRegisteredClients(HubClient) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
getRegisteredClients
method of connections registered with this service. - getRemoteAddress() - Method in class org.astrogrid.samp.httpd.HttpServer.Request
-
Returns the address of the client which made this request.
- 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. - getResourceHandler() - Method in class org.astrogrid.samp.httpd.UtilServer
-
Returns a handler for general purpose resource serving associated with this server.
- getResponse() - Method in class org.astrogrid.samp.gui.Transmission
-
Returns the response for this transmission.
- getResult() - Method in class org.astrogrid.samp.Response
-
Returns the result map.
- getResultBytes(Object) - Static method in class org.astrogrid.samp.xmlrpc.internal.InternalServer
-
Turns a SAMP-friendly (string, list, map only) object into an array of bytes giving an XML-RPC methodResponse document.
- getRunningHubs() - Static method in class org.astrogrid.samp.hub.Hub
-
Returns an array of all the instances of this class which are currently running.
- getRunningProfiles() - Method in class org.astrogrid.samp.hub.Hub
-
Returns the hub profiles currently running on behalf of this hub.
- getRxListModel() - Method in class org.astrogrid.samp.gui.MessageTrackerHubConnector
-
Returns a ListModel representing the pending messages received using this connector.
- getRxListModel(Client) - Method in class org.astrogrid.samp.gui.MessageTrackerHubConnector
- getRxListModel(Client) - Method in class org.astrogrid.samp.gui.MessageTrackerHubService
-
Returns a ListModel representing the pending messages received by a given client.
- getSafeMTypes() - Static method in class org.astrogrid.samp.web.ListMessageRestriction
-
Returns a list of MType patterns which are permitted by the DEFAULT policy.
- 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.xmlrpc.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.AbstractCallActionManager
- getSendAction(Client) - Method in class org.astrogrid.samp.gui.NotifyActionManager
- getSendAction(Client) - Method in class org.astrogrid.samp.gui.SendActionManager
-
Returns an action which can perform a single-client send associated with this object.
- getSendAction(Client) - Method in class org.astrogrid.samp.gui.UniformCallActionManager
- getSendCount() - Method in class org.astrogrid.samp.test.Calculator
-
Returns the total number of messages sent using any delivery pattern.
- getSender() - Method in class org.astrogrid.samp.gui.Transmission
-
Returns the client which sent this transmission.
- getSendIcon() - Static method in class org.astrogrid.samp.gui.SendActionManager
-
Returns an icon suitable for depicting a general targetted send.
- getServer() - Method in class org.astrogrid.samp.httpd.UtilServer
-
Returns the HttpServer associated with this object.
- getServer() - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheServerFactory
- getServer() - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServerFactory
- getServer() - Method in class org.astrogrid.samp.xmlrpc.internal.RpcLoggingInternalServerFactory
- getServer() - Method in class org.astrogrid.samp.xmlrpc.internal.XmlLoggingInternalServerFactory
- getServer() - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcServerFactory
-
Returns an XML-RPC server implementation.
- getServerFactory() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcKit
-
Returns an XML-RPC server factory.
- getServiceConnection() - Method in class org.astrogrid.samp.hub.BasicHubService
-
Returns the HubConnection object used by the hub itself to send and receive messages.
- getSize() - Method in class org.astrogrid.samp.gui.SelectiveClientListModel
- getSocket() - Method in class org.astrogrid.samp.httpd.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.gui.Transmission
-
Returns an object which describes the current status of this transmission in terms which can be presented to the GUI.
- getStatus() - Method in class org.astrogrid.samp.Response
-
Returns the status value.
- getStatusCode() - Method in class org.astrogrid.samp.httpd.HttpServer.Response
-
Returns the 3-digit status code.
- getStatusPhrase() - Method in class org.astrogrid.samp.httpd.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(String) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- getSubscribedClients(HubClient, String) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
getSubscribedClients
method of connections registered with this service. - getSubscription(String) - Method in class org.astrogrid.samp.hub.HubClient
-
Returns the subscription information for a given MType for this client.
- getSubscription(String) - Method in class org.astrogrid.samp.Subscriptions
-
Returns the map which forms the value for a given MType key.
- getSubscriptions() - Method in class org.astrogrid.samp.client.AbstractMessageHandler
- 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.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() - Method in class org.astrogrid.samp.hub.HubClient
- getSubscriptions(String) - Method in interface org.astrogrid.samp.client.HubConnection
-
Returns the subscriptions for another registered client.
- getSubscriptions(String) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- getSubscriptions(HubClient, String) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
getSubscriptions
method of connections registered with this service. - getText() - Method in class org.astrogrid.samp.gui.Transmission.Status
-
Returns the text for this status.
- getTextContent(Element) - Static method in class org.astrogrid.samp.xmlrpc.internal.XmlUtils
-
Returns the text content of an element as a string.
- getTransmission() - Method in class org.astrogrid.samp.gui.TransmissionPanel
-
Returns the transmission object currently being displayed.
- getTransmissionAt(Point) - Method in class org.astrogrid.samp.gui.TransmissionListIcon
-
Returns the transmission (if any) which is painted at a given point.
- getTxListModel() - Method in class org.astrogrid.samp.gui.MessageTrackerHubConnector
-
Returns a ListModel representing the pending messages sent using this connector.
- getTxListModel(Client) - Method in class org.astrogrid.samp.gui.MessageTrackerHubConnector
- getTxListModel(Client) - Method in class org.astrogrid.samp.gui.MessageTrackerHubService
-
Returns a ListModel representing the pending messages sent from a given client.
- getUnusedPort(int) - Static method in class org.astrogrid.samp.SampUtils
-
Returns an unused port number on the local host.
- getUrl() - Method in class org.astrogrid.samp.httpd.HttpServer.Request
-
Returns the request URL string.
- getUrl(String) - Method in class org.astrogrid.samp.SampMap
-
Returns the value for a given key in this map as a URL.
- getUrlTranslationHandler() - Method in class org.astrogrid.samp.web.WebHubXmlRpcHandler
-
Returns a handler suitable for performing URL translations on behalf of sandboxed clients as required by the Web Profile.
- getUsertxt() - Method in class org.astrogrid.samp.ErrInfo
-
Returns the value for the
ErrInfo.USERTXT_KEY
key. - getVersion() - Method in class org.astrogrid.samp.xmlrpc.LockInfo
-
Returns the value of the
LockInfo.VERSION_KEY
key. - getWindow() - Method in class org.astrogrid.samp.hub.Hub
-
Returns a window for user monitoring and control of this hub, if available.
- getXmlrpcPath() - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Returns the path on the HTTP server at which the XML-RPC server will reside.
- getXmlRpcResponse(HttpServer.Request) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServer
-
Returns the HTTP response object given an incoming XML-RPC POST request.
- getXmlRpcResponse(HttpServer.Request) - Method in class org.astrogrid.samp.xmlrpc.internal.XmlLoggingInternalServer
- getXmlrpcUrl() - Method in class org.astrogrid.samp.xmlrpc.LockInfo
-
Returns the value of the
LockInfo.XMLRPCURL_KEY
key. - GuiHubConnector - Class in org.astrogrid.samp.gui
-
Extends HubConnector to provide additional graphical functionality.
- GuiHubConnector(ClientProfile) - Constructor for class org.astrogrid.samp.gui.GuiHubConnector
-
Constructs a hub connector based on a given profile instance.
- GuiHubService - Class in org.astrogrid.samp.gui
-
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.
H
- handleCall(String, List, Object) - Method in class org.astrogrid.samp.web.WebHubXmlRpcHandler
- handleCall(String, List, Object) - Method in class org.astrogrid.samp.xmlrpc.ActorHandler
- handleCall(String, List, Object) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcHandler
-
Processes an XML-RPC call.
- handleCall(SampXmlRpcHandler, String, List, HttpServer.Request) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServer
-
Actually passes the XML-RPC method name and parameter list to one of the registered servers for processing.
- handleCall(SampXmlRpcHandler, String, List, HttpServer.Request) - Method in class org.astrogrid.samp.xmlrpc.internal.RpcLoggingInternalServer
- handleGetObject(String) - Method in class org.astrogrid.samp.web.AuthResourceBundle
- HDR_CONTENT_TYPE - Static variable in class org.astrogrid.samp.httpd.HttpServer
-
Header string for MIME content type.
- HttpServer - Class in org.astrogrid.samp.httpd
-
Simple modular HTTP server.
- HttpServer() - Constructor for class org.astrogrid.samp.httpd.HttpServer
-
Constructs a server based on a default socket, on any free port.
- HttpServer(ServerSocket) - Constructor for class org.astrogrid.samp.httpd.HttpServer
-
Constructs a server based on a given socket.
- HttpServer.Handler - Interface in org.astrogrid.samp.httpd
-
Implemented to serve data for some URLs.
- HttpServer.Request - Class in org.astrogrid.samp.httpd
-
Represents a parsed HTTP client request.
- HttpServer.Response - Class in org.astrogrid.samp.httpd
-
Represents a response to an HTTP request.
- Hub - Class in org.astrogrid.samp.hub
-
Class which manages a hub and its associated profiles.
- Hub(HubService) - Constructor for class org.astrogrid.samp.hub.Hub
-
Constructor.
- HUB_SEQUENCE - Static variable in class org.astrogrid.samp.ShutdownManager
-
Shutdown sequence value for hub hooks.
- HubClient - Class in org.astrogrid.samp.hub
-
Represents a client registered with a hub.
- HubClient(String, ProfileToken) - Constructor for class org.astrogrid.samp.hub.HubClient
-
Constructor.
- HubConnection - Interface in org.astrogrid.samp.client
-
Represents a registered client's connection to a running hub.
- HubConnector - Class in org.astrogrid.samp.client
-
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.
- HubConnector(ClientProfile, TrackedClientSet) - Constructor for class org.astrogrid.samp.client.HubConnector
-
Constructs a HubConnector based on a given profile instance using a custom client set implementation.
- HUBID_KEY - Static variable in class org.astrogrid.samp.RegInfo
-
Key for client public-id used by hub when sending messages itself.
- HUBLOC_CLASS_PREFIX - Static variable in class org.astrogrid.samp.client.DefaultClientProfile
-
Prefix for SAMP_HUB env var indicating a supplied ClientProfile implementation ("jsamp-class:").
- HUBLOC_ENV - Static variable in class org.astrogrid.samp.client.DefaultClientProfile
-
Environment variable used for hub location ("SAMP_HUB").
- HubMode - Class in org.astrogrid.samp.xmlrpc
-
Deprecated.use
HubServiceMode
withHub
instead - HubMonitor - Class in org.astrogrid.samp.gui
-
Client application which uses a
GuiHubConnector
to connect to any running hub and display information about all currently registered clients. - HubMonitor(ClientProfile, boolean, int) - Constructor for class org.astrogrid.samp.gui.HubMonitor
-
Constructor.
- HubProfile - Interface in org.astrogrid.samp.hub
-
Defines a hub profile.
- HubProfileFactory - Interface in org.astrogrid.samp.hub
-
Factory to produce hub profiles of a particular type.
- HUBPROFILES_PROP - Static variable in class org.astrogrid.samp.hub.Hub
-
System property name for supplying default profiles ("jsamp.hub.profiles") available at hub startup.
- HubRunner - Class in org.astrogrid.samp.xmlrpc
-
Deprecated.use
Hub
instead - HubRunner(SampXmlRpcClientFactory, SampXmlRpcServerFactory, HubService, File) - Constructor for class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Constructor.
- HubService - Interface in org.astrogrid.samp.hub
-
Interface defining the work that the hub has to do.
- HubServiceMode - Class in org.astrogrid.samp.hub
-
Specifies a particular hub implementation for use with
Hub
. - HubSwingClientAuthorizer - Class in org.astrogrid.samp.web
-
ClientAuthorizer implementation that queries the user for permission via a popup dialogue.
- HubSwingClientAuthorizer(Component, CredentialPresenter) - Constructor for class org.astrogrid.samp.web.HubSwingClientAuthorizer
-
Constructor.
- HubTester - Class in org.astrogrid.samp.test
-
Tester for a running hub.
- HubTester(ClientProfile) - Constructor for class org.astrogrid.samp.test.HubTester
-
Constructor.
- HubView - Class in org.astrogrid.samp.gui
-
Component displaying a list of SAMP
Client
s, usually those registered with a hub. - HubView(boolean) - Constructor for class org.astrogrid.samp.gui.HubView
-
Constructor.
I
- IconStore - Class in org.astrogrid.samp.gui
-
Manages client icons.
- IconStore(Icon) - Constructor for class org.astrogrid.samp.gui.IconStore
-
Constructor.
- 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.
- IndividualCallActionManager - Class in org.astrogrid.samp.gui
-
SendActionManager which uses the Asynchronous Call/Response delivery pattern, but allows a "broadcast" to send different message objects to different recipients.
- IndividualCallActionManager(Component, GuiHubConnector, ListModel) - Constructor for class org.astrogrid.samp.gui.IndividualCallActionManager
-
Constructor.
- init() - Method in class org.astrogrid.samp.gui.SelectiveClientListModel
-
Must be called by subclass prior to use.
- INSTANCE - Static variable in class org.astrogrid.samp.web.WebCredentialPresenter
-
Singleton instance.
- INTERNAL - Static variable in class org.astrogrid.samp.xmlrpc.XmlRpcKit
-
Implementation which requires no external libraries.
- InternalClient - Class in org.astrogrid.samp.xmlrpc.internal
-
XML-RPC client implementation suitable for use with SAMP.
- InternalClient(URL) - Constructor for class org.astrogrid.samp.xmlrpc.internal.InternalClient
-
Constructor.
- InternalClientFactory - Class in org.astrogrid.samp.xmlrpc.internal
-
Freestanding SampXmlRpcClientFactory implementation.
- InternalClientFactory() - Constructor for class org.astrogrid.samp.xmlrpc.internal.InternalClientFactory
- InternalServer - Class in org.astrogrid.samp.xmlrpc.internal
-
SampXmlRpcServer implementation without external dependencies.
- InternalServer() - Constructor for class org.astrogrid.samp.xmlrpc.internal.InternalServer
-
Constructs a server running with default characteristics.
- InternalServer(HttpServer, String) - Constructor for class org.astrogrid.samp.xmlrpc.internal.InternalServer
-
Constructor based on a given HTTP server.
- InternalServerFactory - Class in org.astrogrid.samp.xmlrpc.internal
-
Freestanding SampXmlRpcServerFactory implementation.
- InternalServerFactory() - Constructor for class org.astrogrid.samp.xmlrpc.internal.InternalServerFactory
- invokeMethod(Method, Object, Object[]) - Method in class org.astrogrid.samp.web.WebHubXmlRpcHandler
- invokeMethod(Method, Object, Object[]) - Method in class org.astrogrid.samp.xmlrpc.ActorHandler
-
Invokes a method reflectively on an object.
- isActive() - Method in class org.astrogrid.samp.client.HubConnector
-
Indicates whether this connector is active or not.
- isAllowFlash() - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Indicates whether Adobe Flash cross-domain workaround will be supported.
- isAllowSilverlight() - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Indicates whether Microsoft Silverlight cross-domain workaround will be supported.
- 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.
- isContentType(String) - Method in class org.astrogrid.samp.util.ResourceType
-
Indicates whether this resource type is suitable for use with a given MIME type.
- isDone() - Method in class org.astrogrid.samp.gui.Transmission
-
Indicates whether further changes to the state of this object are expected, that is if a response/failure is yet to be received.
- isExtraHost(SocketAddress) - Static method in class org.astrogrid.samp.web.CorsHttpServer
-
Indicates whether a given address represents one of the "extra" hosts permitted to access this server alongside the localhost.
- isHubRunning() - Method in interface org.astrogrid.samp.client.ClientProfile
-
Indicates whether a hub contactable by this profile appears to be running.
- isHubRunning() - Method in class org.astrogrid.samp.hub.BasicHubService
- isHubRunning() - Method in class org.astrogrid.samp.hub.FacadeHubService
- isHubRunning() - Method in interface org.astrogrid.samp.hub.HubService
-
Indicates whether this hub service is currently open for operations.
- isHubRunning() - Method in class org.astrogrid.samp.web.WebClientProfile
- isHubRunning() - Method in class org.astrogrid.samp.xmlrpc.StandardClientProfile
- 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. - isLocalHost(SocketAddress) - Static method in class org.astrogrid.samp.web.CorsHttpServer
-
Indicates whether the given socket address is from the local host.
- isMagic(byte[]) - Method in class org.astrogrid.samp.util.ResourceType
-
Indicates whether this resource type is suitable for use with a resource having a given magic number.
- isOK() - Method in class org.astrogrid.samp.Response
-
Indicates whether the result was an unequivocal success.
- isPermittedHost(SocketAddress) - Method in class org.astrogrid.samp.web.CorsHttpServer
-
Indicates whether a network address is known to represent a host permitted to access this server.
- isRunning() - Method in class org.astrogrid.samp.httpd.HttpServer
-
Indicates whether this server is currently running.
- isRunning() - Method in interface org.astrogrid.samp.hub.HubProfile
-
Indicates whether this profile is currently running.
- isRunning() - Method in class org.astrogrid.samp.web.WebHubProfile
- isRunning() - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfile
- isSensitive(URL) - Method in class org.astrogrid.samp.web.UrlTracker
-
Indicates whether a given URL is potentially sensitive.
- isStringChar(char) - Static method in class org.astrogrid.samp.SampUtils
-
Indicates whether a given character is legal to include in a SAMP string.
- isSubscribed(String) - Method in class org.astrogrid.samp.hub.HubClient
-
Indicates whether this client is subscribed to a given MType.
- isSubscribed(String) - Method in class org.astrogrid.samp.Subscriptions
-
Determines whether a given (non-wildcarded) MType is subscribed to by this object.
- isSupported() - Method in class org.astrogrid.samp.gui.SysTray
-
Indicates whether system tray functionality is available.
- isUrlPermitted(URL) - Method in class org.astrogrid.samp.web.UrlTracker
-
Indicates whether access to a given URL should be permitted, according to the strategy implemented by this class, from a Web Profile client.
J
- JSamp - Class in org.astrogrid.samp
-
Convenience class for invoking JSAMP command-line applications.
K
- KeyGenerator - Class in org.astrogrid.samp.hub
-
Object which can generate a sequence of private keys.
- KeyGenerator(String, int, Random) - Constructor for class org.astrogrid.samp.hub.KeyGenerator
-
Constructor.
- KNOWN_IMPLS - Static variable in class org.astrogrid.samp.xmlrpc.XmlRpcKit
-
Array of available known implementations of this class.
L
- ListMessageRestriction - Class in org.astrogrid.samp.web
-
General purpose implementation of MessageRestriction.
- ListMessageRestriction(boolean, String[], boolean) - Constructor for class org.astrogrid.samp.web.ListMessageRestriction
-
Constructor.
- LOCALHOST_PROP - Static variable in class org.astrogrid.samp.SampUtils
-
Property which can be used to set name used for localhost in server endpoints.
- LOCKFILE_NAME - Static variable in class org.astrogrid.samp.xmlrpc.StandardClientProfile
-
Filename used for lockfile in home directory by default (".samp").
- LockInfo - Class in org.astrogrid.samp.xmlrpc
-
Represents the information read from a SAMP Standard Profile Lockfile.
- LockInfo() - Constructor for class org.astrogrid.samp.xmlrpc.LockInfo
-
Constructs an empty LockInfo.
- LockInfo(String, String) - Constructor for class org.astrogrid.samp.xmlrpc.LockInfo
-
Constructs a LockInfo from a given SAMP secret and XML-RPC URL.
- LockInfo(Map) - Constructor for class org.astrogrid.samp.xmlrpc.LockInfo
-
Constructs a LockInfo based on an existing map.
- LockWriter - Class in org.astrogrid.samp.hub
-
Writes records to a SAMP Standard Profile hub lockfile.
- LockWriter(OutputStream) - Constructor for class org.astrogrid.samp.hub.LockWriter
-
Constructs a writer for writing to a given output stream.
- LoggingCorsHttpServer - Class in org.astrogrid.samp.web
-
CorsHttpServer subclass which performs logging to a given print stream at the HTTP level.
- LoggingCorsHttpServer(ServerSocket, OriginAuthorizer, PrintStream) - Constructor for class org.astrogrid.samp.web.LoggingCorsHttpServer
-
Constructor.
- LogResultHandler - Class in org.astrogrid.samp.client
-
ResultHandler implementation which outputs some information about responses received through the logging system.
- LogResultHandler(Message) - Constructor for class org.astrogrid.samp.client.LogResultHandler
-
Constructor.
M
- main(String[]) - Static method in class org.astrogrid.samp.bridge.Bridge
-
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.hub.Hub
-
Main method, which allows configuration of which profiles will run and configuration of those individual profiles.
- main(String[]) - Static method in class org.astrogrid.samp.JSamp
-
Main method.
- 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.util.SampLoad
-
Main method.
- main(String[]) - Static method in class org.astrogrid.samp.web.AuthResourceBundle
-
Writes a template .properties file.
- main(String[]) - Static method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Main method.
- mapUrlResponse(String, URL) - Static method in class org.astrogrid.samp.httpd.URLMapperHandler
-
Repackages a resource from a given target URL as an HTTP response.
- matchLevel(String, String) - Static method in class org.astrogrid.samp.Subscriptions
-
Performs wildcard matching of MTypes.
- MAX_TIMEOUT - Static variable in class org.astrogrid.samp.hub.BasicHubService
-
The maximum timeout for a synchronous call permitted in seconds.
- MAX_WAITERS - Static variable in class org.astrogrid.samp.hub.BasicHubService
-
The maximum number of concurrently pending synchronous calls.
- Message - Class in org.astrogrid.samp
-
Represents an encoded SAMP Message.
- Message() - Constructor for class org.astrogrid.samp.Message
-
Constructs an empty message.
- Message(String) - Constructor for class org.astrogrid.samp.Message
-
Constructs a message with a given MType.
- Message(String, Map) - Constructor for class org.astrogrid.samp.Message
-
Constructs a message with a given MType and params map.
- Message(Map) - Constructor for class org.astrogrid.samp.Message
-
Constructs a message based on an existing map.
- MESSAGE_GUI - Static variable in class org.astrogrid.samp.hub.HubServiceMode
-
Hub mode with a GUI representation of clients and messages.
- MESSAGE_GUI - Static variable in class org.astrogrid.samp.xmlrpc.HubMode
-
Deprecated.Hub mode with a GUI representation of clients and messages.
- MessageHandler - Interface in org.astrogrid.samp.client
-
Interface for a client which wishes to receive messages.
- MessageRestriction - Interface in org.astrogrid.samp.hub
-
Specifies restrictions on the message types that may be sent in a particular context.
- MessageSender - Class in org.astrogrid.samp.test
-
Sends a message to one or more other SAMP clients.
- MessageSender() - Constructor for class org.astrogrid.samp.test.MessageSender
- messageSent(HubConnection, Message, Client[]) - Method in class org.astrogrid.samp.gui.NotifyActionManager
-
Called when a message has been sent by this object.
- MessageTrackerHubConnector - Class in org.astrogrid.samp.gui
-
HubConnector implementation which provides facilities for keeping track of incoming and outgoing messages as well as the other GUI features.
- MessageTrackerHubConnector(ClientProfile) - Constructor for class org.astrogrid.samp.gui.MessageTrackerHubConnector
-
Constructs a hub connector with default message tracker GUI expiry times.
- MessageTrackerHubConnector(ClientProfile, int, int, int) - Constructor for class org.astrogrid.samp.gui.MessageTrackerHubConnector
-
Constructs a hub connector with specified message tracker GUI expiry times.
- MessageTrackerHubService - Class in org.astrogrid.samp.gui
-
GuiHubService subclass which additionally keeps track of which messages have been sent and received, and can provide a graphical display of these.
- MessageTrackerHubService(Random) - Constructor for class org.astrogrid.samp.gui.MessageTrackerHubService
-
Constructs a hub service with default message tracker GUI expiry times.
- MessageTrackerHubService(Random, int, int, int) - Constructor for class org.astrogrid.samp.gui.MessageTrackerHubService
-
Constructs a hub service with specified message tracker GUI expiry times.
- Metadata - Class in org.astrogrid.samp
-
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.
- MTYPE_KEY - Static variable in class org.astrogrid.samp.Message
-
Key for message MType.
- MultiURLMapperHandler - Class in org.astrogrid.samp.httpd
-
Handler implementation which allows the server to serve multiple separate resources which are available to it, but not necessarily to external clients, as URLs.
- MultiURLMapperHandler(HttpServer, String) - Constructor for class org.astrogrid.samp.httpd.MultiURLMapperHandler
-
Constructor.
N
- NAME_KEY - Static variable in class org.astrogrid.samp.Metadata
-
Key for application name.
- nameWord() - Method in interface org.astrogrid.samp.web.AuthResourceBundle.Content
-
Returns the word meaning "Name" (initial capitalised).
- next() - Method in class org.astrogrid.samp.hub.KeyGenerator
-
Returns the next key in the sequence.
- NO_GUI - Static variable in class org.astrogrid.samp.hub.HubServiceMode
-
Hub mode with no GUI representation of hub operations.
- NO_GUI - Static variable in class org.astrogrid.samp.xmlrpc.HubMode
-
Deprecated.Hub mode with no GUI representation of hub operations.
- noteIncomingUrl(URL) - Method in class org.astrogrid.samp.web.UrlTracker
-
Note that a URL has been communicated to a Web Profile client from the outside world.
- noteOutgoingUrl(URL) - Method in class org.astrogrid.samp.web.UrlTracker
-
Note that a Web Profile client has communicated a URL to the outside world.
- notify(String, Map) - Method in interface org.astrogrid.samp.client.HubConnection
-
Sends a message to a given client without wanting a response.
- notify(String, Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- notify(HubClient, String, Map) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
notify
method of connections registered with this service. - NOTIFY_MODE - Static variable in class org.astrogrid.samp.test.Calculator
-
Sends messages using the Notify delivery pattern.
- NotifyActionManager - Class in org.astrogrid.samp.gui
-
SendActionManager subclass which works with messages of a single MType, using the Notify delivery pattern.
- NotifyActionManager(Component, GuiHubConnector, String, String) - Constructor for class org.astrogrid.samp.gui.NotifyActionManager
-
Constructor.
- notifyAll(Map) - Method in interface org.astrogrid.samp.client.HubConnection
-
Sends a message to all subscribed clients without wanting a response.
- notifyAll(Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- notifyAll(HubClient, Map) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
notifyAll
method of connections registered with this service. - NOTRAY_PROP - Static variable in class org.astrogrid.samp.gui.SysTray
-
Name of system property ("jsamp.nosystray") to inhibit use of system tray; if set "true" the system tray will not be used even if it is apparently supported.
- noWord() - Method in interface org.astrogrid.samp.web.AuthResourceBundle.Content
-
Returns the word meaning "No" (initial capitalised).
O
- OK_STATUS - Static variable in class org.astrogrid.samp.Response
-
Response.STATUS_KEY
value indicating success. - OpenPolicyResourceHandler - Class in org.astrogrid.samp.web
-
HTTP resource handler suitable for serving static cross-origin policy files.
- OpenPolicyResourceHandler(String, ServerResource, OriginAuthorizer) - Constructor for class org.astrogrid.samp.web.OpenPolicyResourceHandler
-
Constructor.
- 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.bridge - package org.astrogrid.samp.bridge
-
Classes for the SAMP Bridge.
- 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.httpd - package org.astrogrid.samp.httpd
-
Standalone HTTP server.
- 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.util - package org.astrogrid.samp.util
- org.astrogrid.samp.web - package org.astrogrid.samp.web
-
Classes relating to the SAMP Web Profile.
- 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.
- ORIGIN_HDR - Static variable in class org.astrogrid.samp.web.WebCredentialPresenter
-
Origin header.
- OriginAuthorizer - Interface in org.astrogrid.samp.web
-
Controls which origins are authorized to perform cross-origin access to resources.
- OriginAuthorizers - Class in org.astrogrid.samp.web
-
Utility class containing OriginAuthorizer implementations.
- originWord() - Method in interface org.astrogrid.samp.web.AuthResourceBundle.Content
-
Returns the word meaning "Origin" (initial capitalised).
- ownsTag(String) - Method in interface org.astrogrid.samp.client.ResponseHandler
-
Indicates whether this handler will process the response with a given message tag.
P
- paintIcon(Component, Graphics, int, int) - Method in class org.astrogrid.samp.gui.TransmissionListIcon
- PARAMS_KEY - Static variable in class org.astrogrid.samp.Message
-
Key for map of parameters used by this message.
- parseProfileList(String) - Static method in class org.astrogrid.samp.hub.Hub
-
Parses a string representing a list of hub profiles.
- parseSampValue(Element) - Static method in class org.astrogrid.samp.xmlrpc.internal.XmlUtils
-
Returns the content of a DOM element representing a
value
element of an XML-RPC document. - parseValue(String) - Static method in class org.astrogrid.samp.SampUtils
-
Parses a command-line string as a SAMP object.
- permitSend(String, Map) - Method in interface org.astrogrid.samp.hub.MessageRestriction
-
Indicates whether a message covered by a given MType subscription may be sent.
- permitSend(String, Map) - Method in class org.astrogrid.samp.web.ListMessageRestriction
- 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
- Platform - Class in org.astrogrid.samp
-
Platform-dependent features required by the SAMP implementation.
- Platform(String) - Constructor for class org.astrogrid.samp.Platform
-
Constructor.
- PopupResultHandler - Class in org.astrogrid.samp.gui
-
ResultHandler which pops up a window displaying progress and success of a message sent to one or many recipients.
- PopupResultHandler(Component, String, Message, Client[], int) - Constructor for class org.astrogrid.samp.gui.PopupResultHandler
-
Constructor.
- PORT_PROP - Static variable in class org.astrogrid.samp.httpd.UtilServer
-
System Property key giving a preferred port number for the server.
- PREPARE_SEQUENCE - Static variable in class org.astrogrid.samp.ShutdownManager
-
Shutdown sequence for preparatory hooks.
- 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).
- privilegeWarningLines() - Method in interface org.astrogrid.samp.web.AuthResourceBundle.Content
-
Returns lines suitable explaining the privileges that a registered client will have.
- processCall(HubConnection, String, Message) - Method in class org.astrogrid.samp.client.AbstractMessageHandler
-
Implements message processing.
- ProfileToken - Interface in org.astrogrid.samp.hub
-
Marker interface that identifies a hub profile.
- publishLockfile() - Method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Returns an HTTP URL at which the lockfile for this hub can be found.
- publishLockfile() - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfile
-
Returns an HTTP URL at which the lockfile for this hub can be found.
- put(Object, Object) - Method in class org.astrogrid.samp.SampMap
Q
- questionLine() - Method in interface org.astrogrid.samp.web.AuthResourceBundle.Content
-
Returns a line asking whether to authorize (yes/no).
R
- RANDOM_MODE - Static variable in class org.astrogrid.samp.test.Calculator
-
Sends messages using a random choice of one of the other modes.
- rawExec(String, List) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
-
Actually makes an XML-RPC call to the SAMP hub represented by this connection.
- readContentResourceType(URL) - Static method in class org.astrogrid.samp.util.ResourceType
-
Attempts to determine the resource type of a given URL by downloading the first part of its content and examining the magic number.
- readHeadResourceType(URL) - Static method in class org.astrogrid.samp.util.ResourceType
-
Attempts to determine the resource type of a given URL by making an HTTP HEAD request and looking at the Content-Type.
- readLockFile(InputStream) - Static method in class org.astrogrid.samp.xmlrpc.LockInfo
-
Returns the LockInfo read from a given stream.
- readLockFile(URL) - Static method in class org.astrogrid.samp.xmlrpc.LockInfo
-
Returns a LockInfo as read from a lockfile at a given location.
- receiveCall(String, String, Message) - Method in interface org.astrogrid.samp.client.CallableClient
-
Receives a message for which a response is required.
- receiveCall(String, String, Message) - Method in class org.astrogrid.samp.test.Calculator
- 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)
, generates a response from the result usingAbstractMessageHandler.createResponse(java.util.Map)
, and sends the resulting response as a reply to the hub. - receiveCall(HubConnection, String, String, Message) - Method in interface org.astrogrid.samp.client.MessageHandler
-
Processes a message which does require a response.
- receiveNotification(String, Message) - Method in interface org.astrogrid.samp.client.CallableClient
-
Receives a message for which no response is required.
- receiveNotification(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(HubConnection, String, Message) - Method in interface org.astrogrid.samp.client.MessageHandler
-
Processes a message which does not require a response.
- receiveResponse(String, String, Response) - Method in interface org.astrogrid.samp.client.CallableClient
-
Receives a response to a message previously sent by this client.
- receiveResponse(String, String, Response) - Method in class org.astrogrid.samp.test.Calculator
- receiveResponse(HubConnection, String, String, Response) - Method in interface org.astrogrid.samp.client.ResponseHandler
-
Processes a response to an earlier message.
- REFERER_HDR - Static variable in class org.astrogrid.samp.web.WebCredentialPresenter
-
Referer header.
- refresh() - Method in class org.astrogrid.samp.gui.SelectiveClientListModel
-
Recalculates the inclusions.
- RegInfo - Class in org.astrogrid.samp
-
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.
- 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.web.WebClientProfile
- register() - Method in class org.astrogrid.samp.xmlrpc.StandardClientProfile
- register(ProfileToken) - Method in class org.astrogrid.samp.hub.BasicHubService
- register(ProfileToken) - Method in class org.astrogrid.samp.hub.FacadeHubService
- register(ProfileToken) - Method in interface org.astrogrid.samp.hub.HubService
-
Creates a new connection to this hub service, thereby initiating a new registered client.
- registerHandler(String, Client[], ResultHandler) - Method in class org.astrogrid.samp.gui.AbstractCallActionManager
-
Registers a result handler to handle results corresponding to a message tag.
- registerHook(Object, int, Runnable) - Method in class org.astrogrid.samp.ShutdownManager
-
Register a runnable to be run on shutdown with a given key and sequence.
- remove(HubClient) - Method in class org.astrogrid.samp.hub.BasicClientSet
- remove(HubClient) - Method in interface org.astrogrid.samp.hub.ClientSet
-
Removes a client from the set.
- removeChangeListener(ChangeListener) - Method in class org.astrogrid.samp.gui.Transmission
-
Removes a listener previously added by
Transmission.addChangeListener(javax.swing.event.ChangeListener)
. - removeClient(Client) - Method in class org.astrogrid.samp.client.TrackedClientSet
-
Removes a client from this model.
- removeConnectionListener(ChangeListener) - Method in class org.astrogrid.samp.gui.GuiHubConnector
-
Removes a listener previously added by
addConnectionListener
. - removeHandler(HttpServer.Handler) - Method in class org.astrogrid.samp.httpd.HttpServer
-
Removes a handler previously added by
HttpServer.addHandler(org.astrogrid.samp.httpd.HttpServer.Handler)
. - removeHandler(SampXmlRpcHandler) - Method in class org.astrogrid.samp.xmlrpc.apache.ApacheServer
- removeHandler(SampXmlRpcHandler) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalServer
- removeHandler(SampXmlRpcHandler) - Method in interface org.astrogrid.samp.xmlrpc.SampXmlRpcServer
-
Removes a previously-added handler.
- removeIcon(Object) - Method in class org.astrogrid.samp.gui.SysTray
-
Removes a previously-added icon from the tray.
- removeMessageHandler(MessageHandler) - Method in class org.astrogrid.samp.client.HubConnector
-
Removes a previously-added MessageHandler to this connector.
- removeResource(URL) - Method in class org.astrogrid.samp.httpd.ResourceHandler
-
Removes a resource from this server.
- removeResponseHandler(ResponseHandler) - Method in class org.astrogrid.samp.client.HubConnector
-
Removes a ResponseHandler from this connector.
- removeServerUrl(URL) - Method in class org.astrogrid.samp.httpd.MultiURLMapperHandler
-
Removes access to a resource which was publicised by a previous call to
MultiURLMapperHandler.addLocalUrl(java.net.URL)
. - reply(String, Map) - Method in interface org.astrogrid.samp.client.HubConnection
-
Supplies a response to a previously received message.
- reply(String, Map) - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- reply(HubClient, String, Map) - Method in class org.astrogrid.samp.gui.MessageTrackerHubService
- reply(HubClient, String, Map) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
reply
method of connections registered with this service. - Request(String, String, Map, SocketAddress, byte[]) - Constructor for class org.astrogrid.samp.httpd.HttpServer.Request
-
Constructor.
- ResourceHandler - Class in org.astrogrid.samp.httpd
-
Handler implementation which implements dynamic resource provision.
- ResourceHandler(HttpServer, String) - Constructor for class org.astrogrid.samp.httpd.ResourceHandler
-
Constructor.
- ResourceType - Class in org.astrogrid.samp.util
-
Defines one of the types of resource that can be turned into a SAMP load-type message.
- ResourceType(String, String, String[]) - Constructor for class org.astrogrid.samp.util.ResourceType
-
Constructor.
- Response - Class in org.astrogrid.samp
-
Represents an encoded SAMP response.
- Response() - Constructor for class org.astrogrid.samp.Response
-
Constructs an empty response.
- Response(int, String, Map) - Constructor for class org.astrogrid.samp.httpd.HttpServer.Response
-
Constructor.
- Response(String, Map, ErrInfo) - Constructor for class org.astrogrid.samp.Response
-
Constructs a response with given status, result and error.
- Response(Map) - Constructor for class org.astrogrid.samp.Response
-
Constructs a response based on an existing map.
- ResponseHandler - Interface in org.astrogrid.samp.client
-
Interface for a client which wishes to receive responses to message it has sent asynchrnonously using
call
orcallAll
. - result(Client, Response) - Method in class org.astrogrid.samp.client.LogResultHandler
- result(Client, Response) - Method in interface org.astrogrid.samp.client.ResultHandler
-
Called when a response is received from a client to which the message was sent.
- result(Client, Response) - Method in class org.astrogrid.samp.gui.PopupResultHandler
- RESULT_KEY - Static variable in class org.astrogrid.samp.Response
-
Key for result map.
- ResultHandler - Interface in org.astrogrid.samp.client
-
Interface which consumes call responses.
- RPC_LOGGING - Static variable in class org.astrogrid.samp.xmlrpc.XmlRpcKit
-
Internal implementation variant with verbose logging of RPC calls.
- RpcLoggingInternalClient - Class in org.astrogrid.samp.xmlrpc.internal
-
InternalClient subclass which additionally logs all XML-RPC calls/responses to an output stream.
- RpcLoggingInternalClient(URL, PrintStream) - Constructor for class org.astrogrid.samp.xmlrpc.internal.RpcLoggingInternalClient
-
Constructor.
- RpcLoggingInternalClientFactory - Class in org.astrogrid.samp.xmlrpc.internal
-
Freestanding ClientFactory implementation which logs all XML-RPC calls/responses to standard output.
- RpcLoggingInternalClientFactory() - Constructor for class org.astrogrid.samp.xmlrpc.internal.RpcLoggingInternalClientFactory
- RpcLoggingInternalServer - Class in org.astrogrid.samp.xmlrpc.internal
-
InternalServer subclass which additionally logs all XML-RPC calls/responses to an output stream.
- RpcLoggingInternalServer(PrintStream) - Constructor for class org.astrogrid.samp.xmlrpc.internal.RpcLoggingInternalServer
-
Constructs a server running with default characteristics on any free port.
- RpcLoggingInternalServer(HttpServer, String, PrintStream) - Constructor for class org.astrogrid.samp.xmlrpc.internal.RpcLoggingInternalServer
-
Constructor based on a given HTTP server.
- RpcLoggingInternalServerFactory - Class in org.astrogrid.samp.xmlrpc.internal
-
Freestanding ServerFactory implementation which logs all XML-RPC calls/responses to standard output.
- RpcLoggingInternalServerFactory() - Constructor for class org.astrogrid.samp.xmlrpc.internal.RpcLoggingInternalServerFactory
- RTYPE_CDF - Static variable in class org.astrogrid.samp.util.ResourceType
-
Resource type for table.load.cdf.
- RTYPE_FITS - Static variable in class org.astrogrid.samp.util.ResourceType
-
Resource type for image.load.fits.
- RTYPE_VOTABLE - Static variable in class org.astrogrid.samp.util.ResourceType
-
Resource type for table.load.votable.
- 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(HubServiceMode) - Static method in class org.astrogrid.samp.hub.Hub
-
Attempts to run a hub in a new JVM with a default set of profiles.
- runExternalHub(HubServiceMode, Class[], Class[]) - Static method in class org.astrogrid.samp.hub.Hub
-
Attempts to start a hub in a new JVM with a given set of profiles.
- runExternalHub(HubMode) - Static method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Static method which will attempt to start a hub running in an external JVM.
- runHub(HubServiceMode) - Static method in class org.astrogrid.samp.hub.Hub
-
Starts a SAMP hub with a default set of profiles.
- runHub(HubServiceMode, HubProfile[], HubProfile[]) - Static method in class org.astrogrid.samp.hub.Hub
-
Starts a SAMP hub with given sets of profiles.
- runHub(HubMode, XmlRpcKit) - Static method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Static method which may be used to start a SAMP hub programmatically.
- runHub(HubMode, XmlRpcKit, String, File) - Static method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Static method which may be used to start a SAMP hub programmatically, with a supplied samp.secret string.
- runMain(String[]) - Static method in class org.astrogrid.samp.bridge.Bridge
-
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.hub.Hub
-
Invoked by main.
- 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.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.util.SampLoad
-
Main invocation method.
- runMain(String[]) - Static method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Does the work for running the
HubRunner.main(java.lang.String[])
method.
S
- SAFE_MTYPE_PROP - Static variable in class org.astrogrid.samp.web.ListMessageRestriction
-
System property used to specify a default list of known safe MTypes, which the
ListMessageRestriction.DEFAULT
policy will permit. - SampException - Exception in org.astrogrid.samp.client
-
Exception thrown when some error occurs in SAMP processing.
- SampException() - Constructor for exception org.astrogrid.samp.client.SampException
-
Constructs an exception with no message.
- SampException(String) - Constructor for exception org.astrogrid.samp.client.SampException
-
Consructs an exception with a given message.
- SampException(String, Throwable) - Constructor for exception org.astrogrid.samp.client.SampException
-
Constructs an exception with a given message and cause.
- SampException(Throwable) - Constructor for exception org.astrogrid.samp.client.SampException
-
Constructs an exception with a given cause.
- SampLoad - Class in org.astrogrid.samp.util
-
Dialog window for sending a fixed load-type message to a selected client or clients.
- SampLoad(GuiHubConnector, ResourceType, URL, String) - Constructor for class org.astrogrid.samp.util.SampLoad
-
Constructor.
- SampMap - Class in org.astrogrid.samp
-
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 in org.astrogrid.samp
-
Contains static utility methods for use with the SAMP toolkit.
- SampXmlRpcClient - Interface in org.astrogrid.samp.xmlrpc
-
Interface for a client which can make XML-RPC calls for SAMP.
- SampXmlRpcClientFactory - Interface in org.astrogrid.samp.xmlrpc
-
Defines a factory which can create clients for communication with XML-RPC servers.
- SampXmlRpcHandler - Interface in org.astrogrid.samp.xmlrpc
-
Interface for an object which can process certain XML-RPC requests.
- SampXmlRpcServer - Interface in org.astrogrid.samp.xmlrpc
-
Interface for a server which can respond to XML-RPC calls for SAMP.
- SampXmlRpcServerFactory - Interface in org.astrogrid.samp.xmlrpc
-
Defines a factory for SampXmlRpcServer instances.
- scaleIcon(Icon, int, double, boolean) - Static method in class org.astrogrid.samp.gui.IconStore
-
Icon implementation which is rescaled to so that one dimension (either width or height) has a fixed value.
- SECRET_KEY - Static variable in class org.astrogrid.samp.xmlrpc.LockInfo
-
Key for opaque text string required by the hub for registration.
- SelectiveClientListModel - Class in org.astrogrid.samp.gui
-
ListModel implementation which sits on top of an existing ListModel containing
Client
s, but only includes a subset of its elements. - SelectiveClientListModel(ListModel) - Constructor for class org.astrogrid.samp.gui.SelectiveClientListModel
-
Constructor.
- SELFID_KEY - Static variable in class org.astrogrid.samp.RegInfo
-
Key for client public-id owned by the registering application.
- SendActionManager - Class in org.astrogrid.samp.gui
-
Manages actions to send SAMP messages to one or all recipients.
- SendActionManager(GuiHubConnector, ListModel) - Constructor for class org.astrogrid.samp.gui.SendActionManager
-
Constructor.
- 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.
- serializeCall(String, List) - Method in class org.astrogrid.samp.xmlrpc.internal.InternalClient
-
Generates the XML
methodCall
document corresponding to an XML-RPC method call. - serializeCall(String, List) - Method in class org.astrogrid.samp.xmlrpc.internal.RpcLoggingInternalClient
- serializeCall(String, List) - Method in class org.astrogrid.samp.xmlrpc.internal.XmlLoggingInternalClient
- serve(HttpServer.Request) - Method in class org.astrogrid.samp.httpd.HttpServer
-
Does the work for providing output corresponding to a given HTTP request.
- serve(HttpServer.Request) - Method in class org.astrogrid.samp.web.CorsHttpServer
- serve(HttpServer.Request) - Method in class org.astrogrid.samp.web.LoggingCorsHttpServer
- serveRequest(Socket) - Method in class org.astrogrid.samp.httpd.HttpServer
-
Called by the server thread for each new connection.
- serveRequest(HttpServer.Request) - Method in class org.astrogrid.samp.httpd.DirectoryMapperHandler
- serveRequest(HttpServer.Request) - Method in interface org.astrogrid.samp.httpd.HttpServer.Handler
-
Provides a response to an HTTP request.
- serveRequest(HttpServer.Request) - Method in class org.astrogrid.samp.httpd.MultiURLMapperHandler
- serveRequest(HttpServer.Request) - Method in class org.astrogrid.samp.httpd.ResourceHandler
- serveRequest(HttpServer.Request) - Method in class org.astrogrid.samp.httpd.URLMapperHandler
- serveRequest(HttpServer.Request) - Method in class org.astrogrid.samp.web.OpenPolicyResourceHandler
- ServerFactory() - Constructor for class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Constructs a ServerFactory with default properties.
- ServerResource - Interface in org.astrogrid.samp.httpd
-
Defines a resource suitable for serving by the
ResourceHandler
HTTP server handler. - setActive(boolean) - Method in class org.astrogrid.samp.client.HubConnector
-
Sets whether this connector is active or not.
- setAllowFlash(boolean) - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Sets whether Adobe Flash cross-domain workaround will be supported.
- setAllowSilverlight(boolean) - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Sets whether Microsoft Silverlight cross-domain workaround will be supported.
- 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.hub.HubClient
-
Sets the callable object which allows this client to receive callbacks.
- setCallable(HubClient, CallableClient) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
setCallable
method of connections registered with this service. - 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.
- setClients(Client[]) - Method in class org.astrogrid.samp.client.TrackedClientSet
-
Sets the contents of this model to a given list.
- 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.httpd.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. - setDefaultProfileClasses(Class[], boolean) - Static method in class org.astrogrid.samp.hub.Hub
-
Sets the default set of HubProfile classes.
- 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.
- setError(Throwable) - Method in class org.astrogrid.samp.gui.Transmission
-
Associates an error with this transmission.
- 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.
- setInstance(UtilServer) - Static method in class org.astrogrid.samp.httpd.UtilServer
-
Sets the default instance of this class.
- 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.
- setLogType(String) - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Sets the type of logging to use.
- setMetadata(Map) - Method in class org.astrogrid.samp.hub.HubClient
-
Sets this client's metadata map.
- 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.
- setMTypes(String[]) - Method in class org.astrogrid.samp.gui.SubscribedClientListModel
-
Sets the list of MTypes which defines the elements of this list.
- setName(String) - Method in class org.astrogrid.samp.Metadata
-
Sets the value for the application's name.
- setOriginAuthorizer(OriginAuthorizer) - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Sets the authorization policy for external origins.
- setParams(Map) - Method in class org.astrogrid.samp.Message
-
Sets this message's params map.
- setPort(int) - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Sets the port number the server will run on.
- 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.
- setProfile(ClientProfile) - Static method in class org.astrogrid.samp.client.DefaultClientProfile
-
Sets the profile object which will be returned by
DefaultClientProfile.getProfile()
. - setReceiverUnregistered() - Method in class org.astrogrid.samp.gui.Transmission
-
Indicates that the receiver of this transmission has unregistered.
- setResponse(Response) - Method in class org.astrogrid.samp.gui.Transmission
-
Sets the response for this transmission.
- setResult(Map) - Method in class org.astrogrid.samp.Response
-
Sets the result map.
- setSenderUnregistered() - Method in class org.astrogrid.samp.gui.Transmission
-
Indicates that the sender of this transmission has unregistered.
- 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(Map) - Method in class org.astrogrid.samp.hub.HubClient
-
Sets this client's subscriptions list.
- 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.
- setTransmission(Transmission) - Method in class org.astrogrid.samp.gui.TransmissionPanel
-
Sets the transmission object being displayed.
- setUsertxt(String) - Method in class org.astrogrid.samp.ErrInfo
-
Sets the value for the
ErrInfo.USERTXT_KEY
key. - setXmlrpcPath(String) - Method in class org.astrogrid.samp.web.WebHubProfile.ServerFactory
-
Sets the path on the HTTP server at which the XML-RPC server will reside.
- 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 class org.astrogrid.samp.hub.FacadeHubService
- shutdown() - Method in class org.astrogrid.samp.hub.Hub
-
Stops this hub and its profiles running.
- 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
-
Deprecated.Shuts down the hub and tidies up.
- ShutdownManager - Class in org.astrogrid.samp
-
Handles ordered running of cleanup processes at JVM shutdown.
- sizeIcon(Icon, int) - Static method in class org.astrogrid.samp.gui.IconStore
-
Return an icon based on an existing one, but drawn to an exact size.
- Snooper - Class in org.astrogrid.samp.test
-
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 using default metadata.
- Snooper(ClientProfile, Subscriptions, Metadata, OutputStream, int) - Constructor for class org.astrogrid.samp.test.Snooper
-
Constructor using custom metadata.
- StandardClientProfile - Class in org.astrogrid.samp.xmlrpc
-
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.
- StandardHubProfile - Class in org.astrogrid.samp.xmlrpc
-
HubProfile implementation for the SAMP Standard Profile.
- StandardHubProfile() - Constructor for class org.astrogrid.samp.xmlrpc.StandardHubProfile
-
Constructs a hub profile with default configuration.
- StandardHubProfile(SampXmlRpcClientFactory, SampXmlRpcServerFactory, File, String) - Constructor for class org.astrogrid.samp.xmlrpc.StandardHubProfile
-
Constructs a hub profile with given configuration information.
- StandardHubProfileFactory - Class in org.astrogrid.samp.xmlrpc
-
HubProfileFactory implementation for Standard Profile.
- StandardHubProfileFactory() - Constructor for class org.astrogrid.samp.xmlrpc.StandardHubProfileFactory
- start() - Method in class org.astrogrid.samp.bridge.Bridge
-
Starts this bridge running.
- start() - Method in class org.astrogrid.samp.gui.GuiHubService
- start() - Method in class org.astrogrid.samp.gui.MessageTrackerHubService
- start() - Method in class org.astrogrid.samp.httpd.HttpServer
-
Starts the server if it is not already started.
- start() - Method in class org.astrogrid.samp.hub.BasicHubService
- start() - Method in class org.astrogrid.samp.hub.FacadeHubService
-
No-op.
- start() - Method in interface org.astrogrid.samp.hub.HubService
-
Begin operation.
- start() - Method in class org.astrogrid.samp.xmlrpc.HubRunner
-
Deprecated.Starts the hub and writes the lockfile.
- start(ClientProfile) - Method in interface org.astrogrid.samp.hub.HubProfile
-
Starts this profile's activity allowing access to a given supplier of hub connections.
- start(ClientProfile) - Method in class org.astrogrid.samp.web.WebHubProfile
- start(ClientProfile) - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfile
- startProfile(HubProfile) - Method in class org.astrogrid.samp.hub.Hub
-
Starts a profile running on behalf of this hub.
- STATUS_KEY - Static variable in class org.astrogrid.samp.Response
-
Key for response status.
- STATUS_OK - Static variable in class org.astrogrid.samp.httpd.HttpServer
-
Status code for OK (200).
- STDPROFILE_HUB_PREFIX - Static variable in class org.astrogrid.samp.xmlrpc.StandardClientProfile
-
Prefix in SAMP_HUB value indicating lockfile URL ("std-lockurl:").
- stop() - Method in class org.astrogrid.samp.bridge.Bridge
-
Stops this bridge running.
- stop() - Method in class org.astrogrid.samp.httpd.HttpServer
-
Stops the server if it is currently running.
- stop() - Method in interface org.astrogrid.samp.hub.HubProfile
-
Ends this profile's activity on behalf of the hub.
- stop() - Method in class org.astrogrid.samp.web.WebHubProfile
- stop() - Method in class org.astrogrid.samp.xmlrpc.StandardHubProfile
- stopProfile(HubProfile) - Method in class org.astrogrid.samp.hub.Hub
-
Stops a profile running on behalf of this hub, and disconnects all clients registered with it.
- SubscribedClientListModel - Class in org.astrogrid.samp.gui
-
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(GuiHubConnector, String) - Constructor for class org.astrogrid.samp.gui.SubscribedClientListModel
-
Constructor for single MType.
- SubscribedClientListModel(GuiHubConnector, String[]) - Constructor for class org.astrogrid.samp.gui.SubscribedClientListModel
-
Constructor for multiple MTypes.
- Subscriptions - Class in org.astrogrid.samp
-
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.
- SWING - Static variable in class org.astrogrid.samp.web.OriginAuthorizers
-
OriginAuthorizer which queries the user via a popup dialogue.
- SYNCH_MODE - Static variable in class org.astrogrid.samp.test.Calculator
-
Sends messages using the Asynchronous Call/Response delivery pattern.
- SysTray - Class in org.astrogrid.samp.gui
-
Provides basic access to the windowing system's System Tray.
- SysTray() - Constructor for class org.astrogrid.samp.gui.SysTray
T
- Tester - Class in org.astrogrid.samp.test
-
No-frills test case superclass.
- Tester() - Constructor for class org.astrogrid.samp.test.Tester
- TestException - Exception in org.astrogrid.samp.test
-
Exception thrown by a failed test.
- TestException() - Constructor for exception org.astrogrid.samp.test.TestException
- TestException(String) - Constructor for exception org.astrogrid.samp.test.TestException
- TestException(String, Throwable) - Constructor for exception org.astrogrid.samp.test.TestException
- TestException(Throwable) - Constructor for exception org.astrogrid.samp.test.TestException
- toJson(Object, boolean) - Static method in class org.astrogrid.samp.SampUtils
-
Serializes a SAMP object to a JSON string.
- toString() - Method in class org.astrogrid.samp.gui.Transmission.Status
- toString() - Method in class org.astrogrid.samp.httpd.HttpServer.Request
- toString() - Method in class org.astrogrid.samp.hub.HubClient
- toString() - Method in class org.astrogrid.samp.hub.HubServiceMode
- toString() - Method in class org.astrogrid.samp.test.Calculator.SendMode
-
Returns the name of this mode.
- toString() - Method in class org.astrogrid.samp.util.ResourceType
- toString() - Method in class org.astrogrid.samp.web.ListMessageRestriction
- toString() - Method in class org.astrogrid.samp.xmlrpc.HubMode
-
Deprecated.
- toString(Client) - Static method in class org.astrogrid.samp.SampUtils
-
Returns a string representation of a client object.
- TrackedClientSet - Class in org.astrogrid.samp.client
-
Collection of Client objects which can be notified and interrogated about the clients which are currently registered.
- TrackedClientSet() - Constructor for class org.astrogrid.samp.client.TrackedClientSet
-
Constructor.
- Transmission - Class in org.astrogrid.samp.gui
-
Describes the properties of a message which has been sent from one client to another.
- Transmission(Client, Client, Message, String, String) - Constructor for class org.astrogrid.samp.gui.Transmission
-
Constructor.
- Transmission.Status - Class in org.astrogrid.samp.gui
-
Describes the status of a transmission in terms that can be presented in the GUI.
- TransmissionListIcon - Class in org.astrogrid.samp.gui
-
Icon which paints a graphical representation of a list of Transmissions.
- TransmissionListIcon(ListModel, ListModel, int) - Constructor for class org.astrogrid.samp.gui.TransmissionListIcon
-
Constructor.
- TransmissionPanel - Class in org.astrogrid.samp.gui
-
Component which displays the details of a given Transmission object.
- TransmissionPanel() - Constructor for class org.astrogrid.samp.gui.TransmissionPanel
-
Constructor.
- TRUE - Static variable in class org.astrogrid.samp.web.ClientAuthorizers
-
Authorizer which always permits access, with WARNING logging either way.
- TRUE - Static variable in class org.astrogrid.samp.web.OriginAuthorizers
-
OriginAuthorizer which always permits access.
U
- undeclaredWord() - Method in interface org.astrogrid.samp.web.AuthResourceBundle.Content
-
Returns the word meaning "undeclared" (not capitalised).
- UniformCallActionManager - Class in org.astrogrid.samp.gui
-
SendActionManager subclass which works with messages of a single MType, using the Aysnchronous Call/Response delivery pattern.
- UniformCallActionManager(Component, GuiHubConnector, String, String) - Constructor for class org.astrogrid.samp.gui.UniformCallActionManager
-
Constructor.
- unregister() - Method in interface org.astrogrid.samp.client.HubConnection
-
Unregisters the client and terminates this connection.
- unregister() - Method in class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- unregister(HubClient) - Method in class org.astrogrid.samp.hub.BasicHubService
-
Does the work for the
unregister
method of conections registered with this service. - unregisterHook(Object) - Method in class org.astrogrid.samp.ShutdownManager
-
Unregisters a key earlier registered using
ShutdownManager.registerHook(java.lang.Object, int, java.lang.Runnable)
. - updateClient(Client, boolean, boolean) - Method in class org.astrogrid.samp.client.TrackedClientSet
-
Notifies listeners that a given client's attributes (may) have changed.
- 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.
- uriDecode(String) - Static method in class org.astrogrid.samp.SampUtils
-
Reverses URI-style character escaping (%xy) on a string.
- uriEncode(String) - Static method in class org.astrogrid.samp.SampUtils
-
Performs URI-style character escaping (%xy) on a string.
- URLMapperHandler - Class in org.astrogrid.samp.httpd
-
Handler implementation which allows the server to serve resources which are available to it as URLs.
- URLMapperHandler(HttpServer, String, URL, boolean) - Constructor for class org.astrogrid.samp.httpd.URLMapperHandler
-
Constructor.
- urlToFile(URL) - Static method in class org.astrogrid.samp.SampUtils
-
Attempts to interpret a URL as a file.
- UrlTracker - Class in org.astrogrid.samp.web
-
Keeps track of which URLs have been seen in communications inbound to and outbound from Web Profile clients.
- UrlTracker() - Constructor for class org.astrogrid.samp.web.UrlTracker
-
Constructor.
- URLTRANS_KEY - Static variable in class org.astrogrid.samp.web.WebClientProfile
-
RegInfo map key for URL translation service base URL ("samp.url-translator").
- USERTXT_KEY - Static variable in class org.astrogrid.samp.ErrInfo
-
Key for free-form text given more information about the error.
- UtilServer - Class in org.astrogrid.samp.httpd
-
Utility class for use with HttpServer.
- UtilServer(HttpServer) - Constructor for class org.astrogrid.samp.httpd.UtilServer
-
Constructor.
V
- VERSION_KEY - Static variable in class org.astrogrid.samp.xmlrpc.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. - WebClientProfile - Class in org.astrogrid.samp.web
-
ClientProfile implementation for Web Profile.
- WebClientProfile() - Constructor for class org.astrogrid.samp.web.WebClientProfile
-
Constructor with no arguments.
- WebClientProfile(String) - Constructor for class org.astrogrid.samp.web.WebClientProfile
-
Constructor with declared client name.
- WebClientProfile(Map, SampXmlRpcClientFactory, URL) - Constructor for class org.astrogrid.samp.web.WebClientProfile
-
Constructor with configuration options.
- WebCredentialPresenter - Class in org.astrogrid.samp.web
-
CredentialPresenter for use with the Web Profile.
- WebHubProfile - Class in org.astrogrid.samp.web
-
HubProfile implementation for Web Profile.
- WebHubProfile() - Constructor for class org.astrogrid.samp.web.WebHubProfile
-
Constructs a profile with default configuration.
- WebHubProfile(WebHubProfile.ServerFactory, ClientAuthorizer, MessageRestriction, KeyGenerator, boolean) - Constructor for class org.astrogrid.samp.web.WebHubProfile
-
Constructs a profile with configuration options.
- WebHubProfile.ServerFactory - Class in org.astrogrid.samp.web
-
Creates and configures the HTTP server on which the Web Profile resides.
- WebHubProfileFactory - Class in org.astrogrid.samp.web
-
HubProfileFactory implementation for Web Profile.
- WebHubProfileFactory() - Constructor for class org.astrogrid.samp.web.WebHubProfileFactory
- WebHubXmlRpcHandler - Class in org.astrogrid.samp.web
-
SampXmlRpcHandler implementation which passes Web Profile-type XML-RPC calls to a hub connection factory to provide a Web Profile hub server.
- WebHubXmlRpcHandler(ClientProfile, ClientAuthorizer, KeyGenerator, URL, UrlTracker) - Constructor for class org.astrogrid.samp.web.WebHubXmlRpcHandler
-
Constructor.
- WEBPROFILE_HUB_PREFIX - Static variable in class org.astrogrid.samp.web.WebClientProfile
-
Prefix in SAMP_HUB value indicating web profile application name ("web-appname:").
- WEBSAMP_CLIENT_PREFIX - Static variable in class org.astrogrid.samp.web.WebClientProfile
-
Prefix to client interface opeation names for XML-RPC method names ("").
- WEBSAMP_HUB_PREFIX - Static variable in class org.astrogrid.samp.web.WebClientProfile
-
Prefix to hub interface operation names for XML-RPC method names ("samp.webhub.").
- WEBSAMP_PATH - Static variable in class org.astrogrid.samp.web.WebClientProfile
-
Path on WEBSAMP_PORT web server at which XML-RPC server lives ("/").
- WEBSAMP_PORT - Static variable in class org.astrogrid.samp.web.WebClientProfile
-
Web Profile hub port number (21012).
- windowTitle() - Method in interface org.astrogrid.samp.web.AuthResourceBundle.Content
-
Returns the title for the confirmation window.
- 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.httpd.HttpServer.Response
-
Implemented to generate the bytes in the body of the response.
- writeBody(OutputStream) - Method in interface org.astrogrid.samp.httpd.ServerResource
-
Writes resource body.
- 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.httpd.HttpServer.Response
-
Writes this response to an output stream in a way suitable for replying to the client.
X
- XML_LOGGING - Static variable in class org.astrogrid.samp.xmlrpc.XmlRpcKit
-
Internal implementation variant with verbose logging of XML I/O.
- XmlLoggingInternalClient - Class in org.astrogrid.samp.xmlrpc.internal
-
InternalClient subclass which additionally logs all XML-RPC calls/responses to an output stream.
- XmlLoggingInternalClient(URL, PrintStream) - Constructor for class org.astrogrid.samp.xmlrpc.internal.XmlLoggingInternalClient
-
Constructor.
- XmlLoggingInternalClientFactory - Class in org.astrogrid.samp.xmlrpc.internal
-
Freestanding ClientFactory implementation which logs all incoming and outgoing HTTP data.
- XmlLoggingInternalClientFactory() - Constructor for class org.astrogrid.samp.xmlrpc.internal.XmlLoggingInternalClientFactory
- XmlLoggingInternalServer - Class in org.astrogrid.samp.xmlrpc.internal
-
Freestanding InternalServer implementation which logs all incoming and outgoing HTTP data.
- XmlLoggingInternalServer(PrintStream) - Constructor for class org.astrogrid.samp.xmlrpc.internal.XmlLoggingInternalServer
-
Constructs a server running with default characteristics on any free port.
- XmlLoggingInternalServer(HttpServer, String, PrintStream) - Constructor for class org.astrogrid.samp.xmlrpc.internal.XmlLoggingInternalServer
-
Constructor based on a given HTTP server.
- XmlLoggingInternalServerFactory - Class in org.astrogrid.samp.xmlrpc.internal
-
Freestanding ServerFactory implementation which logs all incoming and outgoing HTTP data.
- XmlLoggingInternalServerFactory() - Constructor for class org.astrogrid.samp.xmlrpc.internal.XmlLoggingInternalServerFactory
- XmlRpcCall - Class in org.astrogrid.samp.xmlrpc.internal
-
Represents the content of an XML-RPC methodCall element.
- XmlRpcCall(String, List) - Constructor for class org.astrogrid.samp.xmlrpc.internal.XmlRpcCall
-
Constructor.
- XmlRpcHubConnection - Class in org.astrogrid.samp.xmlrpc
-
Partial HubConnection implementation based on XML-RPC.
- XmlRpcHubConnection(SampXmlRpcClient, String, List) - Constructor for class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
-
Constructor.
- XmlRpcKit - Class in org.astrogrid.samp.xmlrpc
-
Encapsulates the provision of XML-RPC client and server capabilities.
- XmlRpcKit() - Constructor for class org.astrogrid.samp.xmlrpc.XmlRpcKit
- XMLRPCURL_KEY - Static variable in class org.astrogrid.samp.xmlrpc.LockInfo
-
Key for XML-RPC endpoint for communication with the hub.
- XmlUtils - Class in org.astrogrid.samp.xmlrpc.internal
-
Utilities for XML manipulations required by SAMP/XML-RPC.
Y
- yesWord() - Method in interface org.astrogrid.samp.web.AuthResourceBundle.Content
-
Returns the word meaning "Yes" (initial capitalised).
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
UtilServer.exportResource(java.net.URL)