public interface Application extends Identifier
Application
is a component that adds certain functionality to the platform. It owns several
Resource
s of different types. For each Application
, an own
ApplicationContext
is build, based upon the Application
's
"beans.xml".Modifier and Type | Method and Description |
---|---|
boolean |
containsBean(String beanName)
Checks whether a bean with the given name exists for this
Application . |
List<ApplicationSubject> |
getApplicationSubjects()
Returns the
ApplicationSubject s for this Application |
<T> T |
getBean(Class<T> type)
Returns the single bean of the given type, if any.
|
Object |
getBean(String beanName)
Returns the single bean with the given name, if any.
|
<T> T |
getBean(String name,
Class<T> type)
Retrieves the bean of the given name and type from the underlying
ApplicationContext , if any. |
String[] |
getBeanNames(Class<?> type)
Returns the names for all beans of the given type.
|
FeatureProvider |
getFeatureProvider()
Returns the
FeatureProvider for this Application . |
String |
getMessage(Locale locale,
String key,
Object... args)
Retrieves a message from the underlying
MessageSource . |
Set<Permission> |
getPermissions()
Returns the
Permission s for this Application . |
Properties |
getProperties()
Returns the
Properties s for this Application . |
Resources |
getResources()
the
Resources for this Application . |
Set<Resource> |
getResourceSet()
Returns the
Resource s for this Application . |
Set<Role> |
getRoles()
Returns
Role s for this Application . |
String |
getSessionParamKey(Site site)
Returns the key to retrieve the session-parameters for this
Application within the given Site
from an Environment . |
Map<String,String> |
getSessionParams(Site site,
Environment environment)
Retrieves the session-parameters for for this
Application within the given Site from the given
Environment . |
boolean |
isCoreApplication()
Deprecated.
As of appNG 2.0.0, this method will be removed. It has been renamed to
isPrivileged() . |
boolean |
isFileBased()
Returns
true if this Application is filebased, which means it's original Resource s are
stored on disk, false if the Resource s are stored in the database. |
boolean |
isHidden()
Returns
true if this Application is hidden, which means it does not appear in the navigation
menu. |
boolean |
isPrivileged()
Returns
true if this Application is a privileged application, which means it has access to the
platform's root context and the platform-scoped Environment . |
getAppNGVersion, getDisplayName, getLongDescription, getPackageVersion, getTimestamp, isInstalled, isSnapshot
getDescription, getName
getId
getVersion
Set<Permission> getPermissions()
Permission
s for this Application
.Permission
sSet<Role> getRoles()
Role
s for this Application
.Role
sResources getResources()
Resources
for this Application
.Resources
for this Application
Set<Resource> getResourceSet()
Resource
s for this Application
.Resource
sProperties getProperties()
Properties
s for this Application
.Properties
s<T> T getBean(String name, Class<T> type)
ApplicationContext
, if any.name
- the name of the bean to retrievetype
- the type of the bean to retrieveString[] getBeanNames(Class<?> type)
type
- the type to get the bean names for<T> T getBean(Class<T> type)
type
- the type of the beannull
if no such bean exists.Object getBean(String beanName)
beanName
- the name of the beannull
if no such bean exists.boolean containsBean(String beanName)
Application
.beanName
- the name of the bean to check existencetrue
if such a bean exists, false
otherwiseboolean isFileBased()
true
if this Application
is filebased, which means it's original Resource
s are
stored on disk, false
if the Resource
s are stored in the database.true
if this Application
is filebased, false
otherwiseboolean isPrivileged()
true
if this Application
is a privileged application, which means it has access to the
platform's root context and the platform-scoped Environment
.true
if this Application
is a privileged application, false
otherwise@Deprecated boolean isCoreApplication()
isPrivileged()
.true
if this Application
is a privileged application, which means it has access to the
platform's root context and the platform-scoped Environment
.true
if this Application
is a privileged application, false
otherwiseboolean isHidden()
true
if this Application
is hidden, which means it does not appear in the navigation
menu.true
if this Application
is hiddenString getMessage(Locale locale, String key, Object... args)
MessageSource
.locale
- the Locale
for the messagekey
- the message-keyargs
- the arguments for the messageResourceType.DICTIONARY
String getSessionParamKey(Site site)
Application
within the given Site
from an Environment
.site
- the Site
to retrieve the key forgetSessionParams(Site, Environment)
Map<String,String> getSessionParams(Site site, Environment environment)
Application
within the given Site
from the given
Environment
.site
- the Site
to retrieve the session parameters forenvironment
- the current Environment
Application
within the given Site
getSessionParamKey(Site)
FeatureProvider getFeatureProvider()
FeatureProvider
for this Application
.FeatureProvider
List<ApplicationSubject> getApplicationSubjects()
ApplicationSubject
s for this Application
ApplicationSubject
sCopyright © 2011–2017 aiticon GmbH. All rights reserved.