DeepLinkResponse (org.tsugi:tsugi-util 0.3.1 API)

java.lang.Object
- org.tsugi.lti13.DeepLinkResponse

public class DeepLinkResponse
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEPT_MEDIA_TYPES`
`static String`	`CUSTOM`
`static String`	`DATA`
`static String`	`DEEP_LINKS`
`static String`	`ICON`
`static String`	`LINEITEM`
`static String`	`MEDIA_CC`
`static String`	`MEDIA_CC_1_1`
`static String`	`MEDIA_CC_1_2`
`static String`	`MEDIA_CC_1_3`
`static String`	`MEDIA_LTILINKITEM`
`static String`	`TEXT`
`static String`	`TITLE`
`static String`	`TYPE_CONTENTITEM`
`static String`	`TYPE_FILEITEM`
`static String`	`TYPE_LINKITEM`
`static String`	`TYPE_LTILINKITEM`
`static String`	`URL`

Constructor Summary

Constructors
Constructor and Description

DeepLinkResponse(String id_token)
We check for the fields essential for the class to operate here.

Constructors
Constructor and Description
`DeepLinkResponse(String id_token)` We check for the fields essential for the class to operate here.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.json.simple.JSONObject`	`getContentItem()` Retrieve the parsed tool_proxy
`org.json.simple.JSONArray`	`getDeepLinks()` Retrieve the @graph from the content item
`org.json.simple.JSONObject`	`getItemOfType(String itemType)` Retrieve a particular type from the graph
`static boolean`	`isRequest(javax.servlet.http.HttpServletRequest req)` Check if the incoming request is a DeepLinkResponse
`static boolean`	`isRequest(String id_token)` Check if the incoming request is a DeepLinkResponse
`String`	`toString()` Return a string
`boolean`	`validate(Key publicKey)` Validate the incoming request

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEEP_LINKS
```
public static final String DEEP_LINKS
```
    See Also:
    
    Constant Field Values
  - DATA
```
public static final String DATA
```
    See Also:
    
    Constant Field Values
  - ACCEPT_MEDIA_TYPES
```
public static final String ACCEPT_MEDIA_TYPES
```
    See Also:
    
    Constant Field Values
  - MEDIA_LTILINKITEM
```
public static String MEDIA_LTILINKITEM
```
  - MEDIA_CC_1_1
```
public static final String MEDIA_CC_1_1
```
    See Also:
    
    Constant Field Values
  - MEDIA_CC_1_2
```
public static final String MEDIA_CC_1_2
```
    See Also:
    
    Constant Field Values
  - MEDIA_CC_1_3
```
public static final String MEDIA_CC_1_3
```
    See Also:
    
    Constant Field Values
  - MEDIA_CC
```
public static final String MEDIA_CC
```
    See Also:
    
    Constant Field Values
  - TYPE_LINKITEM
```
public static final String TYPE_LINKITEM
```
    See Also:
    
    Constant Field Values
  - TYPE_LTILINKITEM
```
public static final String TYPE_LTILINKITEM
```
    See Also:
    
    Constant Field Values
  - TYPE_CONTENTITEM
```
public static final String TYPE_CONTENTITEM
```
    See Also:
    
    Constant Field Values
  - TYPE_FILEITEM
```
public static final String TYPE_FILEITEM
```
    See Also:
    
    Constant Field Values
  - TITLE
```
public static final String TITLE
```
    See Also:
    
    Constant Field Values
  - TEXT
```
public static final String TEXT
```
    See Also:
    
    Constant Field Values
  - URL
```
public static final String URL
```
    See Also:
    
    Constant Field Values
  - LINEITEM
```
public static final String LINEITEM
```
    See Also:
    
    Constant Field Values
  - CUSTOM
```
public static final String CUSTOM
```
    See Also:
    
    Constant Field Values
  - ICON
```
public static final String ICON
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DeepLinkResponse
```
public DeepLinkResponse(String id_token)
```
    We check for the fields essential for the class to operate here.
- Method Detail
  - isRequest
```
public static boolean isRequest(javax.servlet.http.HttpServletRequest req)
```
    Check if the incoming request is a DeepLinkResponse
  - isRequest
```
public static boolean isRequest(String id_token)
```
    Check if the incoming request is a DeepLinkResponse
  - validate
```
public boolean validate(Key publicKey)
```
    Validate the incoming request
    
    Parameters:
    
    URL - The URL of the incoming request. If this in null, the URL is taken from the request object. Sometimes the request object can be misleading when sitting behind a load balancer or some kind of proxy.
  - toString
```
public String toString()
```
    Return a string
    
    Overrides:
    
    toString in class Object
  - getContentItem
```
public org.json.simple.JSONObject getContentItem()
```
    Retrieve the parsed tool_proxy
  - getDeepLinks
```
public org.json.simple.JSONArray getDeepLinks()
```
    Retrieve the @graph from the content item
  - getItemOfType
```
public org.json.simple.JSONObject getItemOfType(String itemType)
```
    Retrieve a particular type from the graph
    
    Parameters:
    
    String - messageType - Which item type you are looking for

Class DeepLinkResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEEP_LINKS

DATA

ACCEPT_MEDIA_TYPES

MEDIA_LTILINKITEM

MEDIA_CC_1_1

MEDIA_CC_1_2

MEDIA_CC_1_3

MEDIA_CC

TYPE_LINKITEM

TYPE_LTILINKITEM

TYPE_CONTENTITEM

TYPE_FILEITEM

TITLE

TEXT

URL

LINEITEM

CUSTOM

ICON

Constructor Detail

DeepLinkResponse

Method Detail

isRequest

isRequest

validate

toString

getContentItem

getDeepLinks

getItemOfType