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 java.lang.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 and Description
ApplicationService(ApplicationApi applicationApi, AppEntitlementApi appEntitlementApi, AuthSession authSession, RetryWithRecoveryBuilder<?> retryBuilder)

Method Summary

Modifier and Type	Method and Description
ApplicationDetail	createApplication(ApplicationDetail applicationDetail) Create a new application.
void	deleteApplication(java.lang.String appId) Delete an existing application.
ApplicationDetail	getApplication(java.lang.String appId) Gets an existing application.
java.util.List<PodAppEntitlement>	listApplicationEntitlements() Get the list of application entitlements for the company.
java.util.List<UserAppEntitlement>	listUserApplications(java.lang.Long userId) Get the list of Symphony application entitlements for a particular user.
ApplicationDetail	updateApplication(java.lang.String appId, ApplicationDetail applicationDetail) Update an existing application.
java.util.List<PodAppEntitlement>	updateApplicationEntitlements(java.util.List<PodAppEntitlement> entitlementList) Update the list of application entitlements for the company.
java.util.List<UserAppEntitlement>	updateUserApplications(java.lang.Long userId, java.util.List<UserAppEntitlement> userAppEntitlementList) Update the 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 Detail

ApplicationService

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

Method Detail

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
                                           java.lang.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
                              java.lang.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
                                        java.lang.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 java.util.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 java.util.List<PodAppEntitlement> updateApplicationEntitlements(@Nonnull
                                                                       java.util.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 java.util.List<UserAppEntitlement> listUserApplications(@Nonnull
                                                               java.lang.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 java.util.List<UserAppEntitlement> updateUserApplications(@Nonnull
                                                                 java.lang.Long userId,
                                                                 @Nonnull
                                                                 java.util.List<UserAppEntitlement> userAppEntitlementList)

Update the 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 User Apps