sapphire.servlet

Class ExternalHandlerProcessor

java.lang.Object

sapphire.servlet.ExternalHandlerProcessor

All Implemented Interfaces:

com.labvantage.sapphire.servlet.externalapp.ExternalAppConstants, com.labvantage.sapphire.servlet.rest.RestConstants

public class ExternalHandlerProcessor
extends java.lang.Object
implements com.labvantage.sapphire.servlet.externalapp.ExternalAppConstants

Field Summary

Fields inherited from interface com.labvantage.sapphire.servlet.externalapp.ExternalAppConstants

COMMAND_CHECKCONNECTION, COMMAND_CLEARCONNECTION, COMMAND_GETCONNECTIONID, COMMAND_ISTOKENACTIVE, COMMAND_REQUESTTOKEN, COMMANDRESPONSE_EXCEPTION, CONNECTION_DEVICEID, ERROR_EXTERNALAPP_DISABLED, ERROR_EXTERNALAPP_NOTFOUND, ERROR_INVALID_HANDLER, ERROR_PROCESSAS_INVALID, ERROR_TOKEN_EXPIRED, ERROR_UNRECOGNIZED_TOKEN, EXTERNALAPP_STATUS_ACTIVE, EXTERNALAPP_STATUS_DISABLED, PROCESSAS_ANY, PROCESSAS_DEPARTMENT, PROCESSAS_NEVER, PROCESSAS_ROLE, PROCESSAS_USER

Fields inherited from interface com.labvantage.sapphire.servlet.rest.RestConstants

ERROR_CONNECTION_INVALID, ERROR_CONNECTION_REFUSED, ERROR_INVALID_REQUEST_METHOD, ERROR_MALFORMED_REQUEST_BODY, ERROR_MALFORMED_REQUEST_URL, ERROR_RESOURCE_NOT_AVAILABLE, ERROR_RESOURCE_NOT_FOUND, ERROR_UNEXPECTED_SERVER_ERROR, HTTPCODE_BAD_REQUEST, HTTPCODE_CONFLICT, HTTPCODE_CREATED, HTTPCODE_FORBIDDEN, HTTPCODE_METHOD_NOT_ALLOWED, HTTPCODE_NO_CONTENT, HTTPCODE_NOT_FOUND, HTTPCODE_NOT_MODIFIED, HTTPCODE_OK, HTTPCODE_SERVER_ERROR, HTTPCODE_UNAUTHORIZED, HTTPHEADER_LOCATION, HTTPSTATUS_BAD_REQUEST, HTTPSTATUS_CONFLICT, HTTPSTATUS_CREATED, HTTPSTATUS_FORBIDDEN, HTTPSTATUS_METHOD_NOT_ALLOWED, HTTPSTATUS_NO_CONTENT, HTTPSTATUS_NOT_FOUND, HTTPSTATUS_NOT_MODIFIED, HTTPSTATUS_OK, HTTPSTATUS_SERVER_ERROR, HTTPSTATUS_UNAUTHORIZED, MESSAGE, METHOD_DELETE, METHOD_GET, METHOD_POST, METHOD_PUT, NAMESPACE_ACTIONS, NAMESPACE_API, NAMESPACE_CONNECTIONS, NAMESPACE_LABVANTAGE, NAMESPACE_SDC

Constructor Summary

Constructors

Constructor and Description
ExternalHandlerProcessor(java.lang.String token, java.lang.String sapphireControllerURL)

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkConnection(java.lang.String connectionid)
void	clearConnection(java.lang.String connectionid)
java.lang.String	getConnectionId(java.lang.String username, java.lang.String password, java.lang.String database)
java.net.HttpURLConnection	getHttpURLConnection(java.lang.String processAs) Internal.
org.json.JSONObject	getJsonObject(java.net.HttpURLConnection conn, org.json.JSONObject jsonResponse) Internal.
java.lang.String	getToken()
boolean	isTokenActive() Internal.
java.lang.String	requestToken(java.lang.String authorizationcode, java.lang.String requestReason) Internal.
java.lang.String	requestToken(java.lang.String authorizationCode, java.lang.String requestReason, java.lang.String externalUserid) Internal.
org.json.JSONObject	sendCommandToLIMS(java.lang.String command, org.json.JSONObject jsonRequest) Use this to send a JSON command to LIMS.
PropertyList	sendCommandToLIMS(java.lang.String command, PropertyList commandRequest) Use this to send a PropertyList command to LIMS.
org.json.JSONObject	sendCommandToLIMS(java.lang.String processAs, java.lang.String command, org.json.JSONObject jsonRequest) Use this to send a JSON command to LIMS.
PropertyList	sendCommandToLIMS(java.lang.String processas, java.lang.String command, PropertyList commandRequest) Use this to send a PropertyList command to LIMS.
void	sendDownloadFileCommandToLIMS(java.lang.String command, org.json.JSONObject commandRequest, java.nio.file.Path targetFile)
void	sendDownloadFileCommandToLIMS(java.lang.String processAs, java.lang.String command, org.json.JSONObject jsonRequest, java.nio.file.Path targetFile)
org.json.JSONObject	sendFileCommandToLIMS(java.lang.String command, java.nio.file.Path file, org.json.JSONObject jsonRequest) Use this to send a JSON command to LIMS with an accompanying file.
org.json.JSONObject	sendFileCommandToLIMS(java.lang.String processAs, java.lang.String command, java.nio.file.Path file, org.json.JSONObject jsonRequest) Use this to send a JSON command to LIMS with an accompanying file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalHandlerProcessor

