Package com.sun.enterprise.config.serverbeans

Interface Application

All Superinterfaces:

org.glassfish.api.admin.config.ApplicationName, org.jvnet.hk2.config.ConfigBeanProxy, jakarta.validation.Payload, org.jvnet.hk2.config.types.PropertyBag

public interface Application
extends org.glassfish.api.admin.config.ApplicationName, org.jvnet.hk2.config.types.PropertyBag

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Application.Duck

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALT_DD_LOCATION_PROP_NAME
static String	APP_LOCATION_PROP_NAME
static String	ARCHIVE_TYPE_PROP_NAME
static String	DEPLOYMENT_PLAN_LOCATION_PROP_NAME
static String	RUNTIME_ALT_DD_LOCATION_PROP_NAME

Fields inherited from interface org.glassfish.api.admin.config.ApplicationName

NAME_APP_REGEX

Method Summary

Modifier and Type	Method	Description
File	application()
String	archiveType()
boolean	containsSnifferType(String snifferType)
File	deploymentPlan()
AppTenants	getAppTenants()
String	getAsyncReplication()	Gets the value of the asyncReplication property.
String	getAvailabilityEnabled()	Gets the value of the availabilityEnabled property.
String	getContextRoot()	Gets the value of the contextRoot property.
String	getDeploymentOrder()	Gets the value of the deploymentOrder property.
org.glassfish.api.deployment.DeployCommandParameters	getDeployParameters(ApplicationRef appRef)
Properties	getDeployProperties()
String	getDescription()	Gets the value of the description property.
String	getDirectoryDeployed()	Gets the value of the directoryDeployed property.
String	getEnabled()	Gets the value of the enabled property.
List<Engine>	getEngine()	Gets the value of the engine property.
<T extends ApplicationExtension> T	getExtensionByType(Class<T> type)
List<ApplicationExtension>	getExtensions()
<T extends ApplicationExtension> List<T>	getExtensionsByType(Class<T> type)
String	getLibraries()	Gets the value of the libraries property.
String	getLocation()	Gets the value of the location property.
List<Module>	getModule()
Module	getModule(String moduleName)
Map<String,Properties>	getModulePropertiesMap()
@NotNull String	getObjectType()	Gets the value of the objectType property.
List<org.jvnet.hk2.config.types.Property>	getProperty()	Properties as per PropertyBag
Resources	getResources()
boolean	isLifecycleModule()
boolean	isStandaloneModule()
void	recordFileLocations(File app, File plan)
void	setAppTenants(AppTenants appTenants)
void	setAsyncReplication(String value)	Sets the value of the asyncReplication property.
void	setAvailabilityEnabled(String value)	Sets the value of the availabilityEnabled property.
void	setContextRoot(String value)	Sets the value of the contextRoot property.
void	setDeploymentOrder(String value)	Sets the value of the deploymentOrder property.
void	setDescription(String value)	Sets the value of the description property.
void	setDirectoryDeployed(String value)	Sets the value of the directoryDeployed property.
void	setEnabled(String value)	Sets the value of the enabled property.
void	setLibraries(String value)	Sets the value of the libraries property.
void	setLocation(String value)	Sets the value of the location property.
void	setObjectType(String value)	Sets the value of the objectType property.
void	setResources(Resources resources)

Methods inherited from interface org.glassfish.api.admin.config.ApplicationName

getName, setName

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

Field Detail

APP_LOCATION_PROP_NAME

static final String APP_LOCATION_PROP_NAME

See Also:

Constant Field Values

DEPLOYMENT_PLAN_LOCATION_PROP_NAME

static final String DEPLOYMENT_PLAN_LOCATION_PROP_NAME

See Also:

Constant Field Values

ARCHIVE_TYPE_PROP_NAME

static final String ARCHIVE_TYPE_PROP_NAME

See Also:

Constant Field Values

ALT_DD_LOCATION_PROP_NAME

static final String ALT_DD_LOCATION_PROP_NAME

See Also:

Constant Field Values

RUNTIME_ALT_DD_LOCATION_PROP_NAME

