Interface Config
-
- All Superinterfaces:
ConfigBeanProxy
,ConfigLoader
,Named
,jakarta.validation.Payload
,PropertyBag
,RefContainer
,SystemPropertyBag
public interface Config extends Named, PropertyBag, SystemPropertyBag, jakarta.validation.Payload, ConfigLoader, ConfigBeanProxy, RefContainer
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
Nested Classes Modifier and Type Interface Description static class
Config.Duck
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addIndex(org.glassfish.hk2.api.ServiceLocator habitat, String name)
Add name as an index key for this Config and for the objects that are directly referenced by this Config.<P extends ConfigExtension>
booleancheckIfExtensionExists(Class<P> configBeanType)
<T extends ConfigExtension>
TcreateDefaultChildByType(Class<T> type)
void
createResourceRef(String enabled, String refName)
void
deleteResourceRef(String refName)
NetworkListener
getAdminListener()
AdminService
getAdminService()
Gets the value of the adminService property.@NotNull AvailabilityService
getAvailabilityService()
Gets the value of the availabilityService 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.<T extends ConfigExtension>
TgetExtensionByType(Class<T> type)
Return an extension configuration given the extension type.List<ConfigExtension>
getExtensions()
@NotNull GroupManagementService
getGroupManagementService()
Gets the value of the groupManagementService property.HttpService
getHttpService()
Gets the value of the httpService property.JavaConfig
getJavaConfig()
Gets the value of the javaConfig property.Map<String,String>
getLoggingProperties()
LogService
getLogService()
Gets the value of the logService property.@NotNull MonitoringService
getMonitoringService()
Gets the value of the monitoringService property.@NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",message="{config.invalid.name}",payload=Config.class) String
getName()
Name of the configured objectNetworkConfig
getNetworkConfig()
Gets the value of the networkConfig property.List<Property>
getProperty()
Properties as perPropertyBag
ResourceRef
getResourceRef(String refName)
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.boolean
isDas()
boolean
isResourceRefExists(String refName)
void
setAdminService(AdminService value)
Sets the value of the adminService property.void
setAvailabilityService(AvailabilityService value)
Sets the value of the availabilityService property.void
setDiagnosticService(DiagnosticService value)
Sets the value of the diagnosticService property.void
setDynamicReconfigurationEnabled(String value)
Sets the value of the dynamicReconfigurationEnabled property.void
setGroupManagementService(GroupManagementService value)
Sets the value of the groupManagementService property.void
setHttpService(HttpService value)
Sets the value of the httpService property.void
setJavaConfig(JavaConfig value)
Sets the value of the javaConfig property.String
setLoggingProperty(String property, String value)
void
setLogService(LogService value)
Sets the value of the logService property.void
setMonitoringService(MonitoringService value)
Sets the value of the monitoringService property.void
setName(String value)
void
setNetworkConfig(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.Map<String,String>
updateLoggingProperties(Map<String,String> properties)
-
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
-
Methods inherited from interface com.sun.enterprise.config.serverbeans.RefContainer
getApplicationRef, getResourceRef
-
Methods inherited from interface com.sun.enterprise.config.serverbeans.SystemPropertyBag
containsProperty, getPropertyValue, getSystemProperty, getSystemPropertyValue
-
-
-
-
Method Detail
-
getName
@NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*", message="{config.invalid.name}", payload=Config.class) @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
-
setName
void setName(String value) throws PropertyVetoException
- Specified by:
setName
in interfaceNamed
- 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 isString
- Throws:
PropertyVetoException
-
getNetworkConfig
NetworkConfig getNetworkConfig()
Gets the value of the networkConfig property.- Returns:
- possible object is
NetworkConfig
-
setNetworkConfig
void setNetworkConfig(NetworkConfig value) throws PropertyVetoException
Sets the value of the networkConfig property.- Parameters:
value
- allowed object isNetworkConfig
- 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 isHttpService
- 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 isAdminService
- 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 isLogService
- 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 isSecurityService
- Throws:
PropertyVetoException
-
getMonitoringService
@NotNull @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 isMonitoringService
- 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 isDiagnosticService
- 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 isJavaConfig
- Throws:
PropertyVetoException
-
getAvailabilityService
@NotNull @NotNull 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 isAvailabilityService
- 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 isThreadPools
- Throws:
PropertyVetoException
-
getGroupManagementService
@NotNull @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 isGroupManagementService
- 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 aset
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 listSystemProperty
- Specified by:
getSystemProperty
in interfaceSystemPropertyBag
- Returns:
-
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 NetworkListener getAdminListener()
-
createDefaultChildByType
@DuckTyped <T extends ConfigExtension> T createDefaultChildByType(Class<T> type)
-
getExtensionByType
<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.
-
addIndex
@DuckTyped void addIndex(org.glassfish.hk2.api.ServiceLocator habitat, String name)
Add name as an index key for this Config and for the objects that are directly referenced by this Config. This includes all of the Config extensions.- Parameters:
habitat
- ServiceLocator that contains this Configname
- name to use to identify the objects
-
checkIfExtensionExists
@DuckTyped <P extends ConfigExtension> boolean checkIfExtensionExists(Class<P> configBeanType)
- Type Parameters:
P
- Type that extends the ConfigBeanProxy which is the type of class we accept as parameter- Parameters:
configBeanType
- The config bean type we want to check whether the configuration exists for it or not.- Returns:
- true if configuration for the type exists in the target area of domain.xml and false if not.
-
getResourceRef
@DuckTyped ResourceRef getResourceRef(String refName)
-
isResourceRefExists
@DuckTyped boolean isResourceRefExists(String refName)
-
createResourceRef
@DuckTyped void createResourceRef(String enabled, String refName) throws TransactionFailure
- Throws:
TransactionFailure
-
deleteResourceRef
@DuckTyped void deleteResourceRef(String refName) throws TransactionFailure
- Throws:
TransactionFailure
-
isDas
@DuckTyped boolean isDas()
-
getProperty
@ToDo(priority=IMPORTANT, details="Provide PropertyDesc for legal props") @PropertiesDesc(props={}) List<Property> getProperty()
Properties as perPropertyBag
- Specified by:
getProperty
in interfacePropertyBag
- Returns:
- the property list
-
getContainers
List<Container> getContainers()
Get the configuration for other types of containers.- Returns:
- list of containers configuration
-
getExtensions
List<ConfigExtension> getExtensions()
-
-