org.appng.core.service

Class CoreService

java.lang.Object

org.appng.core.service.CoreService

@Transactional(rollbackFor=BusinessException.class)
public class CoreService
extends Object

A service implementing the core business logic for creation/retrieval/removal of business-objects.

Author:

Matthias Müller, Matthias Herlitzius

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationRepository	applicationRepository
protected DatabaseConnectionRepository	databaseConnectionRepository
protected DatabaseService	databaseService
protected GroupRepository	groupRepository
protected LdapService	ldapService
protected PermissionRepository	permissionRepository
protected PropertyRepository	propertyRepository
protected RepoRepository	repoRepository
protected ResourceRepository	resourceRepository
protected RoleRepository	roleRepository
protected SiteApplicationRepository	siteApplicationRepository
protected SiteRepository	siteRepository
protected SubjectRepository	subjectRepository
protected TemplateService	templateService

Constructor Summary

Constructors

Constructor and Description
CoreService()

Method Summary

Modifier and Type	Method and Description
void	addApplicationRolesToGroup(String groupName, String applicationName, List<String> applicationRoleNames, boolean clear)
void	addGroupsToSubject(String userName, List<String> groupNames, boolean clear)
int	addPermissions(String applicationName, String roleName, List<String> permissionNames)
MigrationService.MigrationStatus	assignApplicationToSite(SiteImpl site, Application application, boolean createProperties)
protected void	assignGroupsToSubject(Integer subjectId, List<Integer> groupIds, boolean clear)
protected void	assignRolesToGroup(Group group, Site site, List<Integer> applicationRoleIds)
protected boolean	checkPropertyExists(Integer siteId, Integer applicationId, PropertyImpl property)
void	clearCache(Integer siteId)
void	clearCacheStatistics(Integer siteId)
protected DatabaseConnection	createDatabaseConnection(DatabaseConnection databaseConnection, boolean managed)
GroupImpl	createGroup(GroupImpl group)
void	createProperty(Integer siteId, Integer applicationId, PropertyImpl property)
RepositoryImpl	createRepository(RepositoryImpl repository)
void	createSite(SiteImpl site)
protected void	createSite(SiteImpl site, Environment environment)
Subject	createSubject(SubjectImpl subject)
protected void	deleteApplication(Environment environment, Request request, Integer applicationId, FieldProcessor fp, String applicationDeleteErrorWithCause, String applicationRemovedFromSite, String applicationErrorInvalid, String applicationroleDeleteError, String applicationroleErrorInvalid)
void	deleteApplication(String applicationName, FieldProcessor fp) Deletes a Application via the Command Line Interface.
void	deleteApplicationRepository(Repository repository)
void	deleteGroup(GroupImpl group)
protected void	deletePackageVersion(Integer repositoryId, String packageName, String packageVersion, String packageTimestamp)
void	deletePermission(Permission permission)
void	deleteProperty(PropertyImpl prop)
protected String	deleteResource(Environment env, Integer applicationId, Integer resourceId)
protected void	deleteRole(Integer roleId, String roleDeleteError, String roleErrorInvalid) Deletes a ApplicationRole
void	deleteRole(Role role)
protected void	deleteSite(Environment env, SiteImpl site, FieldProcessor fp, Request request, String siteAliasDeleted, String siteDeleteError)
void	deleteSite(String name, FieldProcessor fp)
void	deleteSubject(Subject subject)
Integer	deleteTemplate(String name) Deletes a Template
void	expireCacheElement(Integer siteId, String cacheElement)
int	expireCacheElementsStartingWith(Integer siteId, String cacheElementPrefix)
AccessibleApplication	findApplicationByName(String name)
String	forgotPassword(AuthSubject subject)
File	getApplicationFolder(Environment env, String applicationName)
Application	getApplicationForConnection(DatabaseConnection dbc)
List<RepositoryImpl>	getApplicationRepositories()
Repository	getApplicationRepositoryByName(String repositoryName)
Role	getApplicationRoleForApplication(Integer applicationId, String roleName)
RoleImpl	getApplicationRoleForApplication(String applicationName, String roleName)
List<RoleImpl>	getApplicationRoles()
List<RoleImpl>	getApplicationRolesForApplication(Integer applicationId)
protected File	getApplicationRootFolder(Environment environment)
List<ApplicationImpl>	getApplications()
Collection<ApplicationSubject>	getApplicationSubjects(Integer applicationId, Site site)
List<AppngCache>	getCacheEntries(Integer siteId)
Map<String,String>	getCacheStatistics(Integer siteId)
DatabaseConnection	getDatabaseConnection(Integer dcId, boolean clearPassword)
DatabaseConnection	getDatabaseConnection(SiteImpl site, ApplicationImpl application)
org.springframework.data.domain.Page<DatabaseConnection>	getDatabaseConnections(Integer siteId, FieldProcessor fp)
List<DatabaseConnection>	getDatabaseConnectionsForSite(Integer siteId)
PasswordHandler	getDefaultPasswordHandler(AuthSubject authSubject) Returns the default password manager which should be used to handle all passwords.
Site	getGrantingSite(String grantedSite, String grantedApplication)
GroupImpl	getGroupByName(String name)
GroupImpl	getGroupByName(String name, boolean init)
List<? extends Group>	getGroups()
PasswordHandler	getPasswordHandler(AuthSubject authSubject) Returns a PasswordHandler which is able to handle the password of a given AuthSubject.
PermissionImpl	getPermission(String application, String name)
List<? extends Permission>	getPermissionsForApplication(Integer applicationId)
protected Properties	getPlatformConfig(Environment environment)
PropertyHolder	getPlatformProperties()
protected org.springframework.data.domain.Page<PropertyImpl>	getProperties(Integer siteId, Integer applicationId)
protected org.springframework.data.domain.Page<PropertyImpl>	getProperties(Integer siteId, Integer applicationId, org.springframework.data.domain.Pageable pageable)
org.springframework.data.domain.Page<PropertyImpl>	getProperties(String siteName, String applicationName)
org.springframework.data.domain.Page<PropertyImpl>	getProperties(String siteName, String applicationName, org.springframework.data.domain.Pageable pageable)
PropertyImpl	getProperty(String propertyId)
protected Resources	getResources(Application application, File applicationCacheFolder, File applicationRootFolder)
SiteImpl	getSite(Integer id)
SiteApplication	getSiteApplication(String site, String application)
SiteApplication	getSiteApplicationWithGrantedSites(String site, String application)
SiteImpl	getSiteByName(String name)
List<SiteImpl>	getSites()
Subject	getSubjectByEmail(String email)
Subject	getSubjectById(Integer id, boolean initialize)
SubjectImpl	getSubjectByName(String name, boolean initialize)
List<SubjectImpl>	getSubjects()
List<SubjectImpl>	getSubjectsByType(UserType type)
SiteApplication	grantApplicationForSites(String site, String application, List<String> siteNames)
PropertyHolder	initPlatformConfig(Properties defaultOverrides, String rootPath, Boolean devMode, boolean persist, boolean finalize)
RoleImpl	initRole(RoleImpl role)
protected void	initSiteProperties(SiteImpl site)
PackageInfo	installPackage(Integer repositoryId, String name, String version, String timestamp, boolean isPrivileged, boolean isHidden, boolean isFileBased)
PackageInfo	installPackage(Integer repositoryId, String name, String version, String timestamp, boolean isPrivileged, boolean isHidden, boolean isFileBased, FieldProcessor fp)
boolean	isValidPassword(AuthSubject authSubject, String password)
boolean	login(Environment env, Principal principal)
boolean	login(Environment env, String digest, int digestMaxValidity)
boolean	login(Site site, Environment env, String username, String password)
boolean	loginGroup(Environment env, AuthSubject authSubject, String password, Integer groupId)
void	logoutSubject(Environment env)
Template	provideTemplate(Integer repositoryId, String templateName, String templateVersion, String templateTimestamp)
protected void	reloadRepository(Integer repositoryId)
int	removePermissions(String applicationName, String roleName, List<String> permissionNames)
void	resetConnection(FieldProcessor fp, Integer conId)
byte[]	resetPassword(AuthSubject authSubject, PasswordPolicy passwordPolicy, String email, String hash)
Subject	restoreSubject(String name)
PermissionImpl	savePermission(PermissionImpl p)
PropertyImpl	saveProperty(PropertyImpl property)
void	saveRepository(RepositoryImpl repo)
void	saveRole(RoleImpl role)
void	saveSite(SiteImpl site)
void	setSiteActive(String name, boolean active)
void	setSiteStartUpTime(SiteImpl site, Date date)
protected void	shutdownSite(Environment env, String siteName)
protected void	synchronizeApplicationResources(Environment env, Application application, boolean isFileBased)
MigrationService.MigrationStatus	unlinkApplicationFromSite(Integer siteId, Integer applicationId)
protected MigrationService.MigrationStatus	unlinkApplicationFromSite(SiteApplication siteApplication)
void	unsetReloadRequired(SiteApplication siteApplication)
void	updateApplication(ApplicationImpl application, boolean isFileBased)
void	updateGroup(GroupImpl group)
Boolean	updatePassword(char[] password, char[] passwordConfirmation, SubjectImpl currentSubject)
void	updateSubject(SubjectImpl subject)
protected void	writeApplicationResources(Application application, boolean fileBased, File outputDir, Collection<Resource> resources)

