org.gcube.smartgears.configuration.application

Interface ApplicationConfiguration

All Known Implementing Classes:

BridgedApplicationConfiguration, DefaultApplicationConfiguration

public interface ApplicationConfiguration

The configuration of the application.

Author:

Fabio Simeoni

Method Summary

Methods

Modifier and Type	Method and Description
String	context() Returns the context path of the application
ApplicationConfiguration	context(String context) Sets the context path of the application
String	description() Returns the description of the application.
ApplicationConfiguration	description(String description) Sets the description of the application.
Set<Exclude>	excludes() Returns a set of request paths that should not be subjected to request management.
ApplicationConfiguration	excludes(Exclude... excludes)
void	merge(ApplicationConfiguration config) Merges this configuration with another configuration
Mode	mode() Returns the management mode of the application.
ApplicationConfiguration	mode(Mode mode) Sets the management mode of this application.
String	name() Returns the name of the application.
ApplicationConfiguration	name(String name) Sets the name of the application.
Persistence	persistence() Returns the persistence manager of the application.
ApplicationConfiguration	persistence(Persistence manager) Sets the persistence manager of the application.
boolean	proxied()
ApplicationConfiguration	proxied(boolean proxied) Returns true if the application is behind a proxy.
boolean	secure() Returns true if the application is secure (accessible only in https).
ApplicationConfiguration	secure(boolean value)
String	serviceClass() Returns the class of the application
ApplicationConfiguration	serviceClass(String serviceClass) Sets the class of the application.
Set<String>	startTokens() Returns the tokens in which the application operates when it first starts.
ApplicationConfiguration	startTokens(Set<String> tokens) Sets the tokens in which the application operates when it first starts.
void	validate() Validates this configuration.
String	version() Returns the version of the application.
ApplicationConfiguration	version(String version) Sets the version of the application.

Method Detail

mode

Mode mode()

Returns the management mode of the application.

Returns:

the management mode

secure

boolean secure()

Returns true if the application is secure (accessible only in https).

Returns:

secure or not

proxied

ApplicationConfiguration proxied(boolean proxied)

Returns true if the application is behind a proxy.

Returns:

secure or not

context

String context()

Returns the context path of the application

Returns:

the context path

proxied

boolean proxied()

context

ApplicationConfiguration context(String context)

Sets the context path of the application

Parameters:

context - the context path

Returns:

this configuration

mode

ApplicationConfiguration mode(Mode mode)

Sets the management mode of this application.

Parameters:

the - management mode

Returns:

this configuration

secure

ApplicationConfiguration secure(boolean value)

name

String name()

Returns the name of the application.

Returns:

the name

name

ApplicationConfiguration name(String name)

Sets the name of the application.

Parameters:

name - the name

Returns:

this configuration

serviceClass

String serviceClass()

Returns the class of the application

Returns:

the class

serviceClass

ApplicationConfiguration serviceClass(String serviceClass)

Sets the class of the application.

Parameters:

serviceClass - the class

Returns:

this configuration

version

String version()

Returns the version of the application.

Returns:

the version

version

ApplicationConfiguration version(String version)

Sets the version of the application.

Parameters:

version - the version

Returns:

this configuration

description

String description()

Returns the description of the application.

Returns:

the description

description

ApplicationConfiguration description(String description)

Sets the description of the application.

Parameters:

description - the description

Returns:

this configuration

startTokens

Set<String> startTokens()

Returns the tokens in which the application operates when it first starts.

Returns:

the tokens

startTokens

ApplicationConfiguration startTokens(Set<String> tokens)

Sets the tokens in which the application operates when it first starts.

Parameters:

scopes - the scopes

Returns:

this configuration

persistence

Persistence persistence()

Returns the persistence manager of the application.

Returns:

the manager

excludes

Set<Exclude> excludes()

Returns a set of request paths that should not be subjected to request management.

Returns:

the set of exclude paths.

persistence

ApplicationConfiguration persistence(Persistence manager)

Sets the persistence manager of the application.

Parameters:

manager - the manager

Returns:

this configuration

validate

void validate()

Validates this configuration.

Throws:

IllegalStateException - if the configuration is not valid

merge

void merge(ApplicationConfiguration config)

Merges this configuration with another configuration

Parameters:

config - the other configuration

excludes

ApplicationConfiguration excludes(Exclude... excludes)