com.sun.enterprise.config.serverbeans
Interface Config

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, Named, javax.validation.Payload, org.jvnet.hk2.config.types.PropertyBag, SystemPropertyBag

public interface Config
extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, Named, org.jvnet.hk2.config.types.PropertyBag, SystemPropertyBag, javax.validation.Payload

The configuration defines the configuration of a server instance that can be shared by other server instances. The availability-service and are SE/EE only

Nested Class Summary

static class

Config.Duck

Method Summary

com.sun.grizzly.config.dom.NetworkListener	getAdminListener()
AdminService	getAdminService() Gets the value of the adminService property.
AlertService	getAlertService() Gets the value of the alertService property.
AvailabilityService	getAvailabilityService() Gets the value of the availabilityService property.
ConnectorService	getConnectorService() Gets the value of the connectorService property.
List<Container>	getContainers() Get the configuration for other types of containers.
DiagnosticService	getDiagnosticService() Gets the value of the diagnosticService property.
String	getDynamicReconfigurationEnabled() Gets the value of the dynamicReconfigurationEnabled property.
EjbContainer	getEjbContainer() Gets the value of the ejbContainer property.
<T extends ConfigExtension> T	getExtensionByType(Class<T> type) Return an extension configuration given the extension type.
GroupManagementService	getGroupManagementService() Gets the value of the groupManagementService property.
HttpService	getHttpService() Gets the value of the httpService property.
IiopService	getIiopService() Gets the value of the iiopService property.
JavaConfig	getJavaConfig() Gets the value of the javaConfig property.
JmsService	getJmsService() Gets the value of the jmsService property.
Map<String,String>	getLoggingProperties()
LogService	getLogService() Gets the value of the logService property.
ManagementRules	getManagementRules() Gets the value of the managementRules property.
MdbContainer	getMdbContainer() Gets the value of the mdbContainer property.
MonitoringService	getMonitoringService() Gets the value of the monitoringService property.
String	getName() Name of the configured object
com.sun.grizzly.config.dom.NetworkConfig	getNetworkConfig() Gets the value of the networkConfig property.
List<org.jvnet.hk2.config.types.Property>	getProperty() Properties as per PropertyBag
SecurityService	getSecurityService() Gets the value of the securityService property.
List<SystemProperty>	getSystemProperty() Gets the value of the systemProperty property.
ThreadPools	getThreadPools() Gets the value of the threadPools property.
TransactionService	getTransactionService() Gets the value of the transactionService property.
WebContainer	getWebContainer() Gets the value of the webContainer property.
void	setAdminService(AdminService value) Sets the value of the adminService property.
void	setAlertService(AlertService value) Sets the value of the alertService property.
void	setAvailabilityService(AvailabilityService value) Sets the value of the availabilityService property.
void	setConnectorService(ConnectorService value) Sets the value of the connectorService property.
void	setDiagnosticService(DiagnosticService value) Sets the value of the diagnosticService property.
void	setDynamicReconfigurationEnabled(String value) Sets the value of the dynamicReconfigurationEnabled property.
void	setEjbContainer(EjbContainer value) Sets the value of the ejbContainer property.
void	setGroupManagementService(GroupManagementService value) Sets the value of the groupManagementService property.
void	setHttpService(HttpService value) Sets the value of the httpService property.
void	setIiopService(IiopService value) Sets the value of the iiopService property.
void	setJavaConfig(JavaConfig value) Sets the value of the javaConfig property.
void	setJmsService(JmsService value) Sets the value of the jmsService property.
String	setLoggingProperty(String property, String value)
void	setLogService(LogService value) Sets the value of the logService property.
void	setManagementRules(ManagementRules value) Sets the value of the managementRules property.
void	setMdbContainer(MdbContainer value) Sets the value of the mdbContainer property.
void	setMonitoringService(MonitoringService value) Sets the value of the monitoringService property.
void	setName(String value)
void	setNetworkConfig(com.sun.grizzly.config.dom.NetworkConfig value) Sets the value of the networkConfig property.
void	setSecurityService(SecurityService value) Sets the value of the securityService property.
void	setThreadPools(ThreadPools value) Sets the value of the threadPools property.
void	setTransactionService(TransactionService value) Sets the value of the transactionService property.
void	setWebContainer(WebContainer value) Sets the value of the webContainer property.
Map<String,String>	updateLoggingProperties(Map<String,String> properties)

Methods inherited from interface org.jvnet.hk2.component.Injectable

injectedInto

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

getProperty, getPropertyValue, getPropertyValue

Methods inherited from interface com.sun.enterprise.config.serverbeans.SystemPropertyBag

containsProperty, getPropertyValue, getSystemProperty, getSystemPropertyValue

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

createChild, deepCopy, getParent, getParent

Method Detail

getName

@NotNull
@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",
         message="{config.invalid.name}",
         payload=Config.class)
String getName()

Name of the configured object

