Package com.sun.enterprise.config.serverbeans

Interface Config

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, ConfigLoader, org.glassfish.api.admin.config.Named, jakarta.validation.Payload, org.jvnet.hk2.config.types.PropertyBag, RefContainer, SystemPropertyBag
public interface Config extends org.glassfish.api.admin.config.Named, org.jvnet.hk2.config.types.PropertyBag, SystemPropertyBag, jakarta.validation.Payload, ConfigLoader, org.jvnet.hk2.config.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

  • Method Details

    • 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
      Specified by:
      getName in interface org.glassfish.api.admin.config.Named
      Returns:
      name of the configured object FIXME: should set 'key=true'. See bugs 6039, 6040

    • setName

      void setName(String configName) throws PropertyVetoException
      Specified by:
      setName in interface org.glassfish.api.admin.config.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 reconfigurationEnabled) throws PropertyVetoException
      Sets the value of the dynamicReconfigurationEnabled property.
      Parameters:
      reconfigurationEnabled - allowed object is String
      Throws:
      PropertyVetoException

    • getNetworkConfig

      org.glassfish.grizzly.config.dom.NetworkConfig getNetworkConfig()
      Gets the value of the networkConfig property.
      Returns:
      possible object is NetworkConfig

    • setNetworkConfig

      void setNetworkConfig(org.glassfish.grizzly.config.dom.NetworkConfig networkConfig) throws PropertyVetoException
      Sets the value of the networkConfig property.
      Parameters:
      networkConfig - 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 httpService) throws PropertyVetoException
      Sets the value of the httpService property.
      Parameters:
      httpService - allowed object is HttpService
      Throws:
      PropertyVetoException

    • getAdminService

      AdminService getAdminService()
      Gets the value of the adminService property.
      Returns:
      possible object is AdminService

    • setAdminService

      void setAdminService(AdminService adminService) throws PropertyVetoException
      Sets the value of the adminService property.
      Parameters:
      adminService - allowed object is AdminService
      Throws:
      PropertyVetoException

    • getLogService

      LogService getLogService()
      Gets the value of the logService property.
      Returns:
      possible object is LogService

    • setLogService

      void setLogService(LogService logService) throws PropertyVetoException
      Sets the value of the logService property.
      Parameters:
      logService - 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 securityService) throws PropertyVetoException
      Sets the value of the securityService property.
      Parameters:
      securityService - allowed object is SecurityService
      Throws:
      PropertyVetoException

    • getMonitoringService

      @NotNull @NotNull MonitoringService getMonitoringService()
      Gets the value of the monitoringService property.
      Returns:
      possible object is MonitoringService

    • setMonitoringService

      void setMonitoringService(MonitoringService monitoringService) throws PropertyVetoException
      Sets the value of the monitoringService property.
      Parameters:
      monitoringService - 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 diagnosticService) throws PropertyVetoException
      Sets the value of the diagnosticService property.
      Parameters:
      diagnosticService - 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 javaConfig) throws PropertyVetoException
      Sets the value of the javaConfig property.
      Parameters:
      javaConfig - allowed object is JavaConfig
      Throws:
      PropertyVetoException

    • getAvailabilityService

      @NotNull @NotNull AvailabilityService getAvailabilityService()
      Gets the value of the availabilityService property.
      Returns:
      possible object is AvailabilityService

    • setAvailabilityService

      void setAvailabilityService(AvailabilityService availabilityService) throws PropertyVetoException
      Sets the value of the availabilityService property.
      Parameters:
      availabilityService - 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 threadPools) throws PropertyVetoException
      Sets the value of the threadPools property.
      Parameters:
      threadPools - allowed object is ThreadPools
      Throws:
      PropertyVetoException

    • getGroupManagementService

      @NotNull @NotNull GroupManagementService getGroupManagementService()
      Gets the value of the groupManagementService property.
      Returns:
      possible object is GroupManagementService

    • setGroupManagementService

      void setGroupManagementService(GroupManagementService groupManagementService) throws PropertyVetoException
      Sets the value of the groupManagementService property.
      Parameters:
      groupManagementService - allowed object is GroupManagementService
      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

      default Map<String,String> getLoggingProperties()

    • setLoggingProperty

      default String setLoggingProperty(String property, String value)

    • updateLoggingProperties

      default Map<String,String> updateLoggingProperties(Map<String,String> properties)

    • getAdminListener

      default org.glassfish.grizzly.config.dom.NetworkListener getAdminListener()

    • getExtensionByType

      <T extends org.glassfish.api.admin.config.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

      default 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 the Config extensions.
      Parameters:
      habitat - ServiceLocator that contains this config
      name - name to use to identify the objects

    • checkIfExtensionExists

      default <P extends org.glassfish.api.admin.config.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

      default ResourceRef getResourceRef(org.glassfish.api.naming.SimpleJndiName refName)

    • isResourceRefExists

      default boolean isResourceRefExists(org.glassfish.api.naming.SimpleJndiName refName)

    • createResourceRef

      default void createResourceRef(String enabled, org.glassfish.api.naming.SimpleJndiName refName) throws org.jvnet.hk2.config.TransactionFailure
      Throws:
      org.jvnet.hk2.config.TransactionFailure

    • deleteResourceRef

      default void deleteResourceRef(org.glassfish.api.naming.SimpleJndiName refName) throws org.jvnet.hk2.config.TransactionFailure
      Throws:
      org.jvnet.hk2.config.TransactionFailure

    • isDas

      default boolean isDas()

    • 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<org.glassfish.api.admin.config.Container> getContainers()
      Get the configuration for other types of containers.
      Returns:
      list of containers configuration

    • getExtensions

      List<org.glassfish.api.admin.config.ConfigExtension> getExtensions()