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 Details

    • setName

      void setName(String name) throws PropertyVetoException
      Sets the node name.
      Specified by:
      setName in interface org.glassfish.api.admin.config.Named
      Parameters:
      name - 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

    • setNodeDir

      void setNodeDir(String nodeDir) throws PropertyVetoException
      Sets the value of the node-dir, top-level parent directory of node(s).
      Parameters:
      nodeDir - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

    • 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

    • setNodeHost

      void setNodeHost(String nodeHost) throws PropertyVetoException
      Sets the value of the nodeHost property.
      Parameters:
      nodeHost - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

    • getInstallDir

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

    • setInstallDir

      void setInstallDir(String installDir) throws PropertyVetoException
      Sets the value of install-dir, the GlassFish installation root.
      Parameters:
      installDir - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

    • getType

      String getType()

    • setType

      void setType(String type) throws PropertyVetoException
      Sets the value of type of this node.
      Parameters:
      type - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

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

    • setWindowsDomain

      void setWindowsDomain(String windowsDomain) throws PropertyVetoException
      Sets the value of the Windows domain property.
      Parameters:
      windowsDomain - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

    • getFreeze

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

    • setFreeze

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

    • getSshConnector

      SshConnector getSshConnector()

    • setSshConnector

      void setSshConnector(SshConnector connector)

    • getInstallDirUnixStyle

      default 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 interpreted as escape chars.

      Returns:
      the install dir with separators as forward slashes

    • getNodeDirUnixStyle

      default 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 interpreted as escape chars.

      Returns:
      the node dir with separators as forward slashes

    • getNodeDirAbsolute

      default 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

      default String getNodeDirAbsoluteUnixStyle()

    • nodeInUse

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

    • isDefaultLocalNode

      default boolean isDefaultLocalNode()
      True if this is the default local node.

      Example: localhost-domain1.

      Returns:
      true if this is the default local node, false otherwise

    • isLocal

      default boolean isLocal()
      True if the node's nodeHost is local to this.
      Returns:
      true if the node's host is local to this, false otherwise

    • instanceCreationAllowed

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