Specified by:

getName in interface Named

Returns:

name of the configured object FIXME: should set 'key=true'. See bugs 6039, 6040

setName

void setName(String value)
             throws PropertyVetoException

Specified by:

setName in interface Named

Throws:

PropertyVetoException

getDynamicReconfigurationEnabled

String getDynamicReconfigurationEnabled()

Gets the value of the dynamicReconfigurationEnabled property. When set to "true" then any changes to the system (e.g. applications deployed, resources created) will be automatically applied to the affected servers without a restart being required. When set to "false" such changes will only be picked up by the affected servers when each server restarts.

Returns:

possible object is String

setDynamicReconfigurationEnabled

void setDynamicReconfigurationEnabled(String value)
                                      throws PropertyVetoException

Sets the value of the dynamicReconfigurationEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getNetworkConfig

com.sun.grizzly.config.dom.NetworkConfig getNetworkConfig()

Gets the value of the networkConfig property.

Returns:

possible object is NetworkConfig

setNetworkConfig

void setNetworkConfig(com.sun.grizzly.config.dom.NetworkConfig value)
                      throws PropertyVetoException

Sets the value of the networkConfig property.

Parameters:

value - allowed object is NetworkConfig

Throws:

PropertyVetoException

getHttpService

HttpService getHttpService()

Gets the value of the httpService property.

Returns:

possible object is HttpService

setHttpService

void setHttpService(HttpService value)
                    throws PropertyVetoException

Sets the value of the httpService property.

Parameters:

value - allowed object is HttpService

Throws:

PropertyVetoException

getIiopService

@NotNull
IiopService getIiopService()

Gets the value of the iiopService property.

Returns:

possible object is IiopService

setIiopService

void setIiopService(IiopService value)
                    throws PropertyVetoException

Sets the value of the iiopService property.

Parameters:

value - allowed object is IiopService

Throws:

PropertyVetoException

getAdminService

AdminService getAdminService()

Gets the value of the adminService property.

Returns:

possible object is AdminService

setAdminService

void setAdminService(AdminService value)
                     throws PropertyVetoException

Sets the value of the adminService property.

Parameters:

value - allowed object is AdminService

Throws:

PropertyVetoException

getConnectorService

@NotNull
ConnectorService getConnectorService()

Gets the value of the connectorService property.

Returns:

possible object is ConnectorService

setConnectorService

void setConnectorService(ConnectorService value)
                         throws PropertyVetoException

Sets the value of the connectorService property.

Parameters:

value - allowed object is ConnectorService

Throws:

PropertyVetoException

getWebContainer

@NotNull
WebContainer getWebContainer()

Gets the value of the webContainer property.

Returns:

possible object is WebContainer

setWebContainer

void setWebContainer(WebContainer value)
                     throws PropertyVetoException

Sets the value of the webContainer property.

Parameters:

value - allowed object is WebContainer

Throws:

PropertyVetoException

getEjbContainer

EjbContainer getEjbContainer()

Gets the value of the ejbContainer property.

Returns:

possible object is EjbContainer

setEjbContainer

void setEjbContainer(EjbContainer value)
                     throws PropertyVetoException

Sets the value of the ejbContainer property.

Parameters:

value - allowed object is EjbContainer

Throws:

PropertyVetoException

getMdbContainer

@NotNull
MdbContainer getMdbContainer()

Gets the value of the mdbContainer property.

Returns:

possible object is MdbContainer

setMdbContainer

void setMdbContainer(MdbContainer value)
                     throws PropertyVetoException

Sets the value of the mdbContainer property.

Parameters:

value - allowed object is MdbContainer

Throws:

PropertyVetoException

getJmsService

@NotNull
JmsService getJmsService()

Gets the value of the jmsService property.

Returns:

possible object is JmsService

setJmsService

void setJmsService(JmsService value)
                   throws PropertyVetoException

Sets the value of the jmsService property.

Parameters:

value - allowed object is JmsService

Throws:

PropertyVetoException

getLogService

LogService getLogService()

Gets the value of the logService property.

Returns:

possible object is LogService

setLogService

void setLogService(LogService value)
                   throws PropertyVetoException

Sets the value of the logService property.

Parameters:

value - allowed object is LogService

Throws:

PropertyVetoException

getSecurityService

SecurityService getSecurityService()

Gets the value of the securityService property.

Returns:

possible object is SecurityService

setSecurityService

void setSecurityService(SecurityService value)
                        throws PropertyVetoException

Sets the value of the securityService property.

Parameters:

value - allowed object is SecurityService

Throws:

PropertyVetoException

getTransactionService

TransactionService getTransactionService()

Gets the value of the transactionService property.

Returns:

possible object is TransactionService

setTransactionService

void setTransactionService(TransactionService value)
                           throws PropertyVetoException

Sets the value of the transactionService property.

Parameters:

value - allowed object is TransactionService

Throws:

PropertyVetoException

