Package io.meeds.appcenter.service

Class ApplicationCenterService

java.lang.Object

io.meeds.appcenter.service.ApplicationCenterService

@Service
public class ApplicationCenterService
extends Object

A Service to access and store applications

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANY_PERMISSION
static final org.exoplatform.commons.api.settings.data.Context	APP_CENTER_CONTEXT
static final org.exoplatform.commons.api.settings.data.Scope	APP_CENTER_SCOPE
static final String	DEFAULT_ADMINISTRATORS_GROUP
static final String	DEFAULT_ADMINISTRATORS_PERMISSION
static final String	DEFAULT_APP_IMAGE_BODY
static final String	DEFAULT_APP_IMAGE_ID
static final String	DEFAULT_APP_IMAGE_NAME
static final int	DEFAULT_LIMIT
static final String	DEFAULT_USERS_GROUP
static final String	DEFAULT_USERS_PERMISSION
static final String	MAX_FAVORITE_APPS

Constructor Summary

Constructors

Constructor	Description
ApplicationCenterService()

Method Summary

Modifier and Type	Method	Description
void	addFavoriteApplication(long applicationId, String username)	Add an application, identified by its technical id, as favorite of a user
Application	createApplication(Application application)	Create new Application that will be available for all users.
Application	createApplication(Application application, String username)	Create new Application that will be available for all users.
void	deleteApplication(Long applicationId)
void	deleteApplication(Long applicationId, String username)	Delete application identified by its id and check if username has permission to delete it.
void	deleteFavoriteApplication(Long applicationId, String username)	Deletes an application identified by its id from favorite applications of user
Application	findApplication(long applicationId)	Get an application by id
ApplicationList	getActiveApplications(int offset, int limit, String keyword, String username)	Retrieves the list of applications switch offset and limit of the query, a keyword to filter on title and url of Application and the username to filter on authorized applications
Application	getApplicationByTitle(String title)
InputStream	getApplicationImageInputStream(long applicationId, String username)	Return the Application illustration InputStream, if not found, the default image InputStream will be retrieved
Long	getApplicationImageLastUpdated(long applicationId, String username)	Return the Application illustration last modifed timestamp (in ms), if not found, the default image last modifed timestamp will be retrieved
ApplicationList	getApplications(int offset, int limit, String keyword)	Retrieves the list of applications with offset, limit and a keyword that can be empty
org.exoplatform.services.security.IdentityRegistry	getIdentityRegistry()
ApplicationList	getMandatoryAndFavoriteApplicationsList(String username)	Retrieves all the list of applications for a user
long	getMaxFavoriteApps()
GeneralSettings	getSettings()
List<Application>	getSystemApplications()
ApplicationImage	setDefaultAppImage(ApplicationImage defaultAppImage)	Stores default image for applications not having an attached illustration
void	setMaxFavoriteApps(long maxFavoriteApplications)	Change general setting for maximum allowed favorites that a user can have
Application	updateApplication(Application application)
Application	updateApplication(Application application, String username)	Update an existing application on datasource.
void	updateFavoriteApplicationOrder(ApplicationOrder applicationOrder, String userName)	Update favorite applications order for a user

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ADMINISTRATORS_GROUP

public static final String DEFAULT_ADMINISTRATORS_GROUP

See Also:

• Constant Field Values

DEFAULT_ADMINISTRATORS_PERMISSION

public static final String DEFAULT_ADMINISTRATORS_PERMISSION

See Also:

• Constant Field Values

ANY_PERMISSION

public static final String ANY_PERMISSION

See Also:

• Constant Field Values

DEFAULT_USERS_GROUP

public static final String DEFAULT_USERS_GROUP

See Also:

• Constant Field Values

DEFAULT_USERS_PERMISSION

public static final String DEFAULT_USERS_PERMISSION

See Also:

• Constant Field Values

MAX_FAVORITE_APPS

public static final String MAX_FAVORITE_APPS

See Also:

• Constant Field Values

DEFAULT_APP_IMAGE_ID

public static final String DEFAULT_APP_IMAGE_ID

See Also:

• Constant Field Values

DEFAULT_APP_IMAGE_NAME

public static final String DEFAULT_APP_IMAGE_NAME

See Also:

• Constant Field Values

DEFAULT_APP_IMAGE_BODY

public static final String DEFAULT_APP_IMAGE_BODY

See Also:

• Constant Field Values

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

• Constant Field Values

APP_CENTER_CONTEXT

public static final org.exoplatform.commons.api.settings.data.Context APP_CENTER_CONTEXT

APP_CENTER_SCOPE

public static final org.exoplatform.commons.api.settings.data.Scope APP_CENTER_SCOPE

Constructor Details

ApplicationCenterService

public ApplicationCenterService()

Method Details

createApplication

public Application createApplication(Application application,
 String username)
                              throws ApplicationAlreadyExistsException,
IllegalAccessException

Create new Application that will be available for all users. If the application already exits an ApplicationAlreadyExistsException will be thrown.

Parameters:

application - application to create

username - user making the operation

Returns:

stored Application in datasource

Throws:

ApplicationAlreadyExistsException - when application already exists

IllegalAccessException - if user is not allowed to create an application

createApplication

public Application createApplication(Application application)
                              throws ApplicationAlreadyExistsException

Create new Application that will be available for all users. If the application already exits an ApplicationAlreadyExistsException will be thrown.