Methods inherited from class java.lang.Object

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

Field Detail

databaseConnectionRepository

@Autowired
protected DatabaseConnectionRepository databaseConnectionRepository

siteApplicationRepository

@Autowired
protected SiteApplicationRepository siteApplicationRepository

groupRepository

@Autowired
protected GroupRepository groupRepository

siteRepository

@Autowired
protected SiteRepository siteRepository

applicationRepository

@Autowired
protected ApplicationRepository applicationRepository

subjectRepository

@Autowired
protected SubjectRepository subjectRepository

propertyRepository

@Autowired
protected PropertyRepository propertyRepository

permissionRepository

@Autowired
protected PermissionRepository permissionRepository

roleRepository

@Autowired
protected RoleRepository roleRepository

repoRepository

@Autowired
protected RepoRepository repoRepository

resourceRepository

@Autowired
protected ResourceRepository resourceRepository

databaseService

@Autowired
protected DatabaseService databaseService

ldapService

@Autowired
protected LdapService ldapService

templateService

@Autowired
protected TemplateService templateService

Constructor Detail

CoreService

public CoreService()

Method Detail

createSubject

public Subject createSubject(SubjectImpl subject)

getPlatformProperties

public PropertyHolder getPlatformProperties()

initPlatformConfig

public PropertyHolder initPlatformConfig(Properties defaultOverrides,
                                         String rootPath,
                                         Boolean devMode,
                                         boolean persist,
                                         boolean finalize)

