edu.ksu.lti.launch.model.LtiSession Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lti-launch Show documentation
Java framework for authenticating LTI launch requests from the Canvas LMS
The newest version!
package edu.ksu.lti.launch.model;

import edu.ksu.canvas.oauth.OauthToken;
import edu.ksu.lti.launch.controller.LtiLaunchController;

/**
 * Class to hold LTI session data. It is created and populated when the LTI application is first
 * launched and then stored in the session for future reference. Some commonly accessed information
 * is stored in their own variables (like eID) but all data we get as part of the LTI launch request
 * is stored in the {@link LtiLaunchData} object if you need it.
 *
 * Ideally this would be a session scoped bean that gets autowired into the controllers.
 * Unfortunately this breaks when I try to wire it into both an LTI controller and the Oauth controller
 * so I ended up making my own session management in {@link LtiLaunchController}
 */
public class LtiSession {

    private String applicationName;
    private String initialViewPath;
    private String eid;
    private String canvasCourseId;
    private String canvasDomain;
    private OauthToken oauthToken;
    private String oauthTokenRequestState;
    private LtiLaunchData ltiLaunchData;


	public void setApplicationName(String applicationName) {
        this.applicationName = applicationName;
    }

    public String getApplicationName() {
        return applicationName;
    }

    public void setInitialViewPath(String initialViewPath) {
        this.initialViewPath = initialViewPath;
    }

    public String getInitialViewPath() {
        return initialViewPath;
    }

    public void setEid(String eid) {
        this.eid = eid;
    }

    public String getEid() {
        return eid;
    }

    // Canvas API library now takes an object, not a string. Never use the string
    @Deprecated
    public String getApiToken() {
    	return oauthToken.getAccessToken();
    }
    
    public void setOauthToken(OauthToken oauthToken) {
    	this.oauthToken = oauthToken;
    }

    /**
     * Get the current user's Canvas API OAuth token for authentication
     * @return User's OAuth token
     */
    public OauthToken getOauthToken() {
        return this.oauthToken;
    }

    public void setCanvasCourseId(String canvasCourseId) {
        this.canvasCourseId = canvasCourseId;
    }

    public String getCanvasCourseId() {
        return canvasCourseId;
    }

    public void setCanvasDomain(String canvasDomain) {
        this.canvasDomain = canvasDomain;
    }

    public String getCanvasDomain() {
        return canvasDomain;
    }

    public void setLtiLaunchData(LtiLaunchData ltiLaunchData) {
        this.ltiLaunchData = ltiLaunchData;
    }

    public LtiLaunchData getLtiLaunchData() {
        return ltiLaunchData;
    }
    
    public String getOauthTokenRequestState() {
		return oauthTokenRequestState;
	}

	public void setOauthTokenRequestState(String oauthTokenRequestState) {
		this.oauthTokenRequestState = oauthTokenRequestState;
	}
}