public ExternalHandlerProcessor(java.lang.String token,
                                java.lang.String sapphireControllerURL)

Method Detail

sendCommandToLIMS

public org.json.JSONObject sendCommandToLIMS(java.lang.String command,
                                             org.json.JSONObject jsonRequest)
                                      throws SapphireException

Use this to send a JSON command to LIMS. Returns a JSON object.

Parameters:

command - the name of the command

jsonRequest - the properties to send to the command

Throws:

SapphireException

sendCommandToLIMS

public org.json.JSONObject sendCommandToLIMS(java.lang.String processAs,
                                             java.lang.String command,
                                             org.json.JSONObject jsonRequest)
                                      throws SapphireException

Use this to send a JSON command to LIMS. Returns a JSON object.

Parameters:

processAs - the name of the user to process these commands as. Requires the external app to permit this operation

command - the name of the command

jsonRequest - the properties to send to the command

Throws:

SapphireException

sendFileCommandToLIMS

public org.json.JSONObject sendFileCommandToLIMS(java.lang.String command,
                                                 java.nio.file.Path file,
                                                 org.json.JSONObject jsonRequest)
                                          throws SapphireException

Use this to send a JSON command to LIMS with an accompanying file. Returns a JSON object.

Parameters:

command - the name of the command

file - the file to accompany the command

jsonRequest - the properties to send to the command

Throws:

SapphireException

sendFileCommandToLIMS

public org.json.JSONObject sendFileCommandToLIMS(java.lang.String processAs,
                                                 java.lang.String command,
                                                 java.nio.file.Path file,
                                                 org.json.JSONObject jsonRequest)
                                          throws SapphireException

Use this to send a JSON command to LIMS with an accompanying file. Returns a JSON object.

Parameters:

processAs - the name of the user to process these commands as. Requires the external app to permit this operation

command - the name of the command

file - the file to accompany the command

jsonRequest - the properties to send to the command

Throws:

SapphireException

getJsonObject

public org.json.JSONObject getJsonObject(java.net.HttpURLConnection conn,
                                         org.json.JSONObject jsonResponse)
                                  throws java.io.IOException,
                                         SapphireException

Internal. Do not use.

Throws:

java.io.IOException

SapphireException

getHttpURLConnection

public java.net.HttpURLConnection getHttpURLConnection(java.lang.String processAs)
                                                throws java.io.IOException

Internal. Do not use.

Throws:

java.io.IOException

getToken

public java.lang.String getToken()

requestToken

public java.lang.String requestToken(java.lang.String authorizationcode,
                                     java.lang.String requestReason)
                              throws SapphireException

Internal. Do not use.

Throws:

SapphireException

requestToken

public java.lang.String requestToken(java.lang.String authorizationCode,
                                     java.lang.String requestReason,
                                     java.lang.String externalUserid)
                              throws SapphireException

Internal. Do not use.

Throws:

SapphireException

isTokenActive

public boolean isTokenActive()
                      throws SapphireException

Internal. Do not use.

Throws:

SapphireException

sendCommandToLIMS

public PropertyList sendCommandToLIMS(java.lang.String command,
                                      PropertyList commandRequest)
                               throws SapphireException

Use this to send a PropertyList command to LIMS. Returns a propertylist.

Parameters:

command - the name of the command

commandRequest - the properties to send to the command

Throws:

SapphireException

sendCommandToLIMS

public PropertyList sendCommandToLIMS(java.lang.String processas,
                                      java.lang.String command,
                                      PropertyList commandRequest)
                               throws SapphireException

Use this to send a PropertyList command to LIMS. Returns a propertylist.

Parameters:

processas - the name of the user to process these commands as. Requires the external app to permit this operation

command - the name of the command

commandRequest - the properties to send to the command

Throws:

SapphireException

getConnectionId

public java.lang.String getConnectionId(java.lang.String username,
                                        java.lang.String password,
                                        java.lang.String database)
                                 throws com.labvantage.sapphire.servlet.externalapp.ExternalAppException

Throws:

com.labvantage.sapphire.servlet.externalapp.ExternalAppException

checkConnection

public java.lang.String checkConnection(java.lang.String connectionid)
                                 throws com.labvantage.sapphire.servlet.externalapp.ExternalAppException,
                                        SapphireException

Throws:

com.labvantage.sapphire.servlet.externalapp.ExternalAppException

SapphireException

clearConnection

public void clearConnection(java.lang.String connectionid)
                     throws com.labvantage.sapphire.servlet.externalapp.ExternalAppException,
                            SapphireException

Throws:

com.labvantage.sapphire.servlet.externalapp.ExternalAppException

SapphireException

sendDownloadFileCommandToLIMS

public void sendDownloadFileCommandToLIMS(java.lang.String command,
                                          org.json.JSONObject commandRequest,
                                          java.nio.file.Path targetFile)
                                   throws SapphireException

Throws:

SapphireException

sendDownloadFileCommandToLIMS

public void sendDownloadFileCommandToLIMS(java.lang.String processAs,
                                          java.lang.String command,
                                          org.json.JSONObject jsonRequest,
                                          java.nio.file.Path targetFile)
                                   throws SapphireException

Throws:

SapphireException