getProperties

public org.springframework.data.domain.Page<PropertyImpl> getProperties(String siteName,
                                                                        String applicationName)

getProperties

public org.springframework.data.domain.Page<PropertyImpl> getProperties(String siteName,
                                                                        String applicationName,
                                                                        org.springframework.data.domain.Pageable pageable)

getProperties

protected org.springframework.data.domain.Page<PropertyImpl> getProperties(Integer siteId,
                                                                           Integer applicationId)

getProperties

protected org.springframework.data.domain.Page<PropertyImpl> getProperties(Integer siteId,
                                                                           Integer applicationId,
                                                                           org.springframework.data.domain.Pageable pageable)

createProperty

public void createProperty(Integer siteId,
                           Integer applicationId,
                           PropertyImpl property)

checkPropertyExists

protected boolean checkPropertyExists(Integer siteId,
                                      Integer applicationId,
                                      PropertyImpl property)

getSite

public SiteImpl getSite(Integer id)

getSiteByName

public SiteImpl getSiteByName(String name)

saveSite

public void saveSite(SiteImpl site)

saveProperty

public PropertyImpl saveProperty(PropertyImpl property)

getSubjectsByType

public List<SubjectImpl> getSubjectsByType(UserType type)

isValidPassword

public boolean isValidPassword(AuthSubject authSubject,
                               String password)

