com.kaltura.client.services.SessionService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kalturaApiClient Show documentation
KalturaClient is a library of Java classes that can be used to interact with the Kaltura REST API. More information about the REST API can be found at http://corp.kaltura.com/Products/Kaltura-API Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interect with the API. The current schema can be found at http://www.kaltura.com/api_v3/api_schema.php
There is a newer version: 19.3.0
Show newest version
// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.enums.SessionType;
import com.kaltura.client.types.SessionInfo;
import com.kaltura.client.types.StartWidgetSessionResponse;
import com.kaltura.client.utils.request.NullRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;

/**
 * This class was generated using generate.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

/**
 * Session service
 * 
 * @param session The KS to be parsed, keep it empty to use current session.
 * @param secret - should be the secret (admin or user) of the original partnerId (not
 * impersonatedPartnerId).
 * @param impersonatedPartnerId 
 * @param userId - impersonated userId
 * @param type 
 * @param partnerId 
 * @param expiry KS expiry time in seconds
 * @param privileges 
 * @param session The old KS of the impersonated partner
 * @param type Type of the new KS
 * @param expiry Expiry time in seconds of the new KS
 * @param privileges Privileges of the new KS
 * @param secret Remember to provide the correct secret according to the sessionType you want
 * @param userId 
 * @param type Regular session or Admin session
 * @param partnerId 
 * @param expiry KS expiry time in seconds
 * @param privileges 
 * @param widgetId 
 * @param expiry 
 */
public class SessionService {
	
	public static class EndSessionBuilder extends NullRequestBuilder {
		
		public EndSessionBuilder() {
			super("session", "end");
		}
	}

	/**
	 * End a session with the Kaltura server, making the current KS invalid.
	 */
    public static EndSessionBuilder end()  {
		return new EndSessionBuilder();
	}
	
	public static class GetSessionBuilder extends RequestBuilder {
		
		public GetSessionBuilder(String session) {
			super(SessionInfo.class, "session", "get");
			params.add("session", session);
		}
		
		public void session(String multirequestToken) {
			params.add("session", multirequestToken);
		}
	}

	public static GetSessionBuilder get()  {
		return get(null);
	}

	/**
	 * Parse session key and return its info
	 * 
	 * @param session The KS to be parsed, keep it empty to use current session.
	 */
    public static GetSessionBuilder get(String session)  {
		return new GetSessionBuilder(session);
	}
	
	public static class ImpersonateSessionBuilder extends RequestBuilder {
		
		public ImpersonateSessionBuilder(String secret, int impersonatedPartnerId, String userId, SessionType type, int partnerId, int expiry, String privileges) {
			super(String.class, "session", "impersonate");
			params.add("secret", secret);
			params.add("impersonatedPartnerId", impersonatedPartnerId);
			params.add("userId", userId);
			params.add("type", type);
			params.add("partnerId", partnerId);
			params.add("expiry", expiry);
			params.add("privileges", privileges);
		}
		
		public void secret(String multirequestToken) {
			params.add("secret", multirequestToken);
		}
		
		public void impersonatedPartnerId(String multirequestToken) {
			params.add("impersonatedPartnerId", multirequestToken);
		}
		
		public void userId(String multirequestToken) {
			params.add("userId", multirequestToken);
		}
		
		public void type(String multirequestToken) {
			params.add("type", multirequestToken);
		}
		
		public void partnerId(String multirequestToken) {
			params.add("partnerId", multirequestToken);
		}
		
		public void expiry(String multirequestToken) {
			params.add("expiry", multirequestToken);
		}
		
		public void privileges(String multirequestToken) {
			params.add("privileges", multirequestToken);
		}
	}

	public static ImpersonateSessionBuilder impersonate(String secret, int impersonatedPartnerId)  {
		return impersonate(secret, impersonatedPartnerId, "");
	}

	public static ImpersonateSessionBuilder impersonate(String secret, int impersonatedPartnerId, String userId)  {
		return impersonate(secret, impersonatedPartnerId, userId, SessionType.get(0));
	}

	public static ImpersonateSessionBuilder impersonate(String secret, int impersonatedPartnerId, String userId, SessionType type)  {
		return impersonate(secret, impersonatedPartnerId, userId, type, Integer.MIN_VALUE);
	}

	public static ImpersonateSessionBuilder impersonate(String secret, int impersonatedPartnerId, String userId, SessionType type, int partnerId)  {
		return impersonate(secret, impersonatedPartnerId, userId, type, partnerId, 86400);
	}

	public static ImpersonateSessionBuilder impersonate(String secret, int impersonatedPartnerId, String userId, SessionType type, int partnerId, int expiry)  {
		return impersonate(secret, impersonatedPartnerId, userId, type, partnerId, expiry, null);
	}

	/**
	 * Start an impersonated session with Kaltura's server.   The result KS is the
	  session key that you should pass to all services that requires a ticket.
	 * 
	 * @param secret - should be the secret (admin or user) of the original partnerId (not
	 * impersonatedPartnerId).
	 * @param impersonatedPartnerId 
	 * @param userId - impersonated userId
	 * @param type 
	 * @param partnerId 
	 * @param expiry KS expiry time in seconds
	 * @param privileges 
	 */
    public static ImpersonateSessionBuilder impersonate(String secret, int impersonatedPartnerId, String userId, SessionType type, int partnerId, int expiry, String privileges)  {
		return new ImpersonateSessionBuilder(secret, impersonatedPartnerId, userId, type, partnerId, expiry, privileges);
	}
	
