org.tsugi.lti2

Class ToolProxy

java.lang.Object

org.tsugi.lti2.ToolProxy

Direct Known Subclasses:

ToolProxyBinding

public class ToolProxy
extends Object

Constructor Summary

Constructors

Constructor and Description
ToolProxy(String tool_proxy) We check for the fields essential for the class to operate here.

Method Summary

Modifier and Type	Method and Description
org.json.simple.JSONArray	enabledCapabilities(org.json.simple.JSONObject resourceHandler, String messageType) Return all enabled capabilities
boolean	enabledCapability(org.json.simple.JSONObject resourceHandler, String messageType, String capability) Check if a particular capability is enabled
org.json.simple.JSONObject	getCustom() Retrieve the custom from the tool_proxy
String	getIconPath(org.json.simple.JSONObject resourceHandler, String icon_style) Extract an icon path by icon_style from an icon_info string
org.json.simple.JSONObject	getMessageOfType(org.json.simple.JSONObject resourceHandler, String messageType) Retrieve a particular message type from an individual resource handler
org.json.simple.JSONObject	getMessageOfType(String messageType) Retrieve a global message type from the ToolProxy
org.json.simple.JSONArray	getParameterFromMessage(org.json.simple.JSONObject message) Retrieve a parameter bundle for a message from the ToolProxy
String	getPathFromMessage(org.json.simple.JSONObject message) Retrieve a path for a message from the ToolProxy
org.json.simple.JSONArray	getResourceHandlers() Retrieve the resource_handlers from a tool_profile
org.json.simple.JSONObject	getSecurityContract() Retrieve the security_contract from the tool_proxy
org.json.simple.JSONObject	getToolProfile() Retrieve the tool_profile from the tool_proxy
org.json.simple.JSONObject	getToolProxy() Retrieve the parsed tool_proxy
String	parseToolProfile(List<Properties> theTools, Properties info) Parse a provider profile with lots of error checking...
String	toString() Return a string
String	validateCapabilities(ToolConsumer consumer) Validate enabled_capabilities agains our ToolConsumer
String	validateServices(ToolConsumer consumer) Validate our tool_services against a tool consumer

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolProxy

public ToolProxy(String tool_proxy)

We check for the fields essential for the class to operate here.

Method Detail

toString

public String toString()

Return a string

Overrides:

toString in class Object

getToolProxy

public org.json.simple.JSONObject getToolProxy()

Retrieve the parsed tool_proxy

getToolProfile

public org.json.simple.JSONObject getToolProfile()

Retrieve the tool_profile from the tool_proxy

getSecurityContract

public org.json.simple.JSONObject getSecurityContract()

Retrieve the security_contract from the tool_proxy

getCustom

public org.json.simple.JSONObject getCustom()

Retrieve the custom from the tool_proxy

getResourceHandlers

public org.json.simple.JSONArray getResourceHandlers()

Retrieve the resource_handlers from a tool_profile

getMessageOfType

public org.json.simple.JSONObject getMessageOfType(String messageType)

Retrieve a global message type from the ToolProxy

Parameters:

String - messageType - Which message type you are looking for

getPathFromMessage

public String getPathFromMessage(org.json.simple.JSONObject message)

Retrieve a path for a message from the ToolProxy

Parameters:

JSONObject - message - The message entry

getParameterFromMessage

public org.json.simple.JSONArray getParameterFromMessage(org.json.simple.JSONObject message)

Retrieve a parameter bundle for a message from the ToolProxy

Parameters:

JSONObject - message - The message entry

getMessageOfType

public org.json.simple.JSONObject getMessageOfType(org.json.simple.JSONObject resourceHandler,
                                                   String messageType)

Retrieve a particular message type from an individual resource handler

Parameters:

String - resourceHandler - JSONObject for the resource_handler

String - messageType - Which message type you are looking for

enabledCapabilities

public org.json.simple.JSONArray enabledCapabilities(org.json.simple.JSONObject resourceHandler,
                                                     String messageType)

Return all enabled capabilities

Parameters:

String - resourceHandler - JSONObject for the resource_handler

String - messageType - Which message type you are looking for

Returns:

JSONArray An array of the enabled capabilities

enabledCapability

public boolean enabledCapability(org.json.simple.JSONObject resourceHandler,
                                 String messageType,
                                 String capability)

Check if a particular capability is enabled

Parameters:

String - resourceHandler - JSONObject for the resource_handler

String - messageType - Which message type you are looking for

String - capability - The capability to look for

getIconPath

public String getIconPath(org.json.simple.JSONObject resourceHandler,
                          String icon_style)

Extract an icon path by icon_style from an icon_info string

Parameters:

String - resourceHandler - JSONObject for the resource_handler

String - icon_style - The style to look for

validateServices

public String validateServices(ToolConsumer consumer)

Validate our tool_services against a tool consumer

validateCapabilities

public String validateCapabilities(ToolConsumer consumer)

Validate enabled_capabilities agains our ToolConsumer

parseToolProfile

public String parseToolProfile(List<Properties> theTools,
                               Properties info)

Parse a provider profile with lots of error checking...