getPasswordHandler

public PasswordHandler getPasswordHandler(AuthSubject authSubject)

Returns a PasswordHandler which is able to handle the password of a given AuthSubject. This is only relevant if Subjects exist which still use passwords hashed with an older PasswordHandler. This method may be removed in the future.

Parameters:

authSubject - The AuthSubject which is used to initialize the PasswordHandler and to determine which implementation of the PasswordHandler interface will be returned.

Returns:

the PasswordHandler for the AuthSubject

getDefaultPasswordHandler

public PasswordHandler getDefaultPasswordHandler(AuthSubject authSubject)

Returns the default password manager which should be used to handle all passwords.

Parameters:

authSubject - The AuthSubject which is used for initializing the PasswordHandler.

Returns:

the default PasswordHandler for the AuthSubject

restoreSubject

public Subject restoreSubject(String name)

login

public boolean login(Environment env,
                     Principal principal)

login

public boolean login(Environment env,
                     String digest,
                     int digestMaxValidity)

login

public boolean login(Site site,
                     Environment env,
                     String username,
                     String password)

loginGroup

public boolean loginGroup(Environment env,
                          AuthSubject authSubject,
                          String password,
                          Integer groupId)

logoutSubject

public void logoutSubject(Environment env)

getProperty

public PropertyImpl getProperty(String propertyId)

createSite

protected void createSite(SiteImpl site,
                          Environment environment)

createSite

public void createSite(SiteImpl site)

initSiteProperties

protected void initSiteProperties(SiteImpl site)

assignApplicationToSite

public MigrationService.MigrationStatus assignApplicationToSite(SiteImpl site,
                                                                Application application,
                                                                boolean createProperties)

getPermission

public PermissionImpl getPermission(String application,
                                    String name)

savePermission

public PermissionImpl savePermission(PermissionImpl p)

createRepository

public RepositoryImpl createRepository(RepositoryImpl repository)

installPackage

public PackageInfo installPackage(Integer repositoryId,
                                  String name,
                                  String version,
                                  String timestamp,
                                  boolean isPrivileged,
                                  boolean isHidden,
                                  boolean isFileBased,
                                  FieldProcessor fp)
                           throws BusinessException

Throws:

BusinessException

installPackage

public PackageInfo installPackage(Integer repositoryId,
                                  String name,
                                  String version,
                                  String timestamp,
                                  boolean isPrivileged,
                                  boolean isHidden,
                                  boolean isFileBased)
                           throws BusinessException

Throws:

BusinessException

provideTemplate

public Template provideTemplate(Integer repositoryId,
                                String templateName,
                                String templateVersion,
                                String templateTimestamp)
                         throws BusinessException

Throws:

BusinessException

deleteTemplate

public Integer deleteTemplate(String name)

Deletes a Template

Parameters:

name - the name of the template to delete

Returns:

• 0 - if everything went OK
• -1 - if no such template exists
• -2 - if the template is still in use

deletePackageVersion

protected void deletePackageVersion(Integer repositoryId,
                                    String packageName,
                                    String packageVersion,
                                    String packageTimestamp)
                             throws BusinessException

Throws:

BusinessException

reloadRepository

protected void reloadRepository(Integer repositoryId)
                         throws BusinessException

Throws:

BusinessException

writeApplicationResources

protected void writeApplicationResources(Application application,
                                         boolean fileBased,
                                         File outputDir,
                                         Collection<Resource> resources)
                                  throws BusinessException

Throws:

BusinessException

getApplicationRootFolder

protected File getApplicationRootFolder(Environment environment)

getApplicationFolder

public File getApplicationFolder(Environment env,
                                 String applicationName)

getPlatformConfig

protected Properties getPlatformConfig(Environment environment)

deleteResource

protected String deleteResource(Environment env,
                                Integer applicationId,
                                Integer resourceId)
                         throws BusinessException

Throws:

BusinessException

synchronizeApplicationResources

