Package com.kaltura.client.services

Class AppTokenService

java.lang.Object

com.kaltura.client.services.AppTokenService

public class AppTokenService
extends Object

Manage application authentication tokens

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AppTokenService.AddAppTokenBuilder
static class	AppTokenService.DeleteAppTokenBuilder
static class	AppTokenService.GetAppTokenBuilder
static class	AppTokenService.ListAppTokenBuilder
static class	AppTokenService.StartSessionAppTokenBuilder
static class	AppTokenService.UpdateAppTokenBuilder

Constructor Summary

Constructors

Constructor	Description
AppTokenService()

Method Summary

Modifier and Type	Method	Description
static AppTokenService.AddAppTokenBuilder	add(AppToken appToken)	Add new application authentication token
static AppTokenService.DeleteAppTokenBuilder	delete(String id)	Delete application authentication token by ID
static AppTokenService.GetAppTokenBuilder	get(String id)	Get application authentication token by ID
static AppTokenService.ListAppTokenBuilder	list()
static AppTokenService.ListAppTokenBuilder	list(AppTokenFilter filter)
static AppTokenService.ListAppTokenBuilder	list(AppTokenFilter filter, FilterPager pager)	List application authentication tokens by filter and pager
static AppTokenService.StartSessionAppTokenBuilder	startSession(String id, String tokenHash)
static AppTokenService.StartSessionAppTokenBuilder	startSession(String id, String tokenHash, String userId)
static AppTokenService.StartSessionAppTokenBuilder	startSession(String id, String tokenHash, String userId, SessionType type)
static AppTokenService.StartSessionAppTokenBuilder	startSession(String id, String tokenHash, String userId, SessionType type, int expiry)
static AppTokenService.StartSessionAppTokenBuilder	startSession(String id, String tokenHash, String userId, SessionType type, int expiry, String sessionPrivileges)	Starts a new KS (kaltura Session) based on an application authentication token ID
static AppTokenService.UpdateAppTokenBuilder	update(String id, AppToken appToken)	Update application authentication token by ID

Methods inherited from class java.lang.Object

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

Constructor Detail

AppTokenService

public AppTokenService()

Method Detail

add

public static AppTokenService.AddAppTokenBuilder add(AppToken appToken)

Add new application authentication token

Parameters:

appToken -

delete

public static AppTokenService.DeleteAppTokenBuilder delete(String id)

Delete application authentication token by ID

Parameters:

id -

get

public static AppTokenService.GetAppTokenBuilder get(String id)

Get application authentication token by ID

Parameters:

id -

list

public static AppTokenService.ListAppTokenBuilder list()

list

public static AppTokenService.ListAppTokenBuilder list(AppTokenFilter filter)

list

public static AppTokenService.ListAppTokenBuilder list(AppTokenFilter filter,
                                                       FilterPager pager)

List application authentication tokens by filter and pager

Parameters:

filter -

pager -

startSession

public static AppTokenService.StartSessionAppTokenBuilder startSession(String id,
                                                                       String tokenHash)

startSession

public static AppTokenService.StartSessionAppTokenBuilder startSession(String id,
                                                                       String tokenHash,
                                                                       String userId)

startSession

public static AppTokenService.StartSessionAppTokenBuilder startSession(String id,
                                                                       String tokenHash,
                                                                       String userId,
                                                                       SessionType type)

startSession

public static AppTokenService.StartSessionAppTokenBuilder startSession(String id,
                                                                       String tokenHash,
                                                                       String userId,
                                                                       SessionType type,
                                                                       int expiry)

startSession

public static AppTokenService.StartSessionAppTokenBuilder startSession(String id,
                                                                       String tokenHash,
                                                                       String userId,
                                                                       SessionType type,
                                                                       int expiry,
                                                                       String sessionPrivileges)

Starts a new KS (kaltura Session) based on an application authentication token ID

Parameters:

id - application token ID

tokenHash - a hash [MD5, SHA1, SHA256 and SHA512 are supported] of the current KS concatenated with the application token

userId - session user ID, will be ignored if a different user ID already defined on the application token

type - session type, will be ignored if a different session type is already defined on the application token

expiry - session expiry (in seconds), could be overridden by shorter expiry of the application token

sessionPrivileges - session privileges, will be ignored if a similar privilege is already defined on the application token or the privilege is server reserved

update

public static AppTokenService.UpdateAppTokenBuilder update(String id,
                                                           AppToken appToken)

Update application authentication token by ID

Parameters:

id -

appToken -