sapphire.servlet

Class BaseExternalHandler

java.lang.Object

com.labvantage.sapphire.BaseCustom

sapphire.servlet.BaseExternalHandler

All Implemented Interfaces:

com.labvantage.sapphire.servlet.externalapp.ExternalAppConstants, com.labvantage.sapphire.servlet.rest.RestConstants, com.labvantage.sapphire.util.cache.CacheNames

public abstract class BaseExternalHandler
extends com.labvantage.sapphire.BaseCustom
implements com.labvantage.sapphire.util.cache.CacheNames, com.labvantage.sapphire.servlet.externalapp.ExternalAppConstants

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONNECTIONID
static java.lang.String	DATABASE
static java.lang.String	GETCONNECTIONID
static java.lang.String	PASSWORD
static java.lang.String	USERNAME

Fields inherited from class com.labvantage.sapphire.BaseCustom

FAILURE, logger, logName, SUCCESS

Fields inherited from interface com.labvantage.sapphire.util.cache.CacheNames

CACHE_ACTION_ATTACHMENTS, CACHE_ACTION_DEFINITION, CACHE_ACTION_PROPERTYLIST, CACHE_ACTION_ROLES, CACHE_APP_RESOURCE_SDIS, CACHE_APP_RESOURCE_TAGS, CACHE_ASSIGNMENT_RESOURCEDATA, CACHE_ATTACHMENTS_EXPLODEDPATH, CACHE_ATTACHMENTS_LOCALFILE, CACHE_AUTHTOKEN, CACHE_AUTHTOKEN_CONNECTIONID, CACHE_CALENDAR, CACHE_CLASSLOADERS, CACHE_CONNECTION_PROPERTIES, CACHE_DATACHART, CACHE_DEFAULT_PAGE_EDITION, CACHE_DEPARTMENT, CACHE_DEPARTMENT_SCHEDULE, CACHE_DEPARTMENTUSERS, CACHE_EDITORSTYLE, CACHE_EVENTMANAGER, CACHE_EXPRESSIONPREFIX, CACHE_EXTERNALAPP, CACHE_FORM_DEFINITION, CACHE_GIZMO, CACHE_GIZMO_DEFAULTS, CACHE_GIZMODEF, CACHE_GIZMODEF_ACCESS, CACHE_GIZMODEF_ALL, CACHE_GIZMODEF_ASSETS, CACHE_GIZMODEF_SECURED, CACHE_GIZMODEF_USER, CACHE_GUIMODES, CACHE_IMAGEREF, CACHE_PARAMLIST_CURRENTVERSION, CACHE_PROFILE_PROPERTIES, CACHE_PROPERTYTREE, CACHE_PROPERTYTREE_NODE, CACHE_REFVALUES, CACHE_SCHEDULE_EXCLUDES, CACHE_SCHEDULE_TASK_NODE_PROPERTIES, CACHE_SCHEDULE_TASK_PROPERTYTREE, CACHE_SCHEDULEGRID, CACHE_SDC, CACHE_SDC_LINKDATA, CACHE_SPECRULES, CACHE_STEPTYPE, CACHE_SYSCONFIG_PROPERTIES, CACHE_TABLE_COLUMNS, CACHE_TASKDEF, CACHE_TASKSTEPPROPS, CACHE_TASKSTEPTYPEPROPS, CACHE_TESTMETHOD, CACHE_UNITCONVERSION, CACHE_USER_SCHEDULES, CACHE_WEBPAGE_ACCESS, CACHE_WEBPAGE_FILENAME, CACHE_WEBPAGE_PROPERTIES, CACHE_WEBPAGE_PROPERYTREE, CACHE_WEBPAGE_TREEELEMENT, CACHE_WEBPAGE_USEROVERRIDES, CACHE_WORKITEM

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
BaseExternalHandler()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAuthenticationValue(java.lang.String authenticationParam, HttpServletRequest request, HttpServletResponse response) Internal.
java.lang.String	getDatabaseId() Get the databaseid this command handler is associated with
java.lang.String	getExternalAppid() Get the external app this command handler is associated with
java.lang.String	getExternalUserid() Get the external user this command handler is associated with
static BaseExternalHandler	getInstance(HttpServletRequest request, HttpServletResponse response) Internal.
java.lang.String	getProcessAsUserId() Get the process-as user this command handler is associated with
org.json.JSONObject	processCommand(java.lang.String command, org.json.JSONObject commandRequest) Overide this method to handle commands coming from an external app.
PropertyList	processCommand(java.lang.String command, PropertyList commandRequest) Overide this method to handle commands coming from an external app.
org.json.JSONObject	processFileCommand(java.lang.String command, java.nio.file.Path file, org.json.JSONObject commandRequest) Overide this method to handle commands coming from an external app that are accompanited by a file.
org.json.JSONObject	processFileCommand(java.lang.String command, java.lang.String filename, java.io.InputStream inputStream, org.json.JSONObject commandRequest) Overide this method to handle commands coming from an external app that are accompanited by a file.
java.io.File	processFileDownloadCommand(java.lang.String command, org.json.JSONObject commandRequest) Overide this method to handle commands coming from an external app that require a file to be downloaded
void	setDatabaseId(java.lang.String databaseId) Internal.
void	setExternalAppid(java.lang.String externalAppid) Internal.
void	setExternalUserid(java.lang.String externalUserid) Internal.
void	setProcessAsUserId(java.lang.String processAsUserId) Internal.

