Package com.kaltura.client.services

Class SessionService

java.lang.Object

com.kaltura.client.services.SessionService

public class SessionService
extends Object

Session service

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionService.EndSessionBuilder
static class	SessionService.GetSessionBuilder
static class	SessionService.ImpersonateByKsSessionBuilder
static class	SessionService.ImpersonateSessionBuilder
static class	SessionService.StartSessionBuilder
static class	SessionService.StartWidgetSessionSessionBuilder

Constructor Summary

Constructors

Constructor	Description
SessionService()

Method Summary

Modifier and Type	Method	Description
static SessionService.EndSessionBuilder	end()	End a session with the Kaltura server, making the current KS invalid.
static SessionService.GetSessionBuilder	get()
static SessionService.GetSessionBuilder	get(String session)	Parse session key and return its info
static SessionService.ImpersonateSessionBuilder	impersonate(String secret, int impersonatedPartnerId)
static SessionService.ImpersonateSessionBuilder	impersonate(String secret, int impersonatedPartnerId, String userId)
static SessionService.ImpersonateSessionBuilder	impersonate(String secret, int impersonatedPartnerId, String userId, SessionType type)
static SessionService.ImpersonateSessionBuilder	impersonate(String secret, int impersonatedPartnerId, String userId, SessionType type, int partnerId)
static SessionService.ImpersonateSessionBuilder	impersonate(String secret, int impersonatedPartnerId, String userId, SessionType type, int partnerId, int expiry)
static SessionService.ImpersonateSessionBuilder	impersonate(String secret, int impersonatedPartnerId, String userId, SessionType type, int partnerId, int expiry, String privileges)	Start an impersonated session with Kaltura's server.
static SessionService.ImpersonateByKsSessionBuilder	impersonateByKs(String session)
static SessionService.ImpersonateByKsSessionBuilder	impersonateByKs(String session, SessionType type)
static SessionService.ImpersonateByKsSessionBuilder	impersonateByKs(String session, SessionType type, int expiry)
static SessionService.ImpersonateByKsSessionBuilder	impersonateByKs(String session, SessionType type, int expiry, String privileges)	Start an impersonated session with Kaltura's server.
static SessionService.StartSessionBuilder	start(String secret)
static SessionService.StartSessionBuilder	start(String secret, String userId)
static SessionService.StartSessionBuilder	start(String secret, String userId, SessionType type)
static SessionService.StartSessionBuilder	start(String secret, String userId, SessionType type, int partnerId)
static SessionService.StartSessionBuilder	start(String secret, String userId, SessionType type, int partnerId, int expiry)
static SessionService.StartSessionBuilder	start(String secret, String userId, SessionType type, int partnerId, int expiry, String privileges)	Start a session with Kaltura's server.
static SessionService.StartWidgetSessionSessionBuilder	startWidgetSession(String widgetId)
static SessionService.StartWidgetSessionSessionBuilder	startWidgetSession(String widgetId, int expiry)	Start a session for Kaltura's flash widgets

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionService

public SessionService()

Method Detail

end

public static SessionService.EndSessionBuilder end()

End a session with the Kaltura server, making the current KS invalid.

get

public static SessionService.GetSessionBuilder get()

get

public static SessionService.GetSessionBuilder get(String session)

Parse session key and return its info

Parameters:

session - The KS to be parsed, keep it empty to use current session.

impersonate

public static SessionService.ImpersonateSessionBuilder impersonate(String secret,
                                                                   int impersonatedPartnerId)

impersonate

public static SessionService.ImpersonateSessionBuilder impersonate(String secret,
                                                                   int impersonatedPartnerId,
                                                                   String userId)

impersonate

public static SessionService.ImpersonateSessionBuilder impersonate(String secret,
                                                                   int impersonatedPartnerId,
                                                                   String userId,
                                                                   SessionType type)

impersonate

public static SessionService.ImpersonateSessionBuilder impersonate(String secret,
                                                                   int impersonatedPartnerId,
                                                                   String userId,
                                                                   SessionType type,
                                                                   int partnerId)

impersonate

public static SessionService.ImpersonateSessionBuilder impersonate(String secret,
                                                                   int impersonatedPartnerId,
                                                                   String userId,
                                                                   SessionType type,
                                                                   int partnerId,
                                                                   int expiry)

impersonate

public static SessionService.ImpersonateSessionBuilder impersonate(String secret,
                                                                   int impersonatedPartnerId,
                                                                   String userId,
                                                                   SessionType type,
                                                                   int partnerId,
                                                                   int expiry,
                                                                   String privileges)

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.

Parameters:

secret - - should be the secret (admin or user) of the original partnerId (not impersonatedPartnerId).

impersonatedPartnerId -

userId - - impersonated userId

type -

partnerId -

expiry - KS expiry time in seconds

privileges -

impersonateByKs

public static SessionService.ImpersonateByKsSessionBuilder impersonateByKs(String session)

impersonateByKs

public static SessionService.ImpersonateByKsSessionBuilder impersonateByKs(String session,
                                                                           SessionType type)

impersonateByKs

public static SessionService.ImpersonateByKsSessionBuilder impersonateByKs(String session,
                                                                           SessionType type,
                                                                           int expiry)

impersonateByKs

public static SessionService.ImpersonateByKsSessionBuilder impersonateByKs(String session,
                                                                           SessionType type,
                                                                           int expiry,
                                                                           String privileges)

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

Parameters:

session - The old KS of the impersonated partner

type - Type of the new KS

expiry - Expiry time in seconds of the new KS

privileges - Privileges of the new KS

start

public static SessionService.StartSessionBuilder start(String secret)

start

public static SessionService.StartSessionBuilder start(String secret,
                                                       String userId)

start

public static SessionService.StartSessionBuilder start(String secret,
                                                       String userId,
                                                       SessionType type)

start

public static SessionService.StartSessionBuilder start(String secret,
                                                       String userId,
                                                       SessionType type,
                                                       int partnerId)

start

public static SessionService.StartSessionBuilder start(String secret,
                                                       String userId,
                                                       SessionType type,
                                                       int partnerId,
                                                       int expiry)

start

public static SessionService.StartSessionBuilder start(String secret,
                                                       String userId,
                                                       SessionType type,
                                                       int partnerId,
                                                       int expiry,
                                                       String privileges)

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.

Parameters:

secret - Remember to provide the correct secret according to the sessionType you want

userId -

type - Regular session or Admin session

partnerId -

expiry - KS expiry time in seconds

privileges -

startWidgetSession

public static SessionService.StartWidgetSessionSessionBuilder startWidgetSession(String widgetId)

startWidgetSession

public static SessionService.StartWidgetSessionSessionBuilder startWidgetSession(String widgetId,
                                                                                 int expiry)

Start a session for Kaltura's flash widgets

Parameters:

widgetId -

expiry -