org.phenotips.data.push

Interface PushPatientService

@Unstable
@Role
public interface PushPatientService

A wrapper around PushPatientData which deals with saving and retrieval of remote user names and tokens and provides methods for reading the list of push targets.

Note: unlike PushPatientData this service checks that the currently logged in user has permissions to push the patient or view the patient representation in JSON.

Since:

1.0M11

Version:

$Id: 45df14779325b2f08d896c35d71949dd9a5184d2 $

Method Summary

Methods

Modifier and Type	Method and Description
Set<PushServerInfo>	getAvailablePushTargets()
org.json.JSONObject	getLocalPatientJSON(String patientID, String exportFieldListJSON) Returns the (specified subset of) patient data in JSON format.
PatientPushHistory	getPatientPushHistory(String localPatientID, String remoteServerIdentifier)
PushServerGetPatientIDResponse	getPatientURL(String remoteServerIdentifier, String remotePatientGUID)
PushServerGetPatientIDResponse	getPatientURL(String remoteServerIdentifier, String remotePatientGUID, String remoteUserName, String password)
Map<PushServerInfo,PatientPushHistory>	getPushTargetsWithHistory(String localPatientID)
PushServerConfigurationResponse	getRemoteConfiguration(String remoteServerIdentifier) Same as above, but uses the previously stored remote user name and login token to authenticate on the remote server.
PushServerConfigurationResponse	getRemoteConfiguration(String remoteServerIdentifier, String remoteUserName, String password, boolean saveUserToken) Retrieves the list of patient fields accepted by the remote server as well as the list of groups the given remote user is a member of on the remote server.
String	getRemoteUsername(String remoteServerIdentifier) Get the previously stored remote username associated with the current user and the given remote server
void	removeStoredLoginTokens(String remoteServerIdentifier) Removes stored remote login token, if any - for security purposes
PushServerSendPatientResponse	sendPatient(String patientID, String exportFieldListJSON, String patientState, String groupName, String remoteGUID, String remoteServerIdentifier) Same as above, but uses the previously stored remote user name and login token to authenticate on the remote server.
PushServerSendPatientResponse	sendPatient(String patientID, String exportFieldListJSON, String patientState, String groupName, String remoteGUID, String remoteServerIdentifier, String remoteUserName, String password) Submits the specified subset of patient data to the specified remote server.

Method Detail

getAvailablePushTargets

Set<PushServerInfo> getAvailablePushTargets()

Returns:

The list of configured phenotips servers which can be used as patient push targets.

getPushTargetsWithHistory

Map<PushServerInfo,PatientPushHistory> getPushTargetsWithHistory(String localPatientID)

Returns:

For each configured phenotips server which can be used as patient push target information about the last push of the same patient to the server.

getPatientPushHistory

PatientPushHistory getPatientPushHistory(String localPatientID,
                                       String remoteServerIdentifier)

Returns:

Data about the last push attempt of the given local patient to the given remote server; that includes remote GUID and ID, if the push was successful, and the time of the last push. Null otherwise.

getLocalPatientJSON

org.json.JSONObject getLocalPatientJSON(String patientID,
                                      String exportFieldListJSON)

Returns the (specified subset of) patient data in JSON format. When exportFieldListJSON is null all available data is returned.

Parameters:

patientID - PhenoTips Patient ID

exportFieldListJSON - a string in the JSON array format with the list of fields which should be included in the output. When not null only patient data fields listed will be serialized.

Returns:

getRemoteUsername

String getRemoteUsername(String remoteServerIdentifier)

Get the previously stored remote username associated with the current user and the given remote server

Returns:

Remote user name, or null if none is stored

getRemoteConfiguration

PushServerConfigurationResponse getRemoteConfiguration(String remoteServerIdentifier,
                                                     String remoteUserName,
                                                     String password,
                                                     boolean saveUserToken)

Retrieves the list of patient fields accepted by the remote server as well as the list of groups the given remote user is a member of on the remote server.

Parameters:

remoteServerIdentifier - server name as configured in TODO

remoteUserName - user name on the remote server

password - user password on the remote server

saveUserToken - save userLoignToken received from the remote server or not. The user may not wish to compromise his account on the remote server if someone gets access to the account on the local server

Returns:

server response which, upon successful login, contains the list of remote phenotips groups the user is a part of as well as the list of accepted patient fields.

Returns null if no response was received from the server (e.g. a wrong server IP, a network problem, etc.)

getRemoteConfiguration

PushServerConfigurationResponse getRemoteConfiguration(String remoteServerIdentifier)

Same as above, but uses the previously stored remote user name and login token to authenticate on the remote server. The retrieved user name and token are based on the current local user and the remote server.

Returns:

If there is no user or token stored for the given remote server and the current local user, returns a PushServerConfigurationResponse equivalent to the "incorrect password" response. Otherwise see the docs for the other version.

removeStoredLoginTokens

void removeStoredLoginTokens(String remoteServerIdentifier)

Removes stored remote login token, if any - for security purposes

Parameters:

remoteServerIdentifier -

sendPatient

PushServerSendPatientResponse sendPatient(String patientID,
                                        String exportFieldListJSON,
                                        String patientState,
                                        String groupName,
                                        String remoteGUID,
                                        String remoteServerIdentifier,
                                        String remoteUserName,
                                        String password)

Submits the specified subset of patient data to the specified remote server. The new patient created on the remote server will be created and authored by the given user, and owned by the given group (if provided) or the user otherwise.

A new remote patient will be created with each submission, unless remoteGUID is provided, and a patient with the given GUID exists on the remote server and owned by the given group and is authored by the given user - in which case remote patient will be updated (only the submitted fields)

Parameters:

patientID - local patient to be pushed to the remove server

exportFieldListJSON - patient fields to be pushed, as a string representing a JSON array. When not null only patient data fields listed will be pushed. When null, all available data fields will be pushed.

patientState - a JSON encoded as a String, containing (meta) information about the state of the patient's record.

groupName - group name (optional, can be null)

remoteGUID - if a remote patient with the same GUID exists and is owned by the given group and is authored by the given user patient data will be updated instead of creating a new patient (optional, can be null)

remoteServerIdentifier - server name as configured in TODO

remoteUserName - user name on the remote server

password - user password on the remote server. Ignored if user_token is not null.

Returns:

Server response, see PushServerSendPatientResponse.

Returns null if no response was received from the server (e.g. a wrong server IP, a network problem, etc.)

sendPatient

PushServerSendPatientResponse sendPatient(String patientID,
                                        String exportFieldListJSON,
                                        String patientState,
                                        String groupName,
                                        String remoteGUID,
                                        String remoteServerIdentifier)

Same as above, but uses the previously stored remote user name and login token to authenticate on the remote server. The retrieved user name and token are based on the current local user and the remote server.

Returns:

If there is no user or token stored for the given remote server and the current local user, returns a PushServerSendPatientResponse equivalent to the "incorrect password" response. Otherwise see the docs for the other version.

getPatientURL

PushServerGetPatientIDResponse getPatientURL(String remoteServerIdentifier,
                                           String remotePatientGUID)

Parameters:

remoteServerIdentifier -

remotePatientGUID -

Returns:

getPatientURL

PushServerGetPatientIDResponse getPatientURL(String remoteServerIdentifier,
                                           String remotePatientGUID,
                                           String remoteUserName,
                                           String password)