com.sun.enterprise.config.serverbeans
Interface Application

All Superinterfaces:
ApplicationName, org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, javax.validation.Payload, org.jvnet.hk2.config.types.PropertyBag

public interface Application
extends org.jvnet.hk2.component.Injectable, ApplicationName, org.jvnet.hk2.config.types.PropertyBag


Nested Class Summary
static class Application.Duck
           
 
Field Summary
static java.lang.String APP_LOCATION_PROP_NAME
           
static java.lang.String APPCLIENT_SNIFFER_TYPE
           
static java.lang.String APPLICATION
           
static java.lang.String CONNECTOR_SNIFFER_TYPE
           
static java.lang.String DEPLOYMENT_PLAN_LOCATION_PROP_NAME
           
static java.lang.String EAR_SNIFFER_TYPE
           
static java.lang.String EJB_SNIFFER_TYPE
           
static java.lang.String EXTERNAL_MODULE_TYPE
           
static java.lang.String JPA_SNIFFER_TYPE
           
static java.lang.String OSGI_SNIFFER_TYPE
           
static java.lang.String WEB_SNIFFER_TYPE
           
static java.lang.String WEBSERVICE_SNIFFER_TYPE
           
 
Fields inherited from interface org.glassfish.api.admin.config.ApplicationName
NAME_APP_REGEX
 
Method Summary
 java.io.File application()
           
 boolean containsSnifferType(java.lang.String snifferType)
           
 java.io.File deploymentPlan()
           
 java.lang.String getAsyncReplication()
          Gets the value of the asyncReplication property.
 java.lang.String getAvailabilityEnabled()
          Gets the value of the availabilityEnabled property.
 java.lang.String getContextRoot()
          Gets the value of the contextRoot property.
 DeployCommandParameters getDeployParameters(ApplicationRef appRef)
           
 java.util.Properties getDeployProperties()
           
 java.lang.String getDescription()
          Gets the value of the description property.
 java.lang.String getDirectoryDeployed()
          Gets the value of the directoryDeployed property.
 java.lang.String getEnabled()
          Gets the value of the enabled property.
 java.util.List<Engine> getEngine()
          Gets the value of the engine property.
 java.lang.String getLibraries()
          Gets the value of the libraries property.
 java.lang.String getLocation()
          Gets the value of the location property.
 java.util.List<Module> getModule()
           
 Module getModule(java.lang.String moduleName)
           
 java.util.Map<java.lang.String,java.util.Properties> getModulePropertiesMap()
           
 java.lang.String getObjectType()
          Gets the value of the objectType property.
 java.util.List<org.jvnet.hk2.config.types.Property> getProperty()
          Properties as per PropertyBag
 Resources getResources()
           
 java.util.List<WebServiceEndpoint> getWebServiceEndpoint()
          Gets the value of the webServiceEndpoint property.
 boolean isLifecycleModule()
           
 boolean isOSGiModule()
           
 boolean isStandaloneModule()
           
 void recordFileLocations(java.io.File app, java.io.File plan)
           
 void setAsyncReplication(java.lang.String value)
          Sets the value of the asyncReplication property.
 void setAvailabilityEnabled(java.lang.String value)
          Sets the value of the availabilityEnabled property.
 void setContextRoot(java.lang.String value)
          Sets the value of the contextRoot property.
 void setDescription(java.lang.String value)
          Sets the value of the description property.
 void setDirectoryDeployed(java.lang.String value)
          Sets the value of the directoryDeployed property.
 void setEnabled(java.lang.String value)
          Sets the value of the enabled property.
 void setLibraries(java.lang.String value)
          Sets the value of the libraries property.
 void setLocation(java.lang.String value)
          Sets the value of the location property.
 void setObjectType(java.lang.String value)
          Sets the value of the objectType property.
 void setResources(Resources resources)
           
 
Methods inherited from interface org.jvnet.hk2.component.Injectable
injectedInto
 
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
getProperty, getPropertyValue, getPropertyValue
 

Field Detail

APP_LOCATION_PROP_NAME

static final java.lang.String APP_LOCATION_PROP_NAME
See Also:
Constant Field Values

DEPLOYMENT_PLAN_LOCATION_PROP_NAME

static final java.lang.String DEPLOYMENT_PLAN_LOCATION_PROP_NAME
See Also:
Constant Field Values

WEB_SNIFFER_TYPE

static final java.lang.String WEB_SNIFFER_TYPE
See Also:
Constant Field Values

EJB_SNIFFER_TYPE

static final java.lang.String EJB_SNIFFER_TYPE
See Also:
Constant Field Values

CONNECTOR_SNIFFER_TYPE

static final java.lang.String CONNECTOR_SNIFFER_TYPE
See Also:
Constant Field Values

APPCLIENT_SNIFFER_TYPE

static final java.lang.String APPCLIENT_SNIFFER_TYPE
See Also:
Constant Field Values

JPA_SNIFFER_TYPE

static final java.lang.String JPA_SNIFFER_TYPE
See Also:
Constant Field Values

WEBSERVICE_SNIFFER_TYPE

static final java.lang.String WEBSERVICE_SNIFFER_TYPE
See Also:
Constant Field Values

EAR_SNIFFER_TYPE

