# Uses of Class
org.astrogrid.samp.client.SampException

Packages that use SampException
Package
Description
org.astrogrid.samp.client
Classes required only for SAMP clients.
org.astrogrid.samp.gui
Classes required only for graphical components based on SAMP classes.
org.astrogrid.samp.hub
Classes required only for running a SAMP hub.
org.astrogrid.samp.test
Classes for testing.
org.astrogrid.samp.web
Classes relating to the SAMP Web Profile.
org.astrogrid.samp.xmlrpc
Classes relating to Standard Profile and XML-RPC pluggable implementation layer.

## Uses of SampException in org.astrogrid.samp.client

Methods in org.astrogrid.samp.client that throw SampException
Modifier and Type
Method
Description
`String`
HubConnection.`call(String recipientId, String msgTag, Map msg)`
Sends a message to a given client expecting a response.
`void`
HubConnector.`call(String recipientId, Map msg, ResultHandler resultHandler, int timeout)`
Sends a message asynchronously to a single client, making a callback on a supplied ResultHandler object when the result arrives.
`Map`
HubConnection.`callAll(String msgTag, Map msg)`
Sends a message to all subscribed clients expecting responses.
`void`
HubConnector.`callAll(Map msg, ResultHandler resultHandler, int timeout)`
Sends a message asynchronously to all subscribed clients, making callbacks on a supplied ResultHandler object when the results arrive.
`Response`
HubConnection.`callAndWait(String recipientId, Map msg, int timeout)`
Sends a message synchronously to a client, waiting for the response.
`Response`
HubConnector.`callAndWait(String recipientId, Map msg, int timeout)`
Sends a message synchronously to a client, waiting for the response.
`void`
HubConnector.`configureConnection(HubConnection connection)`
Configures a connection with a hub in accordance with the state of this object.
`protected HubConnection`
HubConnector.`createConnection()`
Invoked by this class to create a hub connection.
`void`
HubConnection.`declareMetadata(Map meta)`
Declares this registered client's metadata.
`void`
HubConnection.`declareSubscriptions(Map subs)`
Declares this registered client's MType subscriptions.
`HubConnection`
HubConnector.`getConnection()`
If necessary attempts to acquire, and returns, a connection to a running hub.
`Metadata`
HubConnection.`getMetadata(String clientId)`
Returns the metadata for another registered client.
`String[]`
HubConnection.`getRegisteredClients()`
Returns the list of client public IDs for those clients currently registered.
`Map`
HubConnection.`getSubscribedClients(String mtype)`
Returns a map of subscriptions for a given MType.
`Subscriptions`
HubConnection.`getSubscriptions(String clientId)`
Returns the subscriptions for another registered client.
`void`
HubConnection.`notify(String recipientId, Map msg)`
Sends a message to a given client without wanting a response.
`List`
HubConnection.`notifyAll(Map msg)`
Sends a message to all subscribed clients without wanting a response.
`void`
HubConnection.`ping()`
Tests whether the connection is currently open.
`void`
AbstractMessageHandler.`receiveCall(HubConnection connection, String senderId, String msgId, Message message)`
Calls `AbstractMessageHandler.processCall(org.astrogrid.samp.client.HubConnection, java.lang.String, org.astrogrid.samp.Message)`, generates a response from the result using `AbstractMessageHandler.createResponse(java.util.Map)`, and sends the resulting response as a reply to the hub.
`HubConnection`
ClientProfile.`register()`
Attempts to register with a SAMP hub and return a corresponding connection object.
`void`
HubConnection.`reply(String msgId, Map response)`
Supplies a response to a previously received message.
`void`
HubConnection.`setCallable(CallableClient callable)`
Tells the hub how it can perform callbacks on the client by providing a CallableClient object.
`void`
HubConnection.`unregister()`
Unregisters the client and terminates this connection.

## Uses of SampException in org.astrogrid.samp.gui

Methods in org.astrogrid.samp.gui that throw SampException
Modifier and Type
Method
Description
`protected HubConnection`
MessageTrackerHubConnector.`createConnection()`
`protected void`
GuiHubService.`declareMetadata(HubClient caller, Map meta)`
`protected void`
GuiHubService.`declareSubscriptions(HubClient caller, Map subscriptions)`
`protected void`
MessageTrackerHubService.`reply(HubClient caller, String msgId, Map response)`

## Uses of SampException in org.astrogrid.samp.hub