static final String RUNTIME_ALT_DD_LOCATION_PROP_NAME

See Also:

Constant Field Values

Method Detail

getContextRoot

String getContextRoot()

Gets the value of the contextRoot property.

Returns:

possible object is String

setContextRoot

void setContextRoot(String value)
             throws PropertyVetoException

Sets the value of the contextRoot property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLocation

String getLocation()

Gets the value of the location property.

Returns:

possible object is String

setLocation

void setLocation(String value)
          throws PropertyVetoException

Sets the value of the location property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getObjectType

@NotNull
@NotNull String getObjectType()

Gets the value of the objectType property.

Returns:

possible object is String

setObjectType

void setObjectType(String value)
            throws PropertyVetoException

Sets the value of the objectType property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getEnabled

String getEnabled()

Gets the value of the enabled property.

Returns:

possible object is String

setEnabled

void setEnabled(String value)
         throws PropertyVetoException

Sets the value of the enabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLibraries

String getLibraries()

Gets the value of the libraries property.

Returns:

possible object is String

setLibraries

void setLibraries(String value)
           throws PropertyVetoException

Sets the value of the libraries property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAvailabilityEnabled

String getAvailabilityEnabled()

Gets the value of the availabilityEnabled property.

Returns:

possible object is String

setAvailabilityEnabled

void setAvailabilityEnabled(String value)
                     throws PropertyVetoException

Sets the value of the availabilityEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAsyncReplication

String getAsyncReplication()

Gets the value of the asyncReplication property.

Returns:

possible object is String

setAsyncReplication

void setAsyncReplication(String value)
                  throws PropertyVetoException

Sets the value of the asyncReplication property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDirectoryDeployed

String getDirectoryDeployed()

Gets the value of the directoryDeployed property.

Returns:

possible object is String

setDirectoryDeployed

void setDirectoryDeployed(String value)
                   throws PropertyVetoException

Sets the value of the directoryDeployed property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDescription

String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

void setDescription(String value)
             throws PropertyVetoException

Sets the value of the description property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDeploymentOrder

String getDeploymentOrder()

Gets the value of the deploymentOrder property.

Returns:

possible object is String

setDeploymentOrder

void setDeploymentOrder(String value)
                 throws PropertyVetoException

Sets the value of the deploymentOrder property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getModule

List<Module> getModule()

getEngine

List<Engine> getEngine()

Gets the value of the engine property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the engine property.

For example, to add a new item, do as follows:

 getEngine().add(newItem);
 

Objects of the following type(s) are allowed in the list Engine

getResources

Resources getResources()

setResources

void setResources(Resources resources)
           throws PropertyVetoException

Throws:

PropertyVetoException

getAppTenants

AppTenants getAppTenants()

setAppTenants

void setAppTenants(AppTenants appTenants)

getExtensions

List<ApplicationExtension> getExtensions()

getExtensionByType

@DuckTyped
<T extends ApplicationExtension> T getExtensionByType(Class<T> type)

getExtensionsByType

@DuckTyped
<T extends ApplicationExtension> List<T> getExtensionsByType(Class<T> type)

getModule

@DuckTyped
Module getModule(String moduleName)

getDeployProperties

@DuckTyped
Properties getDeployProperties()

getDeployParameters

@DuckTyped
org.glassfish.api.deployment.DeployCommandParameters getDeployParameters(ApplicationRef appRef)

getModulePropertiesMap

@DuckTyped
Map<String,Properties> getModulePropertiesMap()

isStandaloneModule

@DuckTyped
boolean isStandaloneModule()

containsSnifferType

@DuckTyped
boolean containsSnifferType(String snifferType)

isLifecycleModule

@DuckTyped
boolean isLifecycleModule()

recordFileLocations

@DuckTyped
void recordFileLocations(File app,
                         File plan)

application

@DuckTyped
File application()

deploymentPlan

@DuckTyped
File deploymentPlan()

archiveType

@DuckTyped
String archiveType()

getProperty

@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
@PropertiesDesc(props={})
List<org.jvnet.hk2.config.types.Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface org.jvnet.hk2.config.types.PropertyBag