Package com.sun.enterprise.config.serverbeans

Interface Server

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, org.glassfish.api.admin.config.Named, jakarta.validation.Payload, org.jvnet.hk2.config.types.PropertyBag, RefContainer, org.glassfish.api.admin.config.ReferenceContainer, SystemPropertyBag
@ConfigRefConstraint(message="{configref.invalid}", payload=ConfigRefValidator.class) @ReferenceConstraint(skipDuringCreation=true, payload=Server.class) public interface Server extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag, org.glassfish.api.admin.config.Named, SystemPropertyBag, org.glassfish.api.admin.config.ReferenceContainer, RefContainer, jakarta.validation.Payload
Jakarta EE Application Server Configuration.

Each Application Server instance is a Jakarta EE compliant container. One server instance is specially designated as the Administration Server in SE/EE User applications cannot be deployed to an Administration Server instance

  • Field Details

  • Method Details

    • setName

      void setName(String name) throws PropertyVetoException
      Specified by:
      setName in interface org.glassfish.api.admin.config.Named
      Throws:
      PropertyVetoException

    • getName

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

    • getConfigRef

      @NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*", message="Pattern: [A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*") @RemoteKey(message="{resourceref.invalid.configref}", type=Config.class) @NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",message="Pattern: [A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*") String getConfigRef()
      Gets the value of the configRef property.

      Points to a named config. Needed for stand-alone servers. If server instance is part of a cluster, then it points to the cluster config.

      Returns:
      possible object is String

    • setConfigRef

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

    • getNodeAgentRef

      @Deprecated String getNodeAgentRef()
      Deprecated.
      Gets the value of the nodeAgentRef property.

      SE/EE only. Specifies name of node agent where server instance is hosted.

      Returns:
      possible object is String

    • setNodeAgentRef

      @Deprecated void setNodeAgentRef(String agentRef) throws PropertyVetoException
      Deprecated.
      Sets the value of the nodeAgentRef property.
      Parameters:
      agentRef - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

    • setNodeRef

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

    • getNodeRef

      String getNodeRef()
      Gets the value of the nodeRef property.

      SE/EE only. Specifies name of node agent where server instance is hosted.

      Returns:
      possible object is String

    • getLbWeight

      @Min(1L) @Min(1L) String getLbWeight()
      Gets the value of the lbWeight property.

      Each server instance in a cluster has a weight, which may be used to represent the relative processing capacity of that instance. Default weight is 100 for every instance. Weighted load balancing policies will use this weight while load balancing requests within the cluster. It is the responsibility of the administrator to set the relative weights correctly, keeping in mind deployed hardware capacity.

      Returns:
      possible object is String

    • setLbWeight

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

    • getSystemProperty

      @ToDo(priority=IMPORTANT, details="Provide PropertyDesc for legal system properties") 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

    • getReference

      default String getReference()
      Specified by:
      getReference in interface org.glassfish.api.admin.config.ReferenceContainer

    • getResourceRef

      default ResourceRef getResourceRef(org.glassfish.api.naming.SimpleJndiName refName)

    • isResourceRefExists

      default boolean isResourceRefExists(org.glassfish.api.naming.SimpleJndiName refName)

    • deleteResourceRef

      default void deleteResourceRef(org.glassfish.api.naming.SimpleJndiName refName) throws org.jvnet.hk2.config.TransactionFailure
      Throws:
      org.jvnet.hk2.config.TransactionFailure

    • createResourceRef

      default void createResourceRef(String enabled, org.glassfish.api.naming.SimpleJndiName refName) throws org.jvnet.hk2.config.TransactionFailure
      Throws:
      org.jvnet.hk2.config.TransactionFailure

    • getApplicationRef

      default ApplicationRef getApplicationRef(String appName)

    • getCluster

      default Cluster getCluster()
      Returns the cluster instance this instance is referenced in or null if there is no cluster referencing this server instance.
      Returns:
      the cluster owning this instance or null if this is a standalone instance

    • isCluster

      default boolean isCluster()
      Specified by:
      isCluster in interface org.glassfish.api.admin.config.ReferenceContainer

    • isServer

      default boolean isServer()
      Specified by:
      isServer in interface org.glassfish.api.admin.config.ReferenceContainer

    • isDas

      default boolean isDas()
      Specified by:
      isDas in interface org.glassfish.api.admin.config.ReferenceContainer

    • isInstance

      default boolean isInstance()
      Specified by:
      isInstance in interface org.glassfish.api.admin.config.ReferenceContainer

    • getAdminHost

      default String getAdminHost()

    • getAdminPort

      default int getAdminPort()

    • getConfig

      default Config getConfig()

    • isRunning

      default boolean isRunning()
      This is NOT a reliable test. It just checks if ANYTHING has setup shop on the host and port. I wanted to run RemoteAdminCommand but that is (inexplicably) in admin/util -- and we would have a circular dependency.