protected void synchronizeApplicationResources(Environment env,
                                               Application application,
                                               boolean isFileBased)
                                        throws BusinessException

Throws:

BusinessException

resetPassword

public byte[] resetPassword(AuthSubject authSubject,
                            PasswordPolicy passwordPolicy,
                            String email,
                            String hash)

forgotPassword

public String forgotPassword(AuthSubject subject)
                      throws BusinessException

Throws:

BusinessException

updateSubject

public void updateSubject(SubjectImpl subject)

findApplicationByName

public AccessibleApplication findApplicationByName(String name)

updateApplication

public void updateApplication(ApplicationImpl application,
                              boolean isFileBased)
                       throws BusinessException

Throws:

BusinessException

getGroups

public List<? extends Group> getGroups()

deleteSite

public void deleteSite(String name,
                       FieldProcessor fp)
                throws BusinessException

Throws:

BusinessException

setSiteActive

public void setSiteActive(String name,
                          boolean active)
                   throws BusinessException

Throws:

BusinessException

deleteSite

protected void deleteSite(Environment env,
                          SiteImpl site,
                          FieldProcessor fp,
                          Request request,
                          String siteAliasDeleted,
                          String siteDeleteError)
                   throws BusinessException

Throws:

BusinessException

deleteProperty

public void deleteProperty(PropertyImpl prop)

unlinkApplicationFromSite

protected MigrationService.MigrationStatus unlinkApplicationFromSite(SiteApplication siteApplication)

unlinkApplicationFromSite

@Transactional(propagation=REQUIRES_NEW)
public MigrationService.MigrationStatus unlinkApplicationFromSite(Integer siteId,
                                                                                                           Integer applicationId)

saveRole

public void saveRole(RoleImpl role)

deleteRole

public void deleteRole(Role role)
                throws BusinessException

Throws:

BusinessException

deleteRole

protected void deleteRole(Integer roleId,
                          String roleDeleteError,
                          String roleErrorInvalid)
                   throws BusinessException

Deletes a ApplicationRole

Throws:

BusinessException

deleteApplication

public void deleteApplication(String applicationName,
                              FieldProcessor fp)
                       throws BusinessException

Deletes a Application via the Command Line Interface.

Throws:

BusinessException

deleteApplication

protected void deleteApplication(Environment environment,
                                 Request request,
                                 Integer applicationId,
                                 FieldProcessor fp,
                                 String applicationDeleteErrorWithCause,
                                 String applicationRemovedFromSite,
                                 String applicationErrorInvalid,
                                 String applicationroleDeleteError,
                                 String applicationroleErrorInvalid)
                          throws BusinessException

Throws:

BusinessException

deletePermission

public void deletePermission(Permission permission)

assignRolesToGroup

protected void assignRolesToGroup(Group group,
                                  Site site,
                                  List<Integer> applicationRoleIds)

addApplicationRolesToGroup

public void addApplicationRolesToGroup(String groupName,
                                       String applicationName,
                                       List<String> applicationRoleNames,
                                       boolean clear)

assignGroupsToSubject

protected void assignGroupsToSubject(Integer subjectId,
                                     List<Integer> groupIds,
                                     boolean clear)

addGroupsToSubject

public void addGroupsToSubject(String userName,
                               List<String> groupNames,
                               boolean clear)
                        throws BusinessException

Throws:

BusinessException

getDatabaseConnectionsForSite

public List<DatabaseConnection> getDatabaseConnectionsForSite(Integer siteId)

getDatabaseConnections

public org.springframework.data.domain.Page<DatabaseConnection> getDatabaseConnections(Integer siteId,
                                                                                       FieldProcessor fp)

getDatabaseConnection

public DatabaseConnection getDatabaseConnection(Integer dcId,
                                                boolean clearPassword)

createDatabaseConnection

protected DatabaseConnection createDatabaseConnection(DatabaseConnection databaseConnection,
                                                      boolean managed)

getResources

protected Resources getResources(Application application,
                                 File applicationCacheFolder,
                                 File applicationRootFolder)
                          throws InvalidConfigurationException

