Package com.symphony.bdk.core.service.application

Class ApplicationService

java.lang.Object

com.symphony.bdk.core.service.application.ApplicationService

@API(status=STABLE)
public class ApplicationService
extends Object

Service class for managing the applications and the application entitlements.

This services used for retrieving information about a particular application or application entitlements, performing some actions related to the applications like:

• Create an application
• Update an existing application
• Delete an existing application
• Get the information of an existing application
• Update application entitlements
• Update user applications

Constructor Summary

Constructors

Constructor	Description
ApplicationService(ApplicationApi applicationApi, AppEntitlementApi appEntitlementApi, AuthSession authSession, RetryWithRecoveryBuilder<?> retryBuilder)

Method Summary

Modifier and Type	Method	Description
ApplicationDetail	createApplication(ApplicationDetail applicationDetail)	Create a new application.
void	deleteApplication(String appId)	Delete an existing application.
ApplicationDetail	getApplication(String appId)	Gets an existing application.
List<PodAppEntitlement>	listApplicationEntitlements()	Get the list of application entitlements for the company.
List<UserAppEntitlement>	listUserApplications(Long userId)	Get the list of Symphony application entitlements for a particular user.
List<UserAppEntitlement>	patchUserApplications(Long userId, List<UserAppEntitlementPatch> userAppEntitlementPatchList)	Updates particular app entitlements for a particular user.
ApplicationDetail	updateApplication(String appId, ApplicationDetail applicationDetail)	Update an existing application.
List<PodAppEntitlement>	updateApplicationEntitlements(List<PodAppEntitlement> entitlementList)	Update the list of application entitlements for the company.
List<UserAppEntitlement>	updateUserApplications(Long userId, List<UserAppEntitlement> userAppEntitlementList)	Updates all application entitlements for a particular user.

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationService

public ApplicationService(ApplicationApi applicationApi,
 AppEntitlementApi appEntitlementApi,
 AuthSession authSession,
 RetryWithRecoveryBuilder<?> retryBuilder)

Method Details

createApplication

public ApplicationDetail createApplication(@Nonnull
 ApplicationDetail applicationDetail)

Create a new application.

Parameters:

applicationDetail - Contains the following fields for creating an application: appId, name, appUrl, domain, and publisher. Note that appUrl is not required.

Returns:

The created application.

See Also:

• Create Application
• Create Application with an RSA Public Key

updateApplication

public ApplicationDetail updateApplication(@Nonnull
 String appId,
 @Nonnull
 ApplicationDetail applicationDetail)

Update an existing application.

Parameters:

appId - Id of the application needs to be updated.

applicationDetail - Contains the following fields for creating an application: appId, name, appUrl, domain, and publisher. Note that appUrl is not required.

Returns:

The updated application.

See Also:

• Update Application
• Update Application with an RSA Public Key

deleteApplication

public void deleteApplication(@Nonnull
 String appId)

Delete an existing application.

Parameters:

appId - Id of the application needs to be deleted.

See Also:

• Delete Application

getApplication

public ApplicationDetail getApplication(@Nonnull
 String appId)

Gets an existing application.

Parameters:

appId - Id of the application.

Returns:

The detail of the lookup application.

See Also:

• Get Application

listApplicationEntitlements

public List<PodAppEntitlement> listApplicationEntitlements()

Get the list of application entitlements for the company.

Returns:

The list of application entitlements.

See Also:

• List App Entitlements

updateApplicationEntitlements

public List<PodAppEntitlement> updateApplicationEntitlements(@Nonnull
 List<PodAppEntitlement> entitlementList)

Update the list of application entitlements for the company.

Parameters:

entitlementList - The list of entitlements to be updated by.

Returns:

The updated list of entitlements.

See Also:

• Update App Entitlements

listUserApplications

public List<UserAppEntitlement> listUserApplications(@Nonnull
 Long userId)

Get the list of Symphony application entitlements for a particular user.

Parameters:

userId - User id.

Returns:

The list of Symphony application entitlements for this user.

See Also:

• User Apps

updateUserApplications

public List<UserAppEntitlement> updateUserApplications(@Nonnull
 Long userId,
 @Nonnull
 List<UserAppEntitlement> userAppEntitlementList)

Updates all application entitlements for a particular user.

Parameters:

userId - User Id.

userAppEntitlementList - The list of App Entitlements needs to be updated.

Returns:

The updated list of Symphony application entitlements for this user.

See Also:

• Update All User Apps

patchUserApplications

public List<UserAppEntitlement> patchUserApplications(@Nonnull
 Long userId,
 @Nonnull
 List<UserAppEntitlementPatch> userAppEntitlementPatchList)

Updates particular app entitlements for a particular user. Supports partial update.

Parameters:

userId - User Id.

userAppEntitlementPatchList - The list of App Entitlements needs to be updated.

Returns:

The updated list of Symphony application entitlements for this user.

See Also:

• Update User Apps