getMonitoringService

@NotNull
MonitoringService getMonitoringService()

Gets the value of the monitoringService property.

Returns:

possible object is MonitoringService

setMonitoringService

void setMonitoringService(MonitoringService value)
                          throws PropertyVetoException

Sets the value of the monitoringService property.

Parameters:

value - allowed object is MonitoringService

Throws:

PropertyVetoException

getDiagnosticService

DiagnosticService getDiagnosticService()

Gets the value of the diagnosticService property.

Returns:

possible object is DiagnosticService

setDiagnosticService

void setDiagnosticService(DiagnosticService value)
                          throws PropertyVetoException

Sets the value of the diagnosticService property.

Parameters:

value - allowed object is DiagnosticService

Throws:

PropertyVetoException

getJavaConfig

JavaConfig getJavaConfig()

Gets the value of the javaConfig property.

Returns:

possible object is JavaConfig

setJavaConfig

void setJavaConfig(JavaConfig value)
                   throws PropertyVetoException

Sets the value of the javaConfig property.

Parameters:

value - allowed object is JavaConfig

Throws:

PropertyVetoException

getAvailabilityService

AvailabilityService getAvailabilityService()

Gets the value of the availabilityService property.

Returns:

possible object is AvailabilityService

setAvailabilityService

void setAvailabilityService(AvailabilityService value)
                            throws PropertyVetoException

Sets the value of the availabilityService property.

Parameters:

value - allowed object is AvailabilityService

Throws:

PropertyVetoException

getThreadPools

ThreadPools getThreadPools()

Gets the value of the threadPools property.

Returns:

possible object is ThreadPools

setThreadPools

void setThreadPools(ThreadPools value)
                    throws PropertyVetoException

Sets the value of the threadPools property.

Parameters:

value - allowed object is ThreadPools

Throws:

PropertyVetoException

getAlertService

AlertService getAlertService()

Gets the value of the alertService property.

Returns:

possible object is AlertService

setAlertService

void setAlertService(AlertService value)
                     throws PropertyVetoException

Sets the value of the alertService property.

Parameters:

value - allowed object is AlertService

Throws:

PropertyVetoException

getGroupManagementService

@NotNull
GroupManagementService getGroupManagementService()

Gets the value of the groupManagementService property.

Returns:

possible object is GroupManagementService

setGroupManagementService

void setGroupManagementService(GroupManagementService value)
                               throws PropertyVetoException

Sets the value of the groupManagementService property.

Parameters:

value - allowed object is GroupManagementService

Throws:

PropertyVetoException

getManagementRules

ManagementRules getManagementRules()

Gets the value of the managementRules property.

Returns:

possible object is ManagementRules

setManagementRules

void setManagementRules(ManagementRules value)
                        throws PropertyVetoException

Sets the value of the managementRules property.

Parameters:

value - allowed object is ManagementRules

Throws:

PropertyVetoException

getSystemProperty

@ToDo(priority=IMPORTANT,
      details="Any more legal system properties?")
@PropertiesDesc(systemProperties=true,
                props={@PropertyDesc(name="HTTP_LISTENER_PORT",defaultValue="8080",dataType=Port.class),@PropertyDesc(name="HTTP_SSL_LISTENER_PORT",defaultValue="1043",dataType=Port.class),@PropertyDesc(name="HTTP_ADMIN_LISTENER_PORT",defaultValue="4848",dataType=Port.class),@PropertyDesc(name="IIOP_LISTENER_PORT",defaultValue="3700",dataType=Port.class),@PropertyDesc(name="IIOP_SSL_LISTENER_PORT",defaultValue="1060",dataType=Port.class),@PropertyDesc(name="IIOP_SSL_MUTUALAUTH_PORT",defaultValue="1061",dataType=Port.class),@PropertyDesc(name="JMX_SYSTEM_CONNECTOR_PORT",defaultValue="8686",dataType=Port.class)})
List<SystemProperty> getSystemProperty()

Gets the value of the systemProperty 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 systemProperty property.

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

    getSystemProperty().add(newItem);
 

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

Specified by:

getSystemProperty in interface SystemPropertyBag

getLoggingProperties

@DuckTyped
Map<String,String> getLoggingProperties()

setLoggingProperty

@DuckTyped
String setLoggingProperty(String property,
                                    String value)

updateLoggingProperties

@DuckTyped
Map<String,String> updateLoggingProperties(Map<String,String> properties)

getAdminListener

@DuckTyped
com.sun.grizzly.config.dom.NetworkListener getAdminListener()

getExtensionByType

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

Return an extension configuration given the extension type.

Type Parameters:

T - interface subclassing the ConfigExtension type

Parameters:

type - type of the requested extension configuration

Returns:

a configuration proxy of type T or null if there is no such configuration with that type.

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

getContainers

List<Container> getContainers()

Get the configuration for other types of containers.

Returns:

list of containers configuration