com.kaltura.client.services.SsoService 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.types.FilterPager;
import com.kaltura.client.types.Sso;
import com.kaltura.client.types.SsoFilter;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
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.
 */

public class SsoService {
	
	public static class AddSsoBuilder extends RequestBuilder {
		
		public AddSsoBuilder(Sso sso) {
			super(Sso.class, "sso_sso", "add");
			params.add("sso", sso);
		}
	}

	/**
	 * Adds a new sso configuration.
	 * 
	 * @param sso a new sso configuration
	 */
    public static AddSsoBuilder add(Sso sso)  {
		return new AddSsoBuilder(sso);
	}
	
	public static class DeleteSsoBuilder extends RequestBuilder {
		
		public DeleteSsoBuilder(int ssoId) {
			super(Sso.class, "sso_sso", "delete");
			params.add("ssoId", ssoId);
		}
		
		public void ssoId(String multirequestToken) {
			params.add("ssoId", multirequestToken);
		}
	}

	/**
	 * Delete sso by ID
	 * 
	 * @param ssoId The unique identifier in the sso's object
	 */
    public static DeleteSsoBuilder delete(int ssoId)  {
		return new DeleteSsoBuilder(ssoId);
	}
	
	public static class GetSsoBuilder extends RequestBuilder {
		
		public GetSsoBuilder(int ssoId) {
			super(Sso.class, "sso_sso", "get");
			params.add("ssoId", ssoId);
		}
		
		public void ssoId(String multirequestToken) {
			params.add("ssoId", multirequestToken);
		}
	}

	/**
	 * Retrieves sso object
	 * 
	 * @param ssoId The unique identifier in the sso's object
	 */
    public static GetSsoBuilder get(int ssoId)  {
		return new GetSsoBuilder(ssoId);
	}
	
	public static class ListSsoBuilder extends ListResponseRequestBuilder {
		
		public ListSsoBuilder(SsoFilter filter, FilterPager pager) {
			super(Sso.class, "sso_sso", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

	public static ListSsoBuilder list()  {
		return list(null);
	}

	public static ListSsoBuilder list(SsoFilter filter)  {
		return list(filter, null);
	}

	/**
	 * Lists sso objects that are associated with an account.
	 * 
	 * @param filter 
	 * @param pager A limit for the number of records to display on a page
	 */
    public static ListSsoBuilder list(SsoFilter filter, FilterPager pager)  {
		return new ListSsoBuilder(filter, pager);
	}
	
	public static class LoginSsoBuilder extends RequestBuilder {
		
		public LoginSsoBuilder(String userId, String applicationType, int partnerId) {
			super(String.class, "sso_sso", "login");
			params.add("userId", userId);
			params.add("applicationType", applicationType);
			params.add("partnerId", partnerId);
		}
		
		public void userId(String multirequestToken) {
			params.add("userId", multirequestToken);
		}
		
		public void applicationType(String multirequestToken) {
			params.add("applicationType", multirequestToken);
		}
		
		public void partnerId(String multirequestToken) {
			params.add("partnerId", multirequestToken);
		}
	}

	public static LoginSsoBuilder login(String userId, String applicationType)  {
		return login(userId, applicationType, Integer.MIN_VALUE);
	}

	/**
	 * Login with SSO, getting redirect url according to application type and partner
	  Id   or according to application type and domain
	 * 
	 * @param userId 
	 * @param applicationType 
	 * @param partnerId 
	 */
    public static LoginSsoBuilder login(String userId, String applicationType, int partnerId)  {
		return new LoginSsoBuilder(userId, applicationType, partnerId);
	}
	
	public static class UpdateSsoBuilder extends RequestBuilder {
		
		public UpdateSsoBuilder(int ssoId, Sso sso) {
			super(Sso.class, "sso_sso", "update");
			params.add("ssoId", ssoId);
			params.add("sso", sso);
		}
		
		public void ssoId(String multirequestToken) {
			params.add("ssoId", multirequestToken);
		}
	}

	/**
	 * Update sso by ID
	 * 
	 * @param ssoId The unique identifier in the sso's object
	 * @param sso Id The unique identifier in the sso's object
	 */
    public static UpdateSsoBuilder update(int ssoId, Sso sso)  {
		return new UpdateSsoBuilder(ssoId, sso);
	}
}