Package com.sun.enterprise.config.serverbeans

Interface Node

  • All Superinterfaces:
    org.jvnet.hk2.config.ConfigBeanProxy, org.glassfish.api.admin.config.Named, jakarta.validation.Payload, RefContainer, org.glassfish.api.admin.config.ReferenceContainer
    public interface Node
extends org.jvnet.hk2.config.ConfigBeanProxy, org.glassfish.api.admin.config.Named, org.glassfish.api.admin.config.ReferenceContainer, RefContainer, jakarta.validation.Payload
    A cluster defines a homogeneous set of server instances that share the same applications, resources, and configuration.

    • Method Detail

      • setName

        void setName​(String value)
      throws PropertyVetoException
        Sets the node name
        Specified by:
        setName in interface org.glassfish.api.admin.config.Named
        Parameters:
        value - node name
        Throws:
        PropertyVetoException - if a listener vetoes the change

      • getName

        @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",
         message="{node.invalid.name}",
         payload=Node.class)
@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",message="{node.invalid.name}",payload=Node.class) String getName()
        Specified by:
        getName in interface org.glassfish.api.admin.config.Named

      • getNodeDir

        String getNodeDir()
        points to the parent directory of the node(s) directory.
        Returns:
        path location of node-dir

      • getNodeHost

        @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*",
         message="{nodehost.invalid.name}",
         payload=Node.class)
@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*",message="{nodehost.invalid.name}",payload=Node.class) String getNodeHost()
        points to a named host.
        Returns:
        a named host name

      • getInstallDir

        String getInstallDir()
        points to a GlassFish installation root
        Returns:
        value of install-dir

      • getWindowsDomain

        @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*",
         message="{windowsdomain.invalid.name}",
         payload=Node.class)
@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*",message="{windowsdomain.invalid.name}",payload=Node.class) String getWindowsDomain()
        specifies the windows domain if applicable
        Returns:
        the Windows domain name.

      • getFreeze

        String getFreeze()
        true if node is frozen and we should not allow new instances to be created on the nod.
        Returns:
        "true" if node is frozen

      • setFreeze

        void setFreeze​(String value)
        throws PropertyVetoException
        Sets the value of the freeze
        Parameters:
        value - "true" to freeze node and not allow instances to be created
        Throws:
        PropertyVetoException - if a listener vetoes the change

      • setSshConnector

        void setSshConnector​(SshConnector connector)

      • getInstallDirUnixStyle

        @DuckTyped
String getInstallDirUnixStyle()
        Returns the install dir with separators as forward slashes. This is needed to run commands over SSH tools on Windows where the backslashes are interpruted as escape chars.
        Returns:
        the install dir with separators as forward slashes

      • getNodeDirUnixStyle

        @DuckTyped
String getNodeDirUnixStyle()
        Returns the node dir with separators as forward slashes. This is needed to run commands over SSH tools on Windows where the backslashes are interpruted as escape chars.
        Returns:
        the node dir with separators as forward slashes

      • getNodeDirAbsolute

        @DuckTyped
String getNodeDirAbsolute()
        Returns the node dir as an absolute path. If the node dir path in the Node element is relative this will make it absolute relative to the node's installdir.
        Returns:
        the node's nodedir as an absolute path. Null if no nodedir.

      • getNodeDirAbsoluteUnixStyle

        @DuckTyped
String getNodeDirAbsoluteUnixStyle()

      • nodeInUse

        @DuckTyped
boolean nodeInUse()
        Is a node being used by any server instance?
        Returns:
        true if node is referenced by any server instance, else false.

      • isDefaultLocalNode

        @DuckTyped
boolean isDefaultLocalNode()
        True if this is the default local node. Example: localhost-domain1
        Returns:

      • isLocal

        @DuckTyped
boolean isLocal()
        True if the node's nodeHost is local to this
        Returns:

      • instanceCreationAllowed

        @DuckTyped
boolean instanceCreationAllowed()
        Does the node allow instance creation?
        Returns:
        true if node allows instance creation, else false