org.imsglobal.lti2.objects.consumer.StandardServices Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of basiclti-util Show documentation

BasicLTI Utilities are a set of utility classes to aid in the development of BasicLTI consumers and providers. They deal with much of the heavy lifting and make the process more opaque to the developer.

The newest version!


package org.imsglobal.lti2.objects.consumer;

import java.util.Arrays;

public class StandardServices {

    public static final String TOOLPROXY_FORMAT = "application/vnd.ims.lti.v2.toolproxy+json";
    public static final String TOOLSETTINGS_CONTEXT = "http://purl.imsglobal.org/ctx/lti/v2/ToolSettings";
    public static final String TOOLSETTINGS_FORMAT = "application/vnd.ims.lti.v2.toolsettings+json";
    public static final String TOOLSETTINGS_SIMPLE_FORMAT = "application/vnd.ims.lti.v2.toolsettings.simple+json";

    public static final String TOOLPROXY_ID_CONTEXT = "http://purl.imsglobal.org/ctx/lti/v2/ToolProxyId";
    public static final String TOOLPROXY_ID_FORMAT = "application/vnd.ims.lti.v2.toolproxy.id+json";
    public static final String TOOLPROXY_ID_TYPE = "ToolProxy";

	public static final String RESULT_FORMAT = "application/vnd.ims.lis.v2.result+json";
	public static final String RESULT_CONTEXT = "http://purl.imsglobal.org/ctx/lis/v2/Result";
	public static final String RESULT_TYPE = "Result";

    public static ServiceOffered LTI2Registration(String endpoint) {
		ServiceOffered ret = new ServiceOffered();
		ret.setEndpoint(endpoint);
		ret.set_id("tcp:ToolProxy.collection");    // TODO: Is this right see 5.6 in the docs
		ret.set_type("RestService");
		ret.setFormat(Arrays.asList(TOOLPROXY_FORMAT));
		ret.setAction(Arrays.asList("POST"));
		return ret;
    }

    // "endpoint" : "http://lms.example.com/resources/ToolProxy/{tool_proxy_guid}",
    public static ServiceOffered LTI2ProxyItem(String endpoint) {
		ServiceOffered ret = new ServiceOffered();
		ret.setEndpoint(endpoint);
		ret.set_id("tcp:ToolProxy.item");
		ret.set_type("RestService");
		ret.setFormat(Arrays.asList(TOOLPROXY_FORMAT));
		ret.setAction(Arrays.asList("GET", "PUT"));
		return ret;
    }

    // "endpoint" : "http://lms.example.com/resources/Result/{sourcedId}",
    public static ServiceOffered LTI2ResultItem(String endpoint) {
		ServiceOffered ret = new ServiceOffered();
		ret.setEndpoint(endpoint);
		ret.set_id("tcp:Result.item");    // TODO: Is this right see 5.6 in the docs
		ret.set_type("RestService");
		ret.setFormat(Arrays.asList(RESULT_FORMAT));
		ret.setAction(Arrays.asList("GET", "PUT"));
		return ret;
    }

    // "endpoint" : "http://lms.example.com/resources/ToolProxy/{tool_proxy_guid}/custom",
    public static ServiceOffered LTI2ToolProxySettings(String endpoint) {
		ServiceOffered ret = new ServiceOffered();
		ret.setEndpoint(endpoint);
		ret.set_id("tcp:ToolProxySettings");    
		ret.set_type("RestService");
		ret.setFormat(Arrays.asList(TOOLSETTINGS_FORMAT, TOOLSETTINGS_SIMPLE_FORMAT));
		ret.setAction(Arrays.asList("GET", "PUT"));
		return ret;
    }

    // "endpoint" : "http://lms.example.com/resources/links/{link_id}/custom",
    public static ServiceOffered LTI2LtiLinkSettings(String endpoint) {
		ServiceOffered ret = new ServiceOffered();
		ret.setEndpoint(endpoint);
		ret.set_id("tcp:LtiLinkSettings");    
		ret.set_type("RestService");
		ret.setFormat(Arrays.asList(TOOLSETTINGS_FORMAT, TOOLSETTINGS_SIMPLE_FORMAT));
		ret.setAction(Arrays.asList("GET", "PUT"));
		return ret;
    }

    public static ServiceOffered LTI1Outcomes(String endpoint) {
		ServiceOffered ret = new ServiceOffered();
		ret.setEndpoint(endpoint);
		ret.set_id("tcp:LTI_1_1_ResultService");
		ret.set_type("RestService");
		ret.setFormat(Arrays.asList("application/vnd.ims.lti.v1.outcome+xml"));
		ret.setAction(Arrays.asList("POST"));
		return ret;
    }


}