uk.ac.cam.ucs.ibis.client

Interface ClientConnection

All Known Implementing Classes:

IbisClientConnection

public interface ClientConnection

Interface representing a connection to the Lookup/Ibis server, capable of invoking methods on the web service API and unmarshalling the results.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClientConnection.Method Enumeration of supported HTTP methods.

Method Summary

Modifier and Type	Method and Description
IbisResult	invokeMethod(ClientConnection.Method method, String path, String[] pathParams, Object[] queryParams, Object[] formParams) Invoke a web service GET, POST, PUT or DELETE method.
IbisResult	invokeMethod(String path, String[] pathParams, Object[] queryParams) Invoke a web service GET method.
void	setPassword(String password) Set the password to use when connecting to the Lookup/Ibis web service.
void	setUsername(String username) Set the username to use when connecting to the Lookup/Ibis web service.

Method Detail

setUsername

void setUsername(String username)

Set the username to use when connecting to the Lookup/Ibis web service. By default connections are anonymous, which gives read-only access. This method enables authentication as a group, using the group's password, which gives read/write access and also access to certain non-public data, based on the group's privileges.

This method may be called at any time, and affects all subsequent access using this connection, but should not affect any other ClientConnection objects.

Parameters:

username - The username to connect as. This should either be "anonymous" (the default) or the name of a group.

setPassword

void setPassword(String password)

Set the password to use when connecting to the Lookup/Ibis web service. This is only necessary when connecting as a group, in which case it should be that group's password.

Parameters:

password - The group password.

invokeMethod

IbisResult invokeMethod(String   path,
                        String[] pathParams,
                        Object[] queryParams)
    throws IOException,
           JAXBException

Invoke a web service GET method.

The path should be the relative path to the method with standard Java format specifiers for any path parameters, for example "api/v1/person/%1$s/%2$s". Any path parameters specified are then substituted into the path according to the standard Java formatting rules.

Parameters:

path - The path to the method to invoke.

pathParams - Any path parameters that should be inserted into the path in place of any format specifiers.

queryParams - Any query parameters to add as part of the URL's query string. These are expected to come in pairs {name1, value1, name2, value2, ...}.

Returns:

The result of invoking the method.

Throws:

IOException

JAXBException

invokeMethod

IbisResult invokeMethod(ClientConnection.Method method,
                        String                  path,
                        String[]                pathParams,
                        Object[]                queryParams,
                        Object[]                formParams)
    throws IOException,
           JAXBException

Invoke a web service GET, POST, PUT or DELETE method.

The path should be the relative path to the method with standard Java format specifiers for any path parameters, for example "api/v1/person/%1$s/%2$s". Any path parameters specified are then substituted into the path according to the standard Java formatting rules.

Parameters:

method - The method type (GET, POST, PUT or DELETE).

path - The path to the method to invoke.

pathParams - Any path parameters that should be inserted into the path in place of any format specifiers.

queryParams - Any query parameters to add as part of the URL's query string. These are expected to come in pairs {name1, value1, name2, value2, ...}.

formParams - Any form parameters to submit. These are expected to come in pairs {name1, value1, name2, value2, ...}.

Returns:

The result of invoking the method.

Throws:

IOException

JAXBException