Interface Server
-
- All Superinterfaces:
ConfigBeanProxy
,Named
,jakarta.validation.Payload
,PropertyBag
,RefContainer
,ReferenceContainer
,SystemPropertyBag
@ConfigRefConstraint(message="{configref.invalid}", payload=ConfigRefValidator.class) @ReferenceConstraint(skipDuringCreation=true, payload=Server.class) public interface Server extends ConfigBeanProxy, PropertyBag, Named, SystemPropertyBag, ReferenceContainer, RefContainer, jakarta.validation.Payload
Java EE Application Server Configuration Each Application Server instance is a Java 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Server.CreateDecorator
static class
Server.DeleteDecorator
static class
Server.Duck
-
Field Summary
Fields Modifier and Type Field Description static String
lbEnabledSystemProperty
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
createResourceRef(String enabled, String refName)
void
deleteResourceRef(String name)
String
getAdminHost()
int
getAdminPort()
ApplicationRef
getApplicationRef(String appName)
Cluster
getCluster()
Returns the cluster instance this instance is referenced in or null if there is no cluster referencing this server instance.Config
getConfig()
@NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*") String
getConfigRef()
Gets the value of the configRef property.List<DeploymentGroup>
getDeploymentGroup()
String
getDockerContainerId()
@Min(1L) String
getLbWeight()
Gets the value of the lbWeight property.@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",message="{server.invalid.name}",payload=Server.class) String
getName()
Name of the configured objectString
getNodeAgentRef()
Deprecated.String
getNodeRef()
Gets the value of the node property.List<Property>
getProperty()
Properties as perPropertyBag
String
getReference()
ResourceRef
getResourceRef(String name)
List<SystemProperty>
getSystemProperty()
Gets the value of the systemProperty property.boolean
isCluster()
boolean
isDas()
boolean
isInstance()
boolean
isResourceRefExists(String refName)
boolean
isRunning()
boolean
isServer()
void
setConfigRef(String value)
Sets the value of the configRef property.void
setDockerContainerId(String dockerContainerId)
void
setLbWeight(String value)
Sets the value of the lbWeight property.void
setName(String value)
void
setNodeAgentRef(String value)
Deprecated.void
setNodeRef(String value)
Sets the value of the node property.-
Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy
createChild, deepCopy, getParent, getParent
-
Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag
addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty
-
Methods inherited from interface com.sun.enterprise.config.serverbeans.RefContainer
getApplicationRef, getResourceRef
-
Methods inherited from interface org.glassfish.api.admin.config.ReferenceContainer
isDeploymentGroup
-
Methods inherited from interface com.sun.enterprise.config.serverbeans.SystemPropertyBag
containsProperty, getPropertyValue, getSystemProperty, getSystemPropertyValue
-
-
-
-
Field Detail
-
lbEnabledSystemProperty
static final String lbEnabledSystemProperty
- See Also:
- Constant Field Values
-
-
Method Detail
-
setName
void setName(String value) throws PropertyVetoException
- Specified by:
setName
in interfaceNamed
- 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()
Description copied from interface:Named
Name of the configured object
-
getConfigRef
@NotNull @Pattern(regexp="[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\\-_\\.;]*") 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 value) throws PropertyVetoException
Sets the value of the configRef property.- Parameters:
value
- allowed object isString
- 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 value) throws PropertyVetoException
Deprecated.Sets the value of the nodeAgentRef property.- Parameters:
value
- allowed object isString
- Throws:
PropertyVetoException
- if a listener vetoes the change
-
setNodeRef
void setNodeRef(String value) throws PropertyVetoException
Sets the value of the node property.- Parameters:
value
- allowed object isString
- Throws:
PropertyVetoException
- if a listener vetoes the change
-
getNodeRef
String getNodeRef()
Gets the value of the node 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 value) throws PropertyVetoException
Sets the value of the lbWeight property.- Parameters:
value
- allowed object isString
- Throws:
PropertyVetoException
- if a listener vetoes the change
-
getDockerContainerId
String getDockerContainerId()
-
setDockerContainerId
void setDockerContainerId(String dockerContainerId) throws PropertyVetoException
- Throws:
PropertyVetoException
-
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 aset
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 listSystemProperty
- Specified by:
getSystemProperty
in interfaceSystemPropertyBag
- Returns:
-
getProperty
@ToDo(priority=IMPORTANT, details="Provide PropertyDesc for legal props") @PropertiesDesc(props={}) List<Property> getProperty()
Properties as perPropertyBag
- Specified by:
getProperty
in interfacePropertyBag
- Returns:
- the property list
-
getReference
@DuckTyped String getReference()
- Specified by:
getReference
in interfaceReferenceContainer
-
getResourceRef
@DuckTyped ResourceRef getResourceRef(String name)
-
isResourceRefExists
@DuckTyped boolean isResourceRefExists(String refName)
-
deleteResourceRef
@DuckTyped void deleteResourceRef(String name) throws TransactionFailure
- Throws:
TransactionFailure
-
createResourceRef
@DuckTyped void createResourceRef(String enabled, String refName) throws TransactionFailure
- Throws:
TransactionFailure
-
getApplicationRef
@DuckTyped ApplicationRef getApplicationRef(String appName)
-
getCluster
@DuckTyped 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
-
getDeploymentGroup
@DuckTyped List<DeploymentGroup> getDeploymentGroup()
-
isCluster
@DuckTyped boolean isCluster()
- Specified by:
isCluster
in interfaceReferenceContainer
-
isServer
@DuckTyped boolean isServer()
- Specified by:
isServer
in interfaceReferenceContainer
-
isDas
@DuckTyped boolean isDas()
- Specified by:
isDas
in interfaceReferenceContainer
-
isInstance
@DuckTyped boolean isInstance()
- Specified by:
isInstance
in interfaceReferenceContainer
-
getAdminHost
@DuckTyped String getAdminHost()
-
getAdminPort
@DuckTyped int getAdminPort()
-
getConfig
@DuckTyped Config getConfig()
-
isRunning
@DuckTyped boolean isRunning()
-
-