Methods in org.astrogrid.samp.hub that throw SampException
Modifier and Type
Method
Description
`protected String`
BasicHubService.`call(HubClient caller, String recipientId, String msgTag, Map message)`
Does the work for the `call` method of connections registered with this service.
`protected Map`
BasicHubService.`callAll(HubClient caller, String msgTag, Map message)`
Does the work for the `call` method of connections registered with this service.
`protected Response`
BasicHubService.`callAndWait(HubClient caller, String recipientId, Map message, int timeout)`
Does the work for the `callAndWait` method of connections registered with this service.
`protected void`
BasicHubService.`declareMetadata(HubClient caller, Map meta)`
Does the work for the `declareMetadata` method of connections registered with this service.
`protected void`
BasicHubService.`declareSubscriptions(HubClient caller, Map subscriptions)`
Does the work for the `declareSubscriptions` method of connections registered with this service.
`protected Metadata`
BasicHubService.`getMetadata(HubClient caller, String clientId)`
Does the work for the `getMetadata` method of connections registered with this service.
`protected String[]`
BasicHubService.`getRegisteredClients(HubClient caller)`
Does the work for the `getRegisteredClients` method of connections registered with this service.
`protected Map`
BasicHubService.`getSubscribedClients(HubClient caller, String mtype)`
Does the work for the `getSubscribedClients` method of connections registered with this service.
`protected Subscriptions`
BasicHubService.`getSubscriptions(HubClient caller, String clientId)`
Does the work for the `getSubscriptions` method of connections registered with this service.
`protected void`
BasicHubService.`notify(HubClient caller, String recipientId, Map message)`
Does the work for the `notify` method of connections registered with this service.
`protected List`
BasicHubService.`notifyAll(HubClient caller, Map message)`
Does the work for the `notifyAll` method of connections registered with this service.
`HubConnection`
BasicHubService.`register(ProfileToken ptoken)`
`HubConnection`
FacadeHubService.`register(ProfileToken profileToken)`
`HubConnection`
HubService.`register(ProfileToken profileToken)`
Creates a new connection to this hub service, thereby initiating a new registered client.
`protected void`
BasicHubService.`reply(HubClient caller, String msgIdStr, Map resp)`
Does the work for the `reply` method of connections registered with this service.
`protected void`
BasicHubService.`setCallable(HubClient caller, CallableClient callable)`
Does the work for the `setCallable` method of connections registered with this service.
`protected void`
BasicHubService.`unregister(HubClient caller)`
Does the work for the `unregister` method of conections registered with this service.

## Uses of SampException in org.astrogrid.samp.test

Methods in org.astrogrid.samp.test that throw SampException
Modifier and Type
Method
Description
`void`
Calculator.`receiveCall(String senderId, String msgId, Message msg)`
`void`
Calculator.`sendMessage(String receiverId, Calculator.SendMode mode)`
Sends a randomly generated message in a randomly generated way to a given receiver.
Constructors in org.astrogrid.samp.test that throw SampException
Modifier
Constructor
Description
``
`Calculator(HubConnection connection, Random random)`
Constructor.

## Uses of SampException in org.astrogrid.samp.web

Methods in org.astrogrid.samp.web that throw SampException
Modifier and Type
Method
Description
`void`
ClientAuthorizer.`authorize(HttpServer.Request request, Map securityMap)`
Indicates whether an HTTP request representing an otherwise unauthorized connection attempt will be permitted access to sensitive system resources.
`void`
ExtremeSwingClientAuthorizer.`authorize(HttpServer.Request request, Map securityMap)`
`void`
HubSwingClientAuthorizer.`authorize(HttpServer.Request request, Map securityMap)`
`CredentialPresenter.Presentation`
CredentialPresenter.`createPresentation(HttpServer.Request request, Map securityMap, AuthResourceBundle.Content authContent)`
Returns an object which contains user-directed credential messages, given available information from the registration request.
`CredentialPresenter.Presentation`
WebCredentialPresenter.`createPresentation(HttpServer.Request request, Map securityMap, AuthResourceBundle.Content authContent)`
`static String`
ClientAuthorizers.`getAppName(Map securityMap)`
Returns the mandatory application name entry from the security map supplied explicitly by clients wishing to register.
`HubConnection`
WebClientProfile.`register()`

## Uses of SampException in org.astrogrid.samp.xmlrpc

Methods in org.astrogrid.samp.xmlrpc that throw SampException
Modifier and Type
Method
Description
`String`
XmlRpcHubConnection.`call(String recipientId, String msgTag, Map msg)`
`Map`
XmlRpcHubConnection.`callAll(String msgTag, Map msg)`
`Response`
XmlRpcHubConnection.`callAndWait(String recipientId, Map msg, int timeout)`
`void`
XmlRpcHubConnection.`declareMetadata(Map meta)`
`void`
XmlRpcHubConnection.`declareSubscriptions(Map subs)`
`Object`
XmlRpcHubConnection.`exec(String methodName, Object[] params)`
Makes an XML-RPC call to the SAMP hub represented by this connection.
`Metadata`
XmlRpcHubConnection.`getMetadata(String clientId)`
`String[]`
XmlRpcHubConnection.`getRegisteredClients()`
`Map`
XmlRpcHubConnection.`getSubscribedClients(String mtype)`
`Subscriptions`
XmlRpcHubConnection.`getSubscriptions(String clientId)`
`void`
XmlRpcHubConnection.`notify(String recipientId, Map msg)`
`List`
XmlRpcHubConnection.`notifyAll(Map msg)`
`void`
XmlRpcHubConnection.`ping()`
`Object`
XmlRpcHubConnection.`rawExec(String fqName, List paramList)`
Actually makes an XML-RPC call to the SAMP hub represented by this connection.
`HubConnection`
StandardClientProfile.`register()`
`void`
XmlRpcHubConnection.`reply(String msgId, Map response)`
`void`
XmlRpcHubConnection.`unregister()`
Constructors in org.astrogrid.samp.xmlrpc that throw SampException
Modifier
Constructor
Description
``
`XmlRpcHubConnection(SampXmlRpcClient xClient, String prefix, List registerArgs)`
Constructor.