Java EE 5 SDK

com.sun.appserv.management.config
Interface WebModuleConfig

All Superinterfaces:
AMX, AMXConfig, AMXMBeanLogging, ConfigElement, ConfigRemover, Container, DeployedItemRefConfigReferent, Description, Enabled, Libraries, ModuleConfig, NamedConfigElement, NotificationBroadcaster, NotificationEmitter, ObjectType, PropertiesAccess, RefConfigReferent, WebServiceEndpointConfigCR

public interface WebModuleConfig
extends ModuleConfig, Libraries, Container, WebServiceEndpointConfigCR

Configuration for the <web-module> element.


Field Summary
static String J2EE_TYPE
          The j2eeType as returned by AMX.getJ2EEType().
 
Fields inherited from interface com.sun.appserv.management.config.Description
DESCRIPTION_KEY
 
Fields inherited from interface com.sun.appserv.management.config.AMXConfig
CONFIG_CREATED_NOTIFICATION_TYPE, CONFIG_OBJECT_NAME_KEY, CONFIG_REMOVED_NOTIFICATION_TYPE
 
Fields inherited from interface com.sun.appserv.management.config.PropertiesAccess
PROPERTY_PREFIX
 
Fields inherited from interface com.sun.appserv.management.base.Container
ATTR_CONTAINEE_J2EE_TYPES
 
Method Summary
 boolean getAvailabilityEnabled()
          Controls whether availability is enabled for HTTP Session Persistence.
 String getContextRoot()
          The ContextRoot must match the pattern for the hpath production in RFC 1738 which can be found at: http://www.w3.org/Addressing/rfc1738.txt.
 Map<String,WebServiceEndpointConfig> getWebServiceEndpointConfigMap()
           
 void setAvailabilityEnabled(boolean enabled)
           
 void setContextRoot(String value)
           
 
Methods inherited from interface com.sun.appserv.management.config.ModuleConfig
getDirectoryDeployed, getLocation
 
Methods inherited from interface com.sun.appserv.management.config.Enabled
getEnabled, setEnabled
 
Methods inherited from interface com.sun.appserv.management.config.Description
getDescription, setDescription
 
Methods inherited from interface com.sun.appserv.management.config.ObjectType
getObjectType, setObjectType
 
Methods inherited from interface com.sun.appserv.management.config.PropertiesAccess
createProperty, existsProperty, getProperties, getPropertyNames, getPropertyValue, removeProperty, setPropertyValue
 
Methods inherited from interface com.sun.appserv.management.config.Libraries
getLibraries, setLibraries
 
Methods inherited from interface com.sun.appserv.management.base.Container
getByNameContaineeSet, getContainee, getContainee, getContaineeJ2EETypes, getContaineeMap, getContaineeSet, getContaineeSet, getContaineeSet, getMultiContaineeMap
 
Methods inherited from interface com.sun.appserv.management.config.WebServiceEndpointConfigCR
createWebServiceEndpointConfig, removeWebServiceEndpointConfig
 
Methods inherited from interface com.sun.appserv.management.config.ConfigRemover
removeConfig
 

Field Detail

J2EE_TYPE

static final String J2EE_TYPE
The j2eeType as returned by AMX.getJ2EEType().

See Also:
Constant Field Values
Method Detail

getContextRoot

String getContextRoot()
The ContextRoot must match the pattern for the hpath production in RFC 1738 which can be found at: http://www.w3.org/Addressing/rfc1738.txt. This is flattened to the following regular expression in XML Schema's pattern language:
                                     
        ([a-zA-Z0-9$\-_.+!*'(),]|%[0-9A-Fa-f][0-9A-Fa-f]|;|:|&|=)*(/([
        -zA-Z0-9$\-_.+!*'(),]|%[0-9A-Fa-f][0-9A-Fa-f]|;|:|&|=)*)*
        
Note that this includes the null or empty context root and permits but does not require a context root to start with the '/' character (including a context root which is simply the '/' character).

See Also:
setContextRoot(java.lang.String)

setContextRoot

void setContextRoot(String value)
See Also:
getContextRoot()

getAvailabilityEnabled

boolean getAvailabilityEnabled()
Controls whether availability is enabled for HTTP Session Persistence. If this is "false", then all session persistence is disabled for the given web module. If it is "true" (and providing that all the availability-enabled attributes above in precedence are also "true", then the web module may be ha enabled. Finer-grained control exists at lower level (see sun-web.xml).

See Also:
setAvailabilityEnabled(boolean)

setAvailabilityEnabled

void setAvailabilityEnabled(boolean enabled)
See Also:
getAvailabilityEnabled()

getWebServiceEndpointConfigMap

Map<String,WebServiceEndpointConfig> getWebServiceEndpointConfigMap()

Java EE 5 SDK

Submit a bug or feature

Copyright 2006 Sun Microsystems, Inc. All rights reserved.