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 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
        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

      • 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

      • 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 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

      • getAdminService

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

      • getLogService

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

      • getSecurityService

        SecurityService getSecurityService()
        Gets the value of the securityService property.
        Returns:
        possible object is SecurityService

      • getMonitoringService

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

      • getJavaConfig

        JavaConfig getJavaConfig()
        Gets the value of the javaConfig property.
        Returns:
        possible object is JavaConfig

      • getThreadPools

        ThreadPools getThreadPools()
        Gets the value of the threadPools property.
        Returns:
        possible object is ThreadPools

      • 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)

      • getAdminListener

        @DuckTyped
org.glassfish.grizzly.config.dom.NetworkListener getAdminListener()

      • createDefaultChildByType

        @DuckTyped
<T extends org.glassfish.api.admin.config.ConfigExtension> T createDefaultChildByType​(Class<T> type)

      • 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

        @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 Config
        name - name to use to identify the objects

      • checkIfExtensionExists

        @DuckTyped
<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.

      • isResourceRefExists

        @DuckTyped
boolean isResourceRefExists​(String refName)

      • createResourceRef

        @DuckTyped
void createResourceRef​(String enabled,
                       String refName)
                throws org.jvnet.hk2.config.TransactionFailure
        Throws:
        org.jvnet.hk2.config.TransactionFailure

      • deleteResourceRef

        @DuckTyped
void deleteResourceRef​(String refName)
                throws org.jvnet.hk2.config.TransactionFailure
        Throws:
        org.jvnet.hk2.config.TransactionFailure

      • isDas

        @DuckTyped
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()