Parameters:

application - application to create

Returns:

stored Application in datasource

Throws:

ApplicationAlreadyExistsException - when application already exists

findApplication

public Application findApplication(long applicationId)
                            throws ApplicationNotFoundException

Get an application by id

Parameters:

applicationId - application to find

Returns:

stored Application in datasource

Throws:

ApplicationNotFoundException - when application doesn't exists

updateApplication

public Application updateApplication(Application application,
 String username)
                              throws IllegalAccessException,
ApplicationNotFoundException

Update an existing application on datasource. If the application doesn't exit an ApplicationNotFoundException will be thrown.

Parameters:

application - dto to update on store

username - username storing application

Returns:

stored Application in datasource

Throws:

IllegalAccessException - if user is not allowed to update application

ApplicationNotFoundException - if application wasn't found

updateApplication

public Application updateApplication(Application application)
                              throws ApplicationNotFoundException

Throws:

ApplicationNotFoundException

deleteApplication

public void deleteApplication(Long applicationId,
 String username)
                       throws ApplicationNotFoundException,
IllegalAccessException

Delete application identified by its id and check if username has permission to delete it.

Parameters:

applicationId - technical identifier of application

username - user currently deleting application

Throws:

IllegalAccessException - if user is not allowed to delete application

ApplicationNotFoundException - if application wasn't found

deleteApplication

public void deleteApplication(Long applicationId)
                       throws ApplicationNotFoundException

Throws:

ApplicationNotFoundException

addFavoriteApplication

public void addFavoriteApplication(long applicationId,
 String username)
                            throws ApplicationNotFoundException,
IllegalAccessException

Add an application, identified by its technical id, as favorite of a user

Parameters:

applicationId - technical application id

username - user login

Throws:

ApplicationNotFoundException - when application is not found

IllegalAccessException - if user hasn't access permission to the application

deleteFavoriteApplication

public void deleteFavoriteApplication(Long applicationId,
 String username)

Deletes an application identified by its id from favorite applications of user

Parameters:

applicationId - application technical identifier

username - login of user currently deleting application

setMaxFavoriteApps

public void setMaxFavoriteApps(long maxFavoriteApplications)

Change general setting for maximum allowed favorites that a user can have

Parameters:

maxFavoriteApplications - max favorite applications count

getMaxFavoriteApps

public long getMaxFavoriteApps()

Returns:

the maximum favorite applications that a user can have as favorite

setDefaultAppImage

public ApplicationImage setDefaultAppImage(ApplicationImage defaultAppImage)

Stores default image for applications not having an attached illustration

Parameters:

defaultAppImage - image content and name

Returns:

stored image

getSettings

public GeneralSettings getSettings()

Returns:

GeneralSettings of application including default image and maximum favorite applications count

getApplications

public ApplicationList getApplications(int offset,
 int limit,
 String keyword)

Retrieves the list of applications with offset, limit and a keyword that can be empty

Parameters:

offset - offset of the query

limit - limit of the query that can be less or equal to 0, which mean, getting all available applications

keyword - used to search in title and url

Returns:

ApplicationList that contains the list of applications

getApplicationByTitle

public Application getApplicationByTitle(String title)

getActiveApplications

public ApplicationList getActiveApplications(int offset,
 int limit,
 String keyword,
 String username)

Retrieves the list of applications switch offset and limit of the query, a keyword to filter on title and url of Application and the username to filter on authorized applications

Parameters:

offset - offset of the query

limit - limit of the query that can be less or equal to 0, which mean, getting all available applications

keyword - used to search in title and url

username - login of user to use to filter on authorized applications

Returns:

ApplicationList that contains the List of authorized UserApplication

getMandatoryAndFavoriteApplicationsList

public ApplicationList getMandatoryAndFavoriteApplicationsList(String username)

Retrieves all the list of applications for a user

Parameters:

username - login of user

Returns:

ApplicationList that contains List of UserApplication

updateFavoriteApplicationOrder

public void updateFavoriteApplicationOrder(ApplicationOrder applicationOrder,
 String userName)
                                    throws ApplicationNotFoundException

Update favorite applications order for a user

Parameters:

applicationOrder -

userName -

Throws:

ApplicationNotFoundException

getApplicationImageLastUpdated

public Long getApplicationImageLastUpdated(long applicationId,
 String username)
                                    throws ApplicationNotFoundException,
IllegalAccessException

Return the Application illustration last modifed timestamp (in ms), if not found, the default image last modifed timestamp will be retrieved

Parameters:

applicationId - technical id of application

username - login of user accessing application

Returns:

timestamp in milliseconds of last modified date of illustration

Throws:

ApplicationNotFoundException - if application wasn't found

IllegalAccessException - if user doesn't have access permission to application

getApplicationImageInputStream

public InputStream getApplicationImageInputStream(long applicationId,
 String username)
                                           throws ApplicationNotFoundException,
IllegalAccessException

Return the Application illustration InputStream, if not found, the default image InputStream will be retrieved

Parameters:

applicationId - technical id of application

username - login of user accessing application

Returns:

InputStream of application illustration

Throws:

ApplicationNotFoundException - if application wasn't found

IllegalAccessException - if user doesn't have access permission to application

getSystemApplications

public List<Application> getSystemApplications()

getIdentityRegistry

public org.exoplatform.services.security.IdentityRegistry getIdentityRegistry()