org.phenotips.data.push

Interface PushServerResponse

All Known Subinterfaces:

PushServerConfigurationResponse, PushServerGetPatientIDResponse, PushServerSendPatientResponse

@Unstable
@Role
public interface PushServerResponse

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

Since:

1.0M11

Version:

$Id: da669b8bfb6e6e583a733977ddb37651a1b7fe59 $

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isActionFailed_isUnknownAction()
boolean	isActionFailed_knownReason()
boolean	isActionFailed()
boolean	isClientDoesNotAcceptServerProtocolVersion()
boolean	isLoginFailed_IncorrectCredentials()
boolean	isLoginFailed_knownReason()
boolean	isLoginFailed_TokensNotSuported()
boolean	isLoginFailed_UnauthorizedServer()
boolean	isLoginFailed_UserTokenExpired()
boolean	isLoginFailed()
boolean	isServerDoesNotAcceptClientProtocolVersion()
boolean	isSuccessful() Returns the status of the requested action.

Method Detail

isSuccessful

boolean isSuccessful()

Returns the status of the requested action.

Returns:

true iff all of the following was true:

1. pushes from this server are accepted by the remote server, and the server token is valid
2. credentials provided for the given remote user were accepted by the remote server
3. the operation requested was successfully performed

false in all other cases, in which case one and only one of isLoginFailed(), isActionFailed() or isServerDoesNotAcceptClientProtocolVersion() or isClientDoesNotAcceptServerProtocolVersion will return true.

isLoginFailed

boolean isLoginFailed()

Returns:

true for any problems related to authenticating the user on the remote server. E.g. server token may be incorrect, or the password may be wrong, etc.

isActionFailed

boolean isActionFailed()

Returns:

true for any problems executing the action requested after the user was successfully authenticated.

isServerDoesNotAcceptClientProtocolVersion

boolean isServerDoesNotAcceptClientProtocolVersion()

Returns:

true if the version of the POST protocol used is not supported by the server (the assumption is that client protocol version is outdated, since by default any client version newer than the server is supported)

isClientDoesNotAcceptServerProtocolVersion

boolean isClientDoesNotAcceptServerProtocolVersion()

Returns:

true if the version of the POST protocol used by the server is not supported by the client (the assumption is that server protocol version is outdated, since by default any server version newer than the client is supported)

isLoginFailed_knownReason

boolean isLoginFailed_knownReason()

Returns:

true iff the failure reason is known.
false may indicate an unknown problem on the server side.

isLoginFailed_UnauthorizedServer

boolean isLoginFailed_UnauthorizedServer()

Returns:

true iff remote server does not allow pushes from this server.

isLoginFailed_IncorrectCredentials

boolean isLoginFailed_IncorrectCredentials()

Returns:

true iff the user name was a not a valid user on the remote server, or either the password or the token were not correct for the user provided.

isLoginFailed_UserTokenExpired

boolean isLoginFailed_UserTokenExpired()

Returns:

true iff the user token provided is expired.
May only be true if user token was supplied in the POST request.

isLoginFailed_TokensNotSuported

boolean isLoginFailed_TokensNotSuported()

Returns:

true iff the user token are not accepted by the remote server (possibly after a config change).
May only be true if user token was supplied in the POST request.

isActionFailed_knownReason

boolean isActionFailed_knownReason()

Returns:

true iff the failure reason is known.
false may indicate an unknown problem on the server side.

isActionFailed_isUnknownAction

boolean isActionFailed_isUnknownAction()

Returns:

true iff the action requested is not supported by the server