static final java.lang.String EAR_SNIFFER_TYPE
See Also:
Constant Field Values

OSGI_SNIFFER_TYPE

static final java.lang.String OSGI_SNIFFER_TYPE
See Also:
Constant Field Values

APPLICATION

static final java.lang.String APPLICATION
See Also:
Constant Field Values

EXTERNAL_MODULE_TYPE

static final java.lang.String EXTERNAL_MODULE_TYPE
See Also:
Constant Field Values
Method Detail

getContextRoot

java.lang.String getContextRoot()
Gets the value of the contextRoot property.

Returns:
possible object is String

setContextRoot

void setContextRoot(java.lang.String value)
                    throws java.beans.PropertyVetoException
Sets the value of the contextRoot property.

Parameters:
value - allowed object is String
Throws:
java.beans.PropertyVetoException

getLocation

java.lang.String getLocation()
Gets the value of the location property.

Returns:
possible object is String

setLocation

void setLocation(java.lang.String value)
                 throws java.beans.PropertyVetoException
Sets the value of the location property.

Parameters:
value - allowed object is String
Throws:
java.beans.PropertyVetoException

getObjectType

@NotNull
java.lang.String getObjectType()
Gets the value of the objectType property.

Returns:
possible object is String

setObjectType

void setObjectType(java.lang.String value)
                   throws java.beans.PropertyVetoException
Sets the value of the objectType property.

Parameters:
value - allowed object is String
Throws:
java.beans.PropertyVetoException

getEnabled

java.lang.String getEnabled()
Gets the value of the enabled property.

Returns:
possible object is String

setEnabled

void setEnabled(java.lang.String value)
                throws java.beans.PropertyVetoException
Sets the value of the enabled property.

Parameters:
value - allowed object is String
Throws:
java.beans.PropertyVetoException

getLibraries

java.lang.String getLibraries()
Gets the value of the libraries property.

Returns:
possible object is String

setLibraries

void setLibraries(java.lang.String value)
                  throws java.beans.PropertyVetoException
Sets the value of the libraries property.

Parameters:
value - allowed object is String
Throws:
java.beans.PropertyVetoException

getAvailabilityEnabled

java.lang.String getAvailabilityEnabled()
Gets the value of the availabilityEnabled property.

Returns:
possible object is String

setAvailabilityEnabled

void setAvailabilityEnabled(java.lang.String value)
                            throws java.beans.PropertyVetoException
Sets the value of the availabilityEnabled property.

Parameters:
value - allowed object is String
Throws:
java.beans.PropertyVetoException

getAsyncReplication

java.lang.String getAsyncReplication()
Gets the value of the asyncReplication property.

Returns:
possible object is String

setAsyncReplication

void setAsyncReplication(java.lang.String value)
                         throws java.beans.PropertyVetoException
Sets the value of the asyncReplication property.

Parameters:
value - allowed object is String
Throws:
java.beans.PropertyVetoException

getDirectoryDeployed

java.lang.String getDirectoryDeployed()
Gets the value of the directoryDeployed property.

Returns:
possible object is String

setDirectoryDeployed

void setDirectoryDeployed(java.lang.String value)
                          throws java.beans.PropertyVetoException
Sets the value of the directoryDeployed property.

Parameters:
value - allowed object is String
Throws:
java.beans.PropertyVetoException

getDescription

java.lang.String getDescription()
Gets the value of the description property.

Returns:
possible object is String

setDescription

void setDescription(java.lang.String value)
                    throws java.beans.PropertyVetoException
Sets the value of the description property.

Parameters:
value - allowed object is String
Throws:
java.beans.PropertyVetoException

getModule

java.util.List<Module> getModule()

getEngine

java.util.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


getWebServiceEndpoint

java.util.List<WebServiceEndpoint> getWebServiceEndpoint()
Gets the value of the webServiceEndpoint 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 webServiceEndpoint property.

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

    getWebServiceEndpoint().add(newItem);
 

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


getResources

Resources getResources()

setResources

void setResources(Resources resources)
                  throws java.beans.PropertyVetoException
Throws:
java.beans.PropertyVetoException

getModule

@DuckTyped
Module getModule(java.lang.String moduleName)

getDeployProperties

@DuckTyped
java.util.Properties getDeployProperties()

getDeployParameters

@DuckTyped
DeployCommandParameters getDeployParameters(ApplicationRef appRef)

getModulePropertiesMap

@DuckTyped
java.util.Map<java.lang.String,java.util.Properties> getModulePropertiesMap()

isStandaloneModule

@DuckTyped
boolean isStandaloneModule()

containsSnifferType

@DuckTyped
boolean containsSnifferType(java.lang.String snifferType)

isLifecycleModule

@DuckTyped
boolean isLifecycleModule()

isOSGiModule

@DuckTyped
boolean isOSGiModule()

recordFileLocations

@DuckTyped
void recordFileLocations(java.io.File app,
                                   java.io.File plan)

application

@DuckTyped
java.io.File application()

deploymentPlan

@DuckTyped
java.io.File deploymentPlan()

getProperty

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

Specified by:
getProperty in interface org.jvnet.hk2.config.types.PropertyBag


Copyright © 2012 GlassFish Community. All Rights Reserved.