Throws:

InvalidConfigurationException

updatePassword

public Boolean updatePassword(char[] password,
                              char[] passwordConfirmation,
                              SubjectImpl currentSubject)
                       throws BusinessException

Throws:

BusinessException

resetConnection

public void resetConnection(FieldProcessor fp,
                            Integer conId)

createGroup

public GroupImpl createGroup(GroupImpl group)

deleteGroup

public void deleteGroup(GroupImpl group)

deleteApplicationRepository

public void deleteApplicationRepository(Repository repository)

deleteSubject

public void deleteSubject(Subject subject)

shutdownSite

protected void shutdownSite(Environment env,
                            String siteName)

unsetReloadRequired

public void unsetReloadRequired(SiteApplication siteApplication)

setSiteStartUpTime

public void setSiteStartUpTime(SiteImpl site,
                               Date date)

getApplicationSubjects

public Collection<ApplicationSubject> getApplicationSubjects(Integer applicationId,
                                                             Site site)

getSubjectByName

public SubjectImpl getSubjectByName(String name,
                                    boolean initialize)

getSubjectById

public Subject getSubjectById(Integer id,
                              boolean initialize)

getApplicationRepositoryByName

public Repository getApplicationRepositoryByName(String repositoryName)

saveRepository

public void saveRepository(RepositoryImpl repo)

getApplications

public List<ApplicationImpl> getApplications()

getApplicationRolesForApplication

public List<RoleImpl> getApplicationRolesForApplication(Integer applicationId)

getApplicationRoles

public List<RoleImpl> getApplicationRoles()

getApplicationRepositories

public List<RepositoryImpl> getApplicationRepositories()

getSites

public List<SiteImpl> getSites()

getSubjects

public List<SubjectImpl> getSubjects()

getGroupByName

public GroupImpl getGroupByName(String name)

getGroupByName

public GroupImpl getGroupByName(String name,
                                boolean init)

updateGroup

public void updateGroup(GroupImpl group)

getSubjectByEmail

public Subject getSubjectByEmail(String email)

addPermissions

public int addPermissions(String applicationName,
                          String roleName,
                          List<String> permissionNames)
                   throws BusinessException

Throws:

BusinessException

removePermissions

public int removePermissions(String applicationName,
                             String roleName,
                             List<String> permissionNames)
                      throws BusinessException

Throws:

BusinessException

getApplicationRoleForApplication

public Role getApplicationRoleForApplication(Integer applicationId,
                                             String roleName)

getApplicationRoleForApplication

public RoleImpl getApplicationRoleForApplication(String applicationName,
                                                 String roleName)

initRole

public RoleImpl initRole(RoleImpl role)

getPermissionsForApplication

public List<? extends Permission> getPermissionsForApplication(Integer applicationId)

getGrantingSite

public Site getGrantingSite(String grantedSite,
                            String grantedApplication)

getCacheStatistics

public Map<String,String> getCacheStatistics(Integer siteId)

getCacheEntries

public List<AppngCache> getCacheEntries(Integer siteId)

expireCacheElement

public void expireCacheElement(Integer siteId,
                               String cacheElement)
                        throws BusinessException

Throws:

BusinessException

expireCacheElementsStartingWith

public int expireCacheElementsStartingWith(Integer siteId,
                                           String cacheElementPrefix)
                                    throws BusinessException

Throws:

BusinessException

clearCacheStatistics

public void clearCacheStatistics(Integer siteId)

clearCache

public void clearCache(Integer siteId)

getApplicationForConnection

public Application getApplicationForConnection(DatabaseConnection dbc)

getDatabaseConnection

public DatabaseConnection getDatabaseConnection(SiteImpl site,
                                                ApplicationImpl application)

getSiteApplication

public SiteApplication getSiteApplication(String site,
                                          String application)

getSiteApplicationWithGrantedSites

public SiteApplication getSiteApplicationWithGrantedSites(String site,
                                                          String application)

grantApplicationForSites

public SiteApplication grantApplicationForSites(String site,
                                                String application,
                                                List<String> siteNames)