Package com.sun.enterprise.config.serverbeans

Interface Domain

    • Method Detail

      • getApplicationRoot

        String getApplicationRoot()
        Gets the value of the applicationRoot property. For PE this defines the location where applications are deployed
        Returns:
        possible object is String

      • getLogRoot

        String getLogRoot()
        Gets the value of the logRoot property. Specifies where the server instance's log files are kept, including HTTP access logs, server logs, and transaction logs. Default is $INSTANCE-ROOT/logs
        Returns:
        possible object is String

      • getLocale

        String getLocale()
        Gets the value of the locale property.
        Returns:
        possible object is String

      • getVersion

        String getVersion()
        Gets the value of the version property. It is read-only. Tools are not to depend on this property. It is only for reference.
        Returns:
        String representing version of the Domain.

      • getSecureAdmin

        SecureAdmin getSecureAdmin()
        Gets the SecureAdmin value defined in the domain.
        Returns:
        SecureAdmin

      • setSecureAdmin

        void setSecureAdmin​(SecureAdmin secureAdmin)
        Sets the SecureAdmin value.
        Parameters:
        secureAdmin -

      • getApplications

        @NotNull
@NotNull Applications getApplications()
        Gets the value of the applications property.
        Returns:
        possible object is Applications

      • getResources

        @NotNull
@NotNull Resources getResources()
        Gets the value of the resources property.
        Returns:
        possible object is Resources

      • getConfigs

        @NotNull
@NotNull Configs getConfigs()
        Gets the value of the configs property.
        Returns:
        possible object is Configs

      • getServers

        @NotNull
@NotNull Servers getServers()
        Gets the value of the servers property.
        Returns:
        possible object is Servers

      • getClusters

        @NotNull
@NotNull Clusters getClusters()
        Gets the value of the clusters property.
        Returns:
        possible object is Clusters

      • getNodes

        Nodes getNodes()
        Gets the value of the nodes property.
        Returns:
        possible object is Nodes

      • getNodeAgents

        NodeAgents getNodeAgents()
        Gets the value of the nodeAgents property.
        Returns:
        possible object is NodeAgents

      • getSystemProperty

        @ToDo(priority=IMPORTANT,
      details="Any more legal system properties?")
@PropertiesDesc(systemProperties=true,props={@PropertyDesc(name="com.sun.aas.installRoot",description="Operating system dependent. Path to the directory where the server is installed"),@PropertyDesc(name="com.sun.aas.instanceRoot",description="Operating system dependent. Path to the top level directory for a server instance"),@PropertyDesc(name="com.sun.aas.hostName",description="Operating system dependent. Path to the name of the host (machine)"),@PropertyDesc(name="com.sun.aas.javaRoot",description="Operating system dependent. Path to the library directory for the Sun GlassFish Message Queue software"),@PropertyDesc(name="com.sun.aas.imqLib",description="Operating system dependent. Path to the installation directory for the Java runtime"),@PropertyDesc(name="com.sun.aas.imqLib",description="Operating system dependent. Path to the installation directory for the Java runtime"),@PropertyDesc(name="com.sun.aas.configName",defaultValue="server-config",description="Name of the <config> used by a server instance"),@PropertyDesc(name="com.sun.aas.instanceName",defaultValue="server1",description="Name of the server instance. Not used in the default configuration, but can be used to customize configuration"),@PropertyDesc(name="com.sun.aas.domainName",defaultValue="domain1",description="Name of the domain. Not used in the default configuration, but can be used to customize configuration")})
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

      • 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

      • getName

        @DuckTyped
String getName()

      • getAllDefinedSystemApplications

        @DuckTyped
List<Application> getAllDefinedSystemApplications()

      • getSystemApplicationsReferencedFrom

        @DuckTyped
List<Application> getSystemApplicationsReferencedFrom​(String sn)
        Returns the list of system-applications that are referenced from the given server. A server references an application, if the server has an element named <application-ref> in it that points to given application. The given server is a <server> element inside domain.
        Parameters:
        sn - the string denoting name of the server
        Returns:
        List of system-applications for that server, an empty list in case there is none

      • getSystemApplicationReferencedFrom

        @DuckTyped
Application getSystemApplicationReferencedFrom​(String sn,
                                               String appName)

      • isNamedSystemApplicationReferencedFrom

        @DuckTyped
boolean isNamedSystemApplicationReferencedFrom​(String appName,
                                               String serverName)

      • getServerNamed

        @DuckTyped
Server getServerNamed​(String name)

      • isServer

        @DuckTyped
boolean isServer​(String name)

      • getConfigNamed

        @DuckTyped
Config getConfigNamed​(String name)

      • getClusterNamed

        @DuckTyped
Cluster getClusterNamed​(String name)

      • getNodeNamed

        @DuckTyped
Node getNodeNamed​(String name)

      • isCurrentInstanceMatchingTarget

        @DuckTyped
boolean isCurrentInstanceMatchingTarget​(String target,
                                        String appName,
                                        String currentInstance,
                                        List<String> referencedTargets)

      • getServersInTarget

        @DuckTyped
List<Server> getServersInTarget​(String target)

      • getApplicationRefInTarget

        @DuckTyped
ApplicationRef getApplicationRefInTarget​(String appName,
                                         String target,
                                         boolean includeInstances)

      • isAppRefEnabledInTarget

        @DuckTyped
boolean isAppRefEnabledInTarget​(String appName,
                                String target)

      • isAppEnabledInTarget

        @DuckTyped
boolean isAppEnabledInTarget​(String appName,
                             String target)

      • isAppReferencedByPaaSTarget

        @DuckTyped
boolean isAppReferencedByPaaSTarget​(String appName)

      • getAllReferencedTargetsForApplication

        @DuckTyped
List<String> getAllReferencedTargetsForApplication​(String appName)

      • getAllTargets

        @DuckTyped
List<String> getAllTargets()

      • getVirtualServersForApplication

        @DuckTyped
String getVirtualServersForApplication​(String target,
                                       String appName)

      • getEnabledForApplication

        @DuckTyped
String getEnabledForApplication​(String target,
                                String appName)

      • getReferenceContainerNamed

        @DuckTyped
org.glassfish.api.admin.config.ReferenceContainer getReferenceContainerNamed​(String name)

      • getClusterForInstance

        @DuckTyped
Cluster getClusterForInstance​(String instanceName)

      • getAllReferenceContainers

        @DuckTyped
List<org.glassfish.api.admin.config.ReferenceContainer> getAllReferenceContainers()

      • getReferenceContainersOf

        @DuckTyped
List<org.glassfish.api.admin.config.ReferenceContainer> getReferenceContainersOf​(Config config)

      • getInstancesOnNode

        @DuckTyped
List<Server> getInstancesOnNode​(String nodeName)

      • checkIfExtensionExists

        @DuckTyped
<P extends org.jvnet.hk2.config.ConfigBeanProxy> 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.