Interface ClientConnection

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

Direct known implementers

IbisClientConnection

Author: Dean Rasheed (dev-group@ucs.cam.ac.uk)
Located at client/ClientConnection.php

Methods summary

`public`	# `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. 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.
`public`	# `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. 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.
`public IbisResult`	# `invokeGetMethod(string $path, string[] $pathParams, array $queryParams)` Invoke a web service GET method. Invoke a web service GET method. The path should be the relative path to the method with standard Java/PHP 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. Returns `IbisResult` The result of invoking the method.
`public IbisResult`	# `invokeMethod(string $method, string $path, string[] $pathParams, array $queryParams, array $formParams)` Invoke a web service GET, POST, PUT or DELETE method. Invoke a web service GET, POST, PUT or DELETE method. The path should be the relative path to the method with standard Java/PHP 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. `$formParams` Any form parameters to submit. Returns `IbisResult` The result of invoking the method.