Methods inherited from class com.labvantage.sapphire.BaseCustom

getAccessorErrorIds, getAccessorErrorMsgs, getActionProcessor, getConfigurationProcessor, getConnectionid, getConnectionId, getConnectionProcessor, getDAMProcessor, getDepartmentList, getHttpProcessor, getQueryProcessor, getRakFile, getSDCProcessor, getSDIProcessor, getSequenceProcessor, getTranslationProcessor, setConnectionId, setLanguage, setRakFile

Methods inherited from class java.lang.Object

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

Field Detail

GETCONNECTIONID

public static final java.lang.String GETCONNECTIONID

See Also:

Constant Field Values

USERNAME

public static final java.lang.String USERNAME

See Also:

Constant Field Values

PASSWORD

public static final java.lang.String PASSWORD

See Also:

Constant Field Values

DATABASE

public static final java.lang.String DATABASE

See Also:

Constant Field Values

CONNECTIONID

public static final java.lang.String CONNECTIONID

See Also:

Constant Field Values

Constructor Detail

BaseExternalHandler

public BaseExternalHandler()

Method Detail

processCommand

public org.json.JSONObject processCommand(java.lang.String command,
                                          org.json.JSONObject commandRequest)
                                   throws SapphireException

Overide this method to handle commands coming from an external app. Parameters are send as a json object and should be returned as such

Parameters:

command - the command to execute

commandRequest - the set of parameters

Throws:

SapphireException

processCommand

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

Overide this method to handle commands coming from an external app. Parameters are sent as a propertylist object and should be returned as such

Parameters:

command - the command to execute

commandRequest - the set of parameters

Throws:

SapphireException

processFileCommand

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

Overide this method to handle commands coming from an external app that are accompanited by a file.

Parameters:

command - the command to execute

file - the file associated with the command

commandRequest - the set of parameters

Throws:

SapphireException

processFileCommand

public org.json.JSONObject processFileCommand(java.lang.String command,
                                              java.lang.String filename,
                                              java.io.InputStream inputStream,
                                              org.json.JSONObject commandRequest)
                                       throws SapphireException

Overide this method to handle commands coming from an external app that are accompanited by a file.

Parameters:

command - the command to execute

filename - the file associated with the command

inputStream - a stream of the file associated with the command

commandRequest - the set of parameters

Throws:

SapphireException

processFileDownloadCommand

public java.io.File processFileDownloadCommand(java.lang.String command,
                                               org.json.JSONObject commandRequest)
                                        throws SapphireException

Overide this method to handle commands coming from an external app that require a file to be downloaded

Parameters:

command - the command to execute

commandRequest - the set of parameters

Throws:

SapphireException

getDatabaseId

public java.lang.String getDatabaseId()

Get the databaseid this command handler is associated with

getExternalAppid

public java.lang.String getExternalAppid()

Get the external app this command handler is associated with

getExternalUserid

public java.lang.String getExternalUserid()

Get the external user this command handler is associated with

getProcessAsUserId

public java.lang.String getProcessAsUserId()

Get the process-as user this command handler is associated with

getInstance

public static BaseExternalHandler getInstance(HttpServletRequest request,
                                              HttpServletResponse response)
                                       throws com.labvantage.sapphire.servlet.externalapp.ExternalAppException

Internal. Do not use.

Throws:

com.labvantage.sapphire.servlet.externalapp.ExternalAppException

getAuthenticationValue

public static java.lang.String getAuthenticationValue(java.lang.String authenticationParam,
                                                      HttpServletRequest request,
                                                      HttpServletResponse response)

Internal. Do not use.

setExternalAppid

public void setExternalAppid(java.lang.String externalAppid)

Internal. Do not use.

setExternalUserid

public void setExternalUserid(java.lang.String externalUserid)

Internal. Do not use.

setProcessAsUserId

public void setProcessAsUserId(java.lang.String processAsUserId)

Internal. Do not use.

setDatabaseId

public void setDatabaseId(java.lang.String databaseId)

Internal. Do not use.