Package org.topbraidlive.app.framework.api.configuration

Class ManagerConfiguration

java.lang.Object

org.topbraidlive.app.framework.api.configuration.AbstractConfiguration<ManagerConfiguration>

org.topbraidlive.app.framework.api.configuration.ManagerConfiguration

public final class ManagerConfiguration
extends AbstractConfiguration<ManagerConfiguration>

Configuration returned by an app to indicate it exposes a manager (i.e., a section under the project "Manage" tab).

The fields are public and nullable in order to be compatible with JSON-B.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManagerConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field	Description
String	comment	Optional comment that describes what the manager does.
String	faIcon	Optional FontAwesome icon for the manager, such as "fa-file-excel"
String	id	Required short identifier for the manager.
boolean	inline	Optional flag that determines whether the manager should simply be a link on the manager page (the default) or whether it should open another page in an iframe in order to accept additional parameters from the user.
String	label	Required display label of the manager, such as "Example manager".
List<String>	projectTypes	Required list of project type URIs e.g., "http://teamwork.topbraidlive.org/datagraph/datagraphprojects#ProjectType" for Data Graphs.
String	src	Optional absolute or relative URL to use as the href of the manager link (inline=true manager) or the src of an iframe (inline=true manager).

Constructor Summary

Constructors

Constructor	Description
ManagerConfiguration()

Method Summary

Modifier and Type	Method	Description
static ManagerConfiguration.Builder	builder()
boolean	equals(Object o)
int	hashCode()
ManagerConfiguration	validate()	Validate the configuration.

Methods inherited from class org.topbraidlive.app.framework.api.configuration.AbstractConfiguration

validateNotNull, validateStringListNotBlank, validateStringNotBlank

Methods inherited from class java.lang.Object

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

Field Detail

comment

public String comment

Optional comment that describes what the manager does. The comment should be HTML attribute value-safe.

faIcon

public String faIcon

Optional FontAwesome icon for the manager, such as "fa-file-excel"

id

public String id

Required short identifier for the manager. Must follow identifier rules ([a-zA-Z_][a-zA-Z0-9_]*).

inline

public boolean inline

Optional flag that determines whether the manager should simply be a link on the manager page (the default) or whether it should open another page in an iframe in order to accept additional parameters from the user.

label

public String label

Required display label of the manager, such as "Example manager".

projectTypes

public List<String> projectTypes

Required list of project type URIs e.g., "http://teamwork.topbraidlive.org/datagraph/datagraphprojects#ProjectType" for Data Graphs.

src

public String src

Optional absolute or relative URL to use as the href of the manager link (inline=true manager) or the src of an iframe (inline=true manager). If not specified it will be inferred from the app base URL and the manager id. For an manager "example" on app base URL "http://localhost:8081/app-example", the inferred URL would be "http://localhost:8081/app-example/manager/example". For apps deployed to the same servlet container as the EDG server, it can be useful to specify a relative src such as "/app-example/manager/example". Then the src is independent of the host and port.

Constructor Detail

ManagerConfiguration

public ManagerConfiguration()

Method Detail

builder

public static ManagerConfiguration.Builder builder()

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

validate

public final ManagerConfiguration validate()
                                    throws InvalidConfigurationException

Description copied from class: AbstractConfiguration

Validate the configuration.

Specified by:

validate in class AbstractConfiguration<ManagerConfiguration>

Returns:

this

Throws:

InvalidConfigurationException - if the configuration is invalid