	public static class ImpersonateByKsSessionBuilder extends RequestBuilder {
		
		public ImpersonateByKsSessionBuilder(String session, SessionType type, int expiry, String privileges) {
			super(SessionInfo.class, "session", "impersonateByKs");
			params.add("session", session);
			params.add("type", type);
			params.add("expiry", expiry);
			params.add("privileges", privileges);
		}
		
		public void session(String multirequestToken) {
			params.add("session", multirequestToken);
		}
		
		public void type(String multirequestToken) {
			params.add("type", multirequestToken);
		}
		
		public void expiry(String multirequestToken) {
			params.add("expiry", multirequestToken);
		}
		
		public void privileges(String multirequestToken) {
			params.add("privileges", multirequestToken);
		}
	}

	public static ImpersonateByKsSessionBuilder impersonateByKs(String session)  {
		return impersonateByKs(session, SessionType.get(Integer.MIN_VALUE));
	}

	public static ImpersonateByKsSessionBuilder impersonateByKs(String session, SessionType type)  {
		return impersonateByKs(session, type, Integer.MIN_VALUE);
	}

	public static ImpersonateByKsSessionBuilder impersonateByKs(String session, SessionType type, int expiry)  {
		return impersonateByKs(session, type, expiry, null);
	}

	/**
	 * Start an impersonated session with Kaltura's server.   The result KS info
	  contains the session key that you should pass to all services that requires a
	  ticket.   Type, expiry and privileges won't be changed if they're not set
	 * 
	 * @param session The old KS of the impersonated partner
	 * @param type Type of the new KS
	 * @param expiry Expiry time in seconds of the new KS
	 * @param privileges Privileges of the new KS
	 */
    public static ImpersonateByKsSessionBuilder impersonateByKs(String session, SessionType type, int expiry, String privileges)  {
		return new ImpersonateByKsSessionBuilder(session, type, expiry, privileges);
	}
	
	public static class StartSessionBuilder extends RequestBuilder {
		
		public StartSessionBuilder(String secret, String userId, SessionType type, int partnerId, int expiry, String privileges) {
			super(String.class, "session", "start");
			params.add("secret", secret);
			params.add("userId", userId);
			params.add("type", type);
			params.add("partnerId", partnerId);
			params.add("expiry", expiry);
			params.add("privileges", privileges);
		}
		
		public void secret(String multirequestToken) {
			params.add("secret", multirequestToken);
		}
		
		public void userId(String multirequestToken) {
			params.add("userId", multirequestToken);
		}
		
		public void type(String multirequestToken) {
			params.add("type", multirequestToken);
		}
		
		public void partnerId(String multirequestToken) {
			params.add("partnerId", multirequestToken);
		}
		
		public void expiry(String multirequestToken) {
			params.add("expiry", multirequestToken);
		}
		
		public void privileges(String multirequestToken) {
			params.add("privileges", multirequestToken);
		}
	}

	public static StartSessionBuilder start(String secret)  {
		return start(secret, "");
	}

	public static StartSessionBuilder start(String secret, String userId)  {
		return start(secret, userId, SessionType.get(0));
	}

	public static StartSessionBuilder start(String secret, String userId, SessionType type)  {
		return start(secret, userId, type, Integer.MIN_VALUE);
	}

	public static StartSessionBuilder start(String secret, String userId, SessionType type, int partnerId)  {
		return start(secret, userId, type, partnerId, 86400);
	}

	public static StartSessionBuilder start(String secret, String userId, SessionType type, int partnerId, int expiry)  {
		return start(secret, userId, type, partnerId, expiry, null);
	}

	/**
	 * Start a session with Kaltura's server.   The result KS is the session key that
	  you should pass to all services that requires a ticket.
	 * 
	 * @param secret Remember to provide the correct secret according to the sessionType you want
	 * @param userId 
	 * @param type Regular session or Admin session
	 * @param partnerId 
	 * @param expiry KS expiry time in seconds
	 * @param privileges 
	 */
    public static StartSessionBuilder start(String secret, String userId, SessionType type, int partnerId, int expiry, String privileges)  {
		return new StartSessionBuilder(secret, userId, type, partnerId, expiry, privileges);
	}
	
	public static class StartWidgetSessionSessionBuilder extends RequestBuilder {
		
		public StartWidgetSessionSessionBuilder(String widgetId, int expiry) {
			super(StartWidgetSessionResponse.class, "session", "startWidgetSession");
			params.add("widgetId", widgetId);
			params.add("expiry", expiry);
		}
		
		public void widgetId(String multirequestToken) {
			params.add("widgetId", multirequestToken);
		}
		
		public void expiry(String multirequestToken) {
			params.add("expiry", multirequestToken);
		}
	}

	public static StartWidgetSessionSessionBuilder startWidgetSession(String widgetId)  {
		return startWidgetSession(widgetId, 86400);
	}

	/**
	 * Start a session for Kaltura's flash widgets
	 * 
	 * @param widgetId 
	 * @param expiry 
	 */
    public static StartWidgetSessionSessionBuilder startWidgetSession(String widgetId, int expiry)  {
		return new StartWidgetSessionSessionBuilder(widgetId, expiry);
	}
}