Package com.sun.enterprise.config.serverbeans

Interface Domain

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, ConfigLoader, org.jvnet.hk2.config.types.PropertyBag, SystemPropertyBag
public interface Domain extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag, SystemPropertyBag, ConfigLoader
Top level Domain Element that includes applications, resources, configs, servers, clusters and node-agents, load balancer configurations and load balancers.

Node-agents and load balancers are SE/EE related entities only.

  • Field Details

  • Method Details

    • 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

    • setApplicationRoot

      void setApplicationRoot(String applicationRoot) throws PropertyVetoException
      Sets the value of the applicationRoot property.
      Parameters:
      applicationRoot - allowed object is String
      Throws:
      PropertyVetoException

    • 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

    • setLogRoot

      void setLogRoot(String logRoot) throws PropertyVetoException
      Sets the value of the logRoot property.
      Parameters:
      logRoot - allowed object is String
      Throws:
      PropertyVetoException

    • getLocale

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

    • setLocale

      void setLocale(String locale) throws PropertyVetoException
      Sets the value of the locale property.
      Parameters:
      locale - allowed object is String
      Throws:
      PropertyVetoException

    • 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 - the new SecuredAdmin value

    • getApplications

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

    • setApplications

      void setApplications(Applications applications) throws PropertyVetoException
      Sets the value of the applications property.
      Parameters:
      applications - allowed object is Applications
      Throws:
      PropertyVetoException

    • getSystemApplications

      @NotNull @NotNull SystemApplications getSystemApplications()
      Gets the value of the system-applications property.
      Returns:
      possible object is SystemApplications

    • setSystemApplications

      void setSystemApplications(SystemApplications systemApplications) throws PropertyVetoException
      Sets the value of the system-applications property.
      Parameters:
      systemApplications - allowed object is SystemApplications
      Throws:
      PropertyVetoException

    • getResources

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

    • setResources

      void setResources(Resources resources) throws PropertyVetoException
      Sets the value of the resources property.
      Parameters:
      resources - allowed object is Resources
      Throws:
      PropertyVetoException

    • getConfigs

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

    • setConfigs

      void setConfigs(Configs configs) throws PropertyVetoException
      Sets the value of the configs property.
      Parameters:
      configs - allowed object is Configs
      Throws:
      PropertyVetoException

    • getServers

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

    • setServers

      void setServers(Servers servers) throws PropertyVetoException
      Sets the value of the servers property.
      Parameters:
      servers - allowed object is Servers
      Throws:
      PropertyVetoException

    • getClusters

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

    • setClusters

      void setClusters(Clusters clusters) throws PropertyVetoException
      Sets the value of the clusters property.
      Parameters:
      clusters - allowed object is Clusters
      Throws:
      PropertyVetoException

    • getNodes

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

    • setNodes

      void setNodes(Nodes nodes) throws PropertyVetoException
      Sets the value of the nodes property.
      Parameters:
      nodes - allowed object is Nodes
      Throws:
      PropertyVetoException

    • getNodeAgents

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

    • setNodeAgents

      void setNodeAgents(NodeAgents nodeAgents) throws PropertyVetoException
      Sets the value of the nodeAgents property.
      Parameters:
      nodeAgents - allowed object is NodeAgents
      Throws:
      PropertyVetoException

    • 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

    • getExtensions

      List<DomainExtension> getExtensions()

    • getName

      default String getName()

    • getAllDefinedSystemApplications

      default List<Application> getAllDefinedSystemApplications()

    • getApplicationRefInServer

      default ApplicationRef getApplicationRefInServer(String serverName, String appName)

    • getApplicationRefsInServer

      default List<ApplicationRef> getApplicationRefsInServer(String serverName)

    • getSystemApplicationsReferencedFrom

      default List<Application> getSystemApplicationsReferencedFrom(String serverName)
      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:
      serverName - the string denoting name of the server
      Returns:
      List of system-applications for that server, an empty list in case there is none

    • getSystemApplicationReferencedFrom

      default Application getSystemApplicationReferencedFrom(String serverName, String appName)

    • isNamedSystemApplicationReferencedFrom

      default boolean isNamedSystemApplicationReferencedFrom(String appName, String serverName)

    • getServerNamed

      default Server getServerNamed(String serverName)

    • isServer

      default boolean isServer(String serverName)

    • getConfigNamed

      default Config getConfigNamed(String configName)

    • getClusterNamed

      default Cluster getClusterNamed(String clusterName)

    • getNodeNamed

      default Node getNodeNamed(String nodeName)

    • isCurrentInstanceMatchingTarget

      default boolean isCurrentInstanceMatchingTarget(String target, String appName, String currentInstance, List<String> referencedTargets)

    • getServersInTarget

      default List<Server> getServersInTarget(String target)

    • getApplicationRefsInTarget

      default List<ApplicationRef> getApplicationRefsInTarget(String target)

    • getApplicationRefsInTarget

      default List<ApplicationRef> getApplicationRefsInTarget(String target, boolean includeInstances)

    • getApplicationRefInTarget

      default ApplicationRef getApplicationRefInTarget(String appName, String target)

    • getApplicationRefInTarget

      default ApplicationRef getApplicationRefInTarget(String appName, String target, boolean includeInstances)

    • isAppRefEnabledInTarget

      default boolean isAppRefEnabledInTarget(String appName, String target)

    • isAppEnabledInTarget

      default boolean isAppEnabledInTarget(String appName, String target)

    • isAppReferencedByPaaSTarget

      default boolean isAppReferencedByPaaSTarget(String appName)

    • getAllReferencedTargetsForApplication

      default List<String> getAllReferencedTargetsForApplication(String appName)

    • getAllTargets

      default List<String> getAllTargets()

    • getTargets

      default List<String> getTargets(String target)

    • getApplicationsInTarget

      default List<Application> getApplicationsInTarget(String target)

    • getVirtualServersForApplication

      default String getVirtualServersForApplication(String target, String appName)

    • getEnabledForApplication

      default String getEnabledForApplication(String target, String appName)

    • getReferenceContainerNamed

      default org.glassfish.api.admin.config.ReferenceContainer getReferenceContainerNamed(String containerName)

    • getClusterForInstance

      default Cluster getClusterForInstance(String instanceName)

    • getAllReferenceContainers

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

    • getReferenceContainersOf

      default List<org.glassfish.api.admin.config.ReferenceContainer> getReferenceContainersOf(Config config)

    • getInstancesOnNode

      default List<Server> getInstancesOnNode(String nodeName)

    • getClustersOnNode

      default List<Cluster> getClustersOnNode(String nodeName)

    • getExtensionByType

      <T extends DomainExtension> T getExtensionByType(Class<T> type)

    • checkIfExtensionExists

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