Package ch.ivyteam.ivy.application

Interface IApplicationConfigurationManager

All Superinterfaces:

ch.ivyteam.ivy.system.IConfigurationPropertyProvider, ILifecycle, ch.ivyteam.ivy.manager.IManager, ISystemPropertyProvider

public interface IApplicationConfigurationManager
extends ch.ivyteam.ivy.manager.IManager, ch.ivyteam.ivy.system.IConfigurationPropertyProvider, ISystemPropertyProvider

Class IApplicationConfigurationManager is an abstract class which is used to get to all relevant information about the state of an ivy runtime system.

Version:

1.2.2005 ReW: remove getTempDir() and setTempDir() replaced by system properties System.WorkDirectory, 30.12.2004 pk: added getTempDir() and setTempDir(..), 10.11.2003 pk: added getNumberOfSessions(), 14.4.2002 ReW added methodes for authorization and authentication, 26.2.2001 ReW changed to an abstract class which defines only the interface, 21.6.2000 ReW created

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
IApplication	createApplication(String name, String description, String fileDirectory, String ownerName, String securitySystemProviderName)	Create a new application
void	deleteApplication(String name)	Deletes a application
IApplication	findApplication(long applicationIdentifier)	Find an application by its identifier
IApplication	findApplication(String name)	Finds an application by its name
List<IApplication>	getApplications()	Returns all applications
List<IApplication>	getApplicationsSortedByName(boolean includingSystemApplication)	Returns all applications sorted by the name of the application.

Methods inherited from interface ch.ivyteam.ivy.lifecycle.ILifecycle

getName

Methods inherited from interface ch.ivyteam.ivy.application.ISystemPropertyProvider

getSystemProp, getSystemProperties, getSystemProperty, getSystemProps

Method Detail

findApplication

IApplication findApplication(String name)

Finds an application by its name

Parameters:

name - the name of the web application to find

Returns:

found application or null

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

createApplication

IApplication createApplication(String name,
                               String description,
                               String fileDirectory,
                               String ownerName,
                               String securitySystemProviderName)

Create a new application

Parameters:

name - application name

description - application description

fileDirectory - a relative Directory where the files of the web applications are stored (relative to ivy's application file area)

ownerName - The owner name

securitySystemProviderName - the name of the security system provider that is responsible for this applications user and roles

Returns:

new application object or null if app name isn't unique

Throws:

PersistencyException - if creation of application fails

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS ApplicationCreate@SYSTEM PERMISSION

deleteApplication

void deleteApplication(String name)

Deletes a application

Parameters:

name - Name of the application

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS ApplicationDelete@SYSTEM PERMISSION

getApplications

List<IApplication> getApplications()

Returns all applications

Returns:

unmodifiable list of IApplication objects

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS ApplicationReadAll@SYSTEM PERMISSION

getApplicationsSortedByName

List<IApplication> getApplicationsSortedByName(boolean includingSystemApplication)

Returns all applications sorted by the name of the application. The system application is only included in the resulting list if the parameter includingSystemApplication is true.

Parameters:

includingSystemApplication - if true the system application is included in the returned list

Returns:

unmodifiable list of IApplications objects sorted by name

Throws:

PersistencyException

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS ApplicationReadAll@SYSTEM PERMISSION

findApplication

IApplication findApplication(long applicationIdentifier)

Find an application by its identifier

Parameters:

applicationIdentifier - the identifier of the application

Returns:

Application or null

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.