org.phenotips.data.push

Interface PushServerConfigurationResponse

All Superinterfaces:

PushServerResponse

@Unstable
@Role
public interface PushServerConfigurationResponse
extends PushServerResponse

API that allows pushing patient data to a remote PhenoTips instance.

Since:

1.0M11

Version:

$Id: 6d9a5249acaf33c88432a754f2fcefc8a41bcbdf $

Method Summary

Methods

Modifier and Type	Method and Description
org.json.JSONArray	getConsents() Get the list of consents available on the remote server.
Set<String>	getPushableFields()
Set<String>	getPushableFields(String groupName) Get the intersection of locally available non-personally identifiable fields and fields accepted by the remote server. The list may or may not be different depending on the remote group.
Set<String>	getRemoteAcceptedPatientFields()
Set<String>	getRemoteAcceptedPatientFields(String groupName) Get the list of patient data fields accepted by the remote server.
Set<String>	getRemoteUserGroups() Get the list of remote PhenoTips group names the given remote user is a member of.
String	getRemoteUserToken() Get the user_token for future passwordless patient data pushes to the same server by the same remote user.
boolean	remoteUpdatesEnabled() Indicates whether remote server allows updates of existing patients.

Methods inherited from interface org.phenotips.data.push.PushServerResponse

isActionFailed_isUnknownAction, isActionFailed_knownReason, isActionFailed, isClientDoesNotAcceptServerProtocolVersion, isLoginFailed_IncorrectCredentials, isLoginFailed_knownReason, isLoginFailed_TokensNotSuported, isLoginFailed_UnauthorizedServer, isLoginFailed_UserTokenExpired, isLoginFailed, isServerDoesNotAcceptClientProtocolVersion, isSuccessful

Method Detail

getRemoteUserGroups

Set<String> getRemoteUserGroups()

Get the list of remote PhenoTips group names the given remote user is a member of.

Returns:

Null if login attempt was not successful, otherwise a list of remote PhenoTips group names the given remote user is a member of on the remote server. The set may be empty if the user is not a member of any PhenoTips groups.

getRemoteAcceptedPatientFields

Set<String> getRemoteAcceptedPatientFields(String groupName)

Get the list of patient data fields accepted by the remote server. The list may or may not be different depending on the remote group. All other fields will be discarded by the remote server.

Parameters:

groupName - remote group name (optional, may be null).

Returns:

List of remote field names accepted by the remote server.

getRemoteAcceptedPatientFields

Set<String> getRemoteAcceptedPatientFields()

getPushableFields

Set<String> getPushableFields(String groupName)

Get the intersection of locally available non-personally identifiable fields and fields accepted by the remote server.
The list may or may not be different depending on the remote group.

Parameters:

groupName - remote group name (optional, may be null).

Returns:

List of patient data fields which are 1) accepted by the remote server 2) locally available and 3) considered non-personally identifiable by the local server.

getPushableFields

Set<String> getPushableFields()

remoteUpdatesEnabled

boolean remoteUpdatesEnabled()

Indicates whether remote server allows updates of existing patients. When false, only pushes of new patients are allowed.

Note that even when updates are enabled, remote user used for pushing should have enough permissions to modify the patient. Updates are also only allowed when a valid GUID is provided, supposedly obtained as a result of an earlier push request.

Returns:

true if remote server allows

getRemoteUserToken

String getRemoteUserToken()

Get the user_token for future passwordless patient data pushes to the same server by the same remote user. This feature may be disabled on the remote server, in which case null is returned.

Returns:

User token (if provided by the remote server) or null.

getConsents

org.json.JSONArray getConsents()

Get the list of consents available on the remote server.

Returns:

The list of consents configured on the remote server.