Package fish.payara.enterprise.config.serverbeans

Interface DeploymentGroup

All Superinterfaces:

ConfigBeanProxy, Named, jakarta.validation.Payload, PropertyBag, RefContainer

public interface DeploymentGroup
extends Named, jakarta.validation.Payload, RefContainer, PropertyBag

Author:

Steve Millidge (Payara Foundation)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DeploymentGroup.Duck

Method Summary

Modifier and Type	Method	Description
void	createResourceRef(String enabled, String refName)
void	deleteResourceRef(String refName)
ApplicationRef	getApplicationRef(String appName)
List<DGServerRef>	getDGServerRef()	Gets the value of the serverRef property.
DGServerRef	getDGServerRefByRef(String ref)
List<Server>	getInstances()
@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",message="{dg.invalid.name}",payload=DeploymentGroup.class) String	getName()	Name of the configured object
List<Property>	getProperty()	Properties as per PropertyBag
ResourceRef	getResourceRef(String refName)
boolean	isResourceRefExists(String refName)
void	setName(String value)	Sets the deployment group name

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

Method Detail

setName

void setName(String value)
      throws PropertyVetoException

Sets the deployment group name

Specified by:

setName in interface Named

Parameters:

value - cluster name

Throws:

PropertyVetoException - if a listener vetoes the change

getName

@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",
         message="{dg.invalid.name}",
         payload=DeploymentGroup.class)
@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",message="{dg.invalid.name}",payload=DeploymentGroup.class) String getName()

Description copied from interface: Named

Name of the configured object

Specified by:

getName in interface Named

Returns:

name of the configured object

getDGServerRef

List<DGServerRef> getDGServerRef()

Gets the value of the serverRef property. List of servers in the cluster

Returns:

list of configured ServerRef

getInstances

@DuckTyped
List<Server> getInstances()

getDGServerRefByRef

@DuckTyped
DGServerRef getDGServerRefByRef(String ref)

getApplicationRef

@DuckTyped
ApplicationRef getApplicationRef(String appName)

getResourceRef

@DuckTyped
ResourceRef getResourceRef(String refName)

isResourceRefExists

@DuckTyped
boolean isResourceRefExists(String refName)

createResourceRef

@DuckTyped
void createResourceRef(String enabled,
                       String refName)
                throws TransactionFailure

Throws:

TransactionFailure

deleteResourceRef

@DuckTyped
void deleteResourceRef(String refName)
                throws TransactionFailure

Throws:

TransactionFailure

getProperty

@PropertiesDesc(props={})
List<Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface PropertyBag

Returns:

the list of properties