slycat.web.server.handlers

slycat.web.server.handlers.css_bundle()

slycat.web.server.handlers.delete_job(hostname, jid)

slycat.web.server.handlers.delete_model(mid)

slycat.web.server.handlers.delete_model_parameter(mid, aid)

delete a model artifact :param mid: model Id :param aid: artifact id :return:

slycat.web.server.handlers.delete_project(pid)

slycat.web.server.handlers.delete_project_cache(pid)

clears all the cached images and videos for a project given a project ID :param pid: Project ID :return: status

slycat.web.server.handlers.delete_project_cache_object(pid, key)

slycat.web.server.handlers.delete_reference(rid)

slycat.web.server.handlers.delete_remote(sid)

slycat.web.server.handlers.delete_upload(uid)

cleans up an upload session throws 409 if the session is busy :param uid: :return: not used

slycat.web.server.handlers.get_bookmark(bid)

slycat.web.server.handlers.get_checkjob(hostname, jid)

slycat.web.server.handlers.get_configuration_ga_tracking_id()

slycat.web.server.handlers.get_configuration_injected_code()

slycat.web.server.handlers.get_configuration_markings()

slycat.web.server.handlers.get_configuration_parsers()

slycat.web.server.handlers.get_configuration_remote_hosts()

slycat.web.server.handlers.get_configuration_support_email()

slycat.web.server.handlers.get_configuration_version()

slycat.web.server.handlers.get_configuration_wizards()

slycat.web.server.handlers.get_global_resource(resource)

slycat.web.server.handlers.get_job_output(hostname, jid, path)

slycat.web.server.handlers.get_model(mid, **kwargs)

slycat.web.server.handlers.get_model_array_attribute_chunk(mid, aid, array, attribute, **arguments)

slycat.web.server.handlers.get_model_arrayset_data(mid, aid, hyperchunks, byteorder=None)

slycat.web.server.handlers.get_model_arrayset_metadata(mid, aid, **kwargs)

slycat.web.server.handlers.get_model_file(mid, aid)

slycat.web.server.handlers.get_model_parameter(mid, aid)

slycat.web.server.handlers.get_model_statistics(mid)

returns statistics on the model :param mid: model ID :return json: {

“mid”:mid, “hdf5_file_size”:hdf5_file_size, “total_server_data_size”: total_server_data_size, “hdf5_store_size”:total_hdf5_server_size, “model”:model, “delta_creation_time”:delta_creation_time, “couchdb_doc_size”: sys.getsizeof(model)

}

slycat.web.server.handlers.get_model_table_chunk(mid, aid, array, rows=None, columns=None, index=None, sort=None)

slycat.web.server.handlers.get_model_table_metadata(mid, aid, array, index=None)

slycat.web.server.handlers.get_model_table_sorted_indices(mid, aid, array, rows=None, index=None, sort=None, byteorder=None)

slycat.web.server.handlers.get_model_table_unsorted_indices(mid, aid, array, rows=None, index=None, sort=None, byteorder=None)

slycat.web.server.handlers.get_page(ptype)

slycat.web.server.handlers.get_page_resource(ptype, resource)

slycat.web.server.handlers.get_project(pid)

returns a project based on “content-type” header :param pid: project ID :return: Either html landing page of given project or the json representation of the project

slycat.web.server.handlers.get_project_cache_object(pid, key)

slycat.web.server.handlers.get_project_models(pid)

slycat.web.server.handlers.get_project_references(pid)

slycat.web.server.handlers.get_projects(_=None)

returns either and array of projects or html for displaying the projects :param _: :return:

slycat.web.server.handlers.get_projects_list(_=None)

returns either and array of projects or html for displaying the projects :param _: :return:

slycat.web.server.handlers.get_remote_file(hostname, path, **kwargs)

Given a hostname and file path returns the file given by the path :param hostname: connection host name :param path: path to file :param kwargs: :return: file

slycat.web.server.handlers.get_remote_host_dict()

slycat.web.server.handlers.get_remote_image(hostname, path, **kwargs)

Given a hostname and image path returns the image given by the path :param hostname: connection host name :param path: path to image :param kwargs: :return: image

slycat.web.server.handlers.get_remote_job_status(hostname, jid)

slycat.web.server.handlers.get_remote_show_user_password()

checks to see if the application needs to show password :return: json {show:bool, msg:msg}

slycat.web.server.handlers.get_remote_video(hostname, vsid)

Given a hostname and vsid returns the video given by the vsid :param hostname: connection host name :param vsid: video uuid :return: video

slycat.web.server.handlers.get_remote_video_status(hostname, vsid)

Given a hostname and vsid returns the video status given by the vsid :param hostname: connection host name :param vsid: video uuid :return: json

slycat.web.server.handlers.get_remotes(hostname)

Returns {status: True} if the hostname was found in the user’s session :param hostname: connection host name :return: {“status”:status, “msg”:msg}

slycat.web.server.handlers.get_root()

Redirect all requests to “/” to “/projects” Not sure why we used to do that, but after conversion to webpack this is no longer needed, so I changed the projects-redirect config parameter in web-server-config.ini to just “/”

slycat.web.server.handlers.get_session_status(hostname)

slycat.web.server.handlers.get_sid(hostname)

Takes a hostname address and returns the established sid value base on what is found in the users session raises 400 and 404 :param hostname: name of the host we are trying to connect to :return: sid : uuid for the session name

slycat.web.server.handlers.get_table_metadata(file, array_index, index)

Return table-oriented metadata for a 1D array, plus an optional index column.

slycat.web.server.handlers.get_table_sort_index(file, metadata, array_index, sort, index)

slycat.web.server.handlers.get_time_series_names(hostname, path, **kwargs)

Parse a time series csv for all column names :param hostname: connection host name :param path: path to csv file :param kwargs: :return: json object of column names

slycat.web.server.handlers.get_user(uid)

slycat.web.server.handlers.get_user_config(hostname)

slycat.web.server.handlers.get_wizard_resource(wtype, resource)

slycat.web.server.handlers.job_time(nodes, tasks, size)

gives the time in seconds recommended given job meta data :param nodes: number of hpc nodes for job :param tasks: number of tasks per node for job :param size: size of data file used in the job :return: json time in seconds as an integer {‘time-seconds’: 1800}

slycat.web.server.handlers.js_bundle()

slycat.web.server.handlers.login()

Takes the post object under cherrypy.request.json with the users name and password and determins with the user can be authenticated with slycat :return: authentication status

slycat.web.server.handlers.logout()

See if the client has a valid session. If so delete it :return: the status of the request

slycat.web.server.handlers.model_command(mid, type, command, **kwargs)

slycat.web.server.handlers.model_sensitive_command(mid, type, command)

slycat.web.server.handlers.open_id_authenticate(**params)

takes the openid parameter sent to this function and logs in a user :param params: openid params as a dictionary :return: not used

slycat.web.server.handlers.post_events(event)

slycat.web.server.handlers.post_log()

send post json {“message”:”message”} to log client errors onto the client server :return:

slycat.web.server.handlers.post_model_arrayset_data(mid, aid)

get the arrayset data based on aid, mid, byteorder, and hyperchunks

requires hyperchunks to be included in the json payload

Parameters:

• mid – model id
• aid – artifact id

Returns:

stream of data

slycat.web.server.handlers.post_model_files(mid, input=None, files=None, sids=None, paths=None, aids=None, parser=None, **kwargs)

slycat.web.server.handlers.post_model_finish(mid)

slycat.web.server.handlers.post_project_bookmarks(pid)

slycat.web.server.handlers.post_project_models(pid)

When a pid along with json “model-type”, “marking”, “name” is sent with POST creates a model and saves it to the database :param pid: project ID for created model :return: json {“id” : mid}

slycat.web.server.handlers.post_project_references(pid)

slycat.web.server.handlers.post_projects()

slycat.web.server.handlers.post_remote_browse(hostname, path)

slycat.web.server.handlers.post_remote_command(hostname)

run a remote command from the list of pre-registered commands that are located on a remote agent. :param hostname: name of the hpc host :return: {

“message”: a message that is supplied by the agent, “command”: an echo of the command that was sent to the server and the agent, “error”: boolean describing if there was an agent error, “available_scripts”: [{

“name”: script_name, “description”: script_description, “parameters”: [{

“name”: parameter_name as string, “description”: description of the param string, “example”:example usage string, “type”: field type eg string, int…

}]

}]list of available scripts from the agent

}

slycat.web.server.handlers.post_remote_launch(hostname)

slycat.web.server.handlers.post_remotes()

Given username, hostname, password as a json payload establishes a session with the remote host and attaches it to the users session :return: {“sid”:sid, “status”:boolean, msg:”“}

slycat.web.server.handlers.post_submit_batch(hostname)

slycat.web.server.handlers.post_upload_finished(uid)

ask the server to finish the upload :param uid: upload session ID :return: status of upload

slycat.web.server.handlers.post_uploads()

creates a session for uploading a file to :return: Upload ID

slycat.web.server.handlers.put_model(mid)

slycat.web.server.handlers.put_model_arrayset(mid, aid)

slycat.web.server.handlers.put_model_arrayset_array(mid, aid, array)

slycat.web.server.handlers.put_model_arrayset_data(mid, aid, hyperchunks, data, byteorder=None)

slycat.web.server.handlers.put_model_inputs(mid)

slycat.web.server.handlers.put_model_parameter(mid, aid)

slycat.web.server.handlers.put_project(pid)

slycat.web.server.handlers.put_reference(rid)

slycat.web.server.handlers.put_upload_file_part(uid, fid, pid, file=None, hostname=None, path=None)

slycat.web.server.handlers.require_array_json_parameter(name)

slycat.web.server.handlers.require_boolean_json_parameter(name)

slycat.web.server.handlers.require_integer_array_json_parameter(name)

slycat.web.server.handlers.require_integer_parameter(value, name)

slycat.web.server.handlers.require_json_parameter(name)

checks to see if the parameter is in the cherrypy.request.json and errors gracefully if it is not there :param name: name of json param :return: value of the json param

slycat.web.server.handlers.run_agent_function(hostname)

slycat.web.server.handlers.set_user_config(hostname)

slycat.web.server.handlers.tests_request(*arguments, **keywords)

slycat.web.server.handlers.validate_table_byteorder(byteorder)

slycat.web.server.handlers.validate_table_columns(columns)

slycat.web.server.handlers.validate_table_rows(rows)

slycat.web.server.handlers.validate_table_sort(sort)