com.sun.enterprise.config.serverbeans

Interface Domain

All Superinterfaces:

ConfigBeanProxy, ConfigLoader, PropertyBag, SystemPropertyBag

public interface Domain
extends ConfigBeanProxy, PropertyBag, SystemPropertyBag, ConfigLoader

Top level Domain Element that includes applications, resources, configs, servers, clusters and node-agents, load balancer configurations and load balancers. node-agents and load balancers are SE/EE related entities only.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Domain.Duck

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOMAIN_NAME_PROPERTY

Method Summary

Modifier and Type	Method and Description
<P extends ConfigBeanProxy> boolean	checkIfExtensionExists(Class<P> configBeanType)
List<Application>	getAllDefinedSystemApplications()
List<ReferenceContainer>	getAllReferenceContainers()
List<String>	getAllReferencedTargetsForApplication(String appName)
List<String>	getAllTargets()
ApplicationRef	getApplicationRefInServer(String sn, String name)
ApplicationRef	getApplicationRefInTarget(String appName, String target)
ApplicationRef	getApplicationRefInTarget(String appName, String target, boolean includeInstances)
List<ApplicationRef>	getApplicationRefsInServer(String sn)
List<ApplicationRef>	getApplicationRefsInTarget(String target)
String	getApplicationRoot() Gets the value of the applicationRoot property.
@NotNull Applications	getApplications() Gets the value of the applications property.
List<Application>	getApplicationsInTarget(String target)
Cluster	getClusterForInstance(String instanceName)
Cluster	getClusterNamed(String name)
@NotNull Clusters	getClusters() Gets the value of the clusters property.
List<Cluster>	getClustersOnNode(String nodeName)
Config	getConfigNamed(String name)
@NotNull Configs	getConfigs() Gets the value of the configs property.
DeploymentGroup	getDeploymentGroupNamed(String target)
@NotNull DeploymentGroups	getDeploymentGroups() Gets the value of the deployment groups property.
List<DeploymentGroup>	getDeploymentGroupsForInstance(String namedInstance)
String	getEnabledForApplication(String target, String appName)
<T extends DomainExtension> T	getExtensionByType(Class<T> type)
List<DomainExtension>	getExtensions()
List<Server>	getInstancesOnNode(String nodeName)
String	getLocale() Gets the value of the locale property.
String	getLogRoot() Gets the value of the logRoot property.
String	getName()
NodeAgents	getNodeAgents() Gets the value of the nodeAgents property.
Node	getNodeNamed(String name)
Nodes	getNodes() Gets the value of the nodes property.
List<Property>	getProperty() Properties as per PropertyBag
ReferenceContainer	getReferenceContainerNamed(String name)
List<ReferenceContainer>	getReferenceContainersOf(Config config)
@NotNull Resources	getResources() Gets the value of the resources property.
SecureAdmin	getSecureAdmin() Gets the SecureAdmin value defined in the domain.
Server	getServerNamed(String name)
@NotNull Servers	getServers() Gets the value of the servers property.
List<Server>	getServersInTarget(String target)
Application	getSystemApplicationReferencedFrom(String sn, String appName)
@NotNull SystemApplications	getSystemApplications()
List<Application>	getSystemApplicationsReferencedFrom(String sn) Returns the list of system-applications that are referenced from the given server.
List<SystemProperty>	getSystemProperty() Gets the value of the systemProperty property.
List<String>	getTargets(String tgt)
String	getVersion() Gets the value of the version property.
String	getVirtualServersForApplication(String target, String appName)
boolean	isAppEnabledInTarget(String appName, String target)
boolean	isAppRefEnabledInTarget(String appName, String target)
boolean	isAppReferencedByPaaSTarget(String appName)
boolean	isCurrentInstanceMatchingTarget(String target, String appName, String currentInstance, List<String> referencedTargets)
boolean	isNamedSystemApplicationReferencedFrom(String appName, String serverName)
boolean	isServer(String name)
void	setApplicationRoot(String value) Sets the value of the applicationRoot property.
void	setApplications(Applications value) Sets the value of the system-applications property.
void	setClusters(Clusters value) Sets the value of the clusters property.
void	setConfigs(Configs value) Sets the value of the configs property.
void	setDeploymentGroups(DeploymentGroups value) Sets the value of the deployment groups property.
void	setLocale(String value) Sets the value of the locale property.
void	setLogRoot(String value) Sets the value of the logRoot property.
void	setNodeAgents(NodeAgents value) Sets the value of the nodeAgents property.
void	setNodes(Nodes value) Sets the value of the nodes property.
void	setResources(Resources value) Sets the value of the resources property.
void	setSecureAdmin(SecureAdmin secureAdmin) Sets the SecureAdmin value.
void	setServers(Servers value) Sets the value of the servers property.
void	setSystemApplications(SystemApplications value) Sets the value of the system-applications property.

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

containsProperty, getPropertyValue, getSystemProperty, getSystemPropertyValue

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Field Detail

DOMAIN_NAME_PROPERTY

static final String DOMAIN_NAME_PROPERTY

See Also:

Constant Field Values

Method Detail

getApplicationRoot

String getApplicationRoot()

Gets the value of the applicationRoot property. For PE this defines the location where applications are deployed

Returns:

possible object is String

setApplicationRoot

void setApplicationRoot(String value)
                 throws PropertyVetoException

Sets the value of the applicationRoot property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLogRoot

String getLogRoot()

Gets the value of the logRoot property. Specifies where the server instance's log files are kept, including HTTP access logs, server logs, and transaction logs. Default is $INSTANCE-ROOT/logs

Returns:

possible object is String

setLogRoot

void setLogRoot(String value)
         throws PropertyVetoException

Sets the value of the logRoot property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLocale

String getLocale()

Gets the value of the locale property.

Returns:

possible object is String

setLocale

void setLocale(String value)
        throws PropertyVetoException

Sets the value of the locale property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getVersion

String getVersion()

Gets the value of the version property. It is read-only. Tools are not to depend on this property. It is only for reference.

Returns:

String representing version of the Domain.

getSecureAdmin

SecureAdmin getSecureAdmin()

Gets the SecureAdmin value defined in the domain.

Returns:

SecureAdmin

setSecureAdmin

void setSecureAdmin(SecureAdmin secureAdmin)

Sets the SecureAdmin value.

Parameters:

secureAdmin -

getApplications

@NotNull
@NotNull Applications getApplications()

Gets the value of the applications property.

Returns:

possible object is Applications

setApplications

void setApplications(Applications value)
              throws PropertyVetoException

Sets the value of the system-applications property.

Parameters:

value - allowed object is Applications

Throws:

PropertyVetoException

getSystemApplications

@NotNull
@NotNull SystemApplications getSystemApplications()

setSystemApplications

void setSystemApplications(SystemApplications value)
                    throws PropertyVetoException

Sets the value of the system-applications property.

Parameters:

value - allowed object is Applications

Throws:

PropertyVetoException

getResources

@NotNull
@NotNull Resources getResources()

Gets the value of the resources property.

Returns:

possible object is Resources

setResources

void setResources(Resources value)
           throws PropertyVetoException

Sets the value of the resources property.

Parameters:

value - allowed object is Resources

Throws:

PropertyVetoException

getConfigs

@NotNull
@NotNull Configs getConfigs()

Gets the value of the configs property.

Returns:

possible object is Configs

setConfigs

void setConfigs(Configs value)
         throws PropertyVetoException

Sets the value of the configs property.

Parameters:

value - allowed object is Configs

Throws:

PropertyVetoException

getServers

@NotNull
@NotNull Servers getServers()

Gets the value of the servers property.

Returns:

possible object is Servers

setServers

void setServers(Servers value)
         throws PropertyVetoException

Sets the value of the servers property.

Parameters:

value - allowed object is Servers

Throws:

PropertyVetoException

getClusters

@NotNull
@NotNull Clusters getClusters()

Gets the value of the clusters property.

Returns:

possible object is Clusters

setClusters

void setClusters(Clusters value)
          throws PropertyVetoException

Sets the value of the clusters property.

Parameters:

value - allowed object is Clusters

Throws:

PropertyVetoException

getDeploymentGroups

@NotNull
@NotNull DeploymentGroups getDeploymentGroups()

Gets the value of the deployment groups property.

Returns:

possible object is DeploymentGroups

setDeploymentGroups

void setDeploymentGroups(DeploymentGroups value)
                  throws PropertyVetoException

Sets the value of the deployment groups property.

Parameters:

value - allowed object is DeploymentGroups

Throws:

PropertyVetoException

getNodes

Nodes getNodes()

Gets the value of the nodes property.

Returns:

possible object is Nodes

setNodes

void setNodes(Nodes value)
       throws PropertyVetoException

Sets the value of the nodes property.

Parameters:

value - allowed object is Nodes

Throws:

PropertyVetoException

getNodeAgents

NodeAgents getNodeAgents()

Gets the value of the nodeAgents property.

Returns:

possible object is NodeAgents

setNodeAgents

void setNodeAgents(NodeAgents value)
            throws PropertyVetoException

Sets the value of the nodeAgents property.

Parameters:

value - allowed object is NodeAgents

Throws:

PropertyVetoException

getSystemProperty

@ToDo(priority=IMPORTANT,
      details="Any more legal system properties?")
 @PropertiesDesc(systemProperties=true,props={@PropertyDesc(name="com.sun.aas.installRoot",description="Operating system dependent. Path to the directory where the server is installed"),@PropertyDesc(name="com.sun.aas.instanceRoot",description="Operating system dependent. Path to the top level directory for a server instance"),@PropertyDesc(name="com.sun.aas.hostName",description="Operating system dependent. Path to the name of the host (machine)"),@PropertyDesc(name="com.sun.aas.javaRoot",description="Operating system dependent. Path to the library directory for the Sun GlassFish Message Queue software"),@PropertyDesc(name="com.sun.aas.imqLib",description="Operating system dependent. Path to the installation directory for the Java runtime"),@PropertyDesc(name="com.sun.aas.imqLib",description="Operating system dependent. Path to the installation directory for the Java runtime"),@PropertyDesc(name="com.sun.aas.configName",defaultValue="server-config",description="Name of the <config> used by a server instance"),@PropertyDesc(name="com.sun.aas.instanceName",defaultValue="server1",description="Name of the server instance. Not used in the default configuration, but can be used to customize configuration"),@PropertyDesc(name="com.sun.aas.domainName",defaultValue="domain1",description="Name of the domain. Not used in the default configuration, but can be used to customize configuration")})
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

Returns:

getProperty

@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
 @PropertiesDesc(props={})
List<Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface PropertyBag

Returns:

getExtensions

List<DomainExtension> getExtensions()

getName

@DuckTyped
String getName()

getAllDefinedSystemApplications

@DuckTyped
List<Application> getAllDefinedSystemApplications()

getApplicationRefInServer

@DuckTyped
ApplicationRef getApplicationRefInServer(String sn,
                                                    String name)

getApplicationRefsInServer

@DuckTyped
List<ApplicationRef> getApplicationRefsInServer(String sn)

getSystemApplicationsReferencedFrom

@DuckTyped
List<Application> getSystemApplicationsReferencedFrom(String sn)

Returns the list of system-applications that are referenced from the given server. A server references an application, if the server has an element named <application-ref> in it that points to given application. The given server is a <server> element inside domain.

Parameters:

sn - the string denoting name of the server

Returns:

List of system-applications for that server, an empty list in case there is none

getSystemApplicationReferencedFrom

@DuckTyped
Application getSystemApplicationReferencedFrom(String sn,
                                                          String appName)

isNamedSystemApplicationReferencedFrom

@DuckTyped
boolean isNamedSystemApplicationReferencedFrom(String appName,
                                                          String serverName)

getServerNamed

@DuckTyped
Server getServerNamed(String name)

isServer

@DuckTyped
boolean isServer(String name)

getConfigNamed

@DuckTyped
Config getConfigNamed(String name)

getClusterNamed

@DuckTyped
Cluster getClusterNamed(String name)

getNodeNamed

@DuckTyped
Node getNodeNamed(String name)

isCurrentInstanceMatchingTarget

@DuckTyped
boolean isCurrentInstanceMatchingTarget(String target,
                                                   String appName,
                                                   String currentInstance,
                                                   List<String> referencedTargets)

getServersInTarget

@DuckTyped
List<Server> getServersInTarget(String target)

getApplicationRefsInTarget

@DuckTyped
List<ApplicationRef> getApplicationRefsInTarget(String target)

getApplicationRefInTarget

@DuckTyped
ApplicationRef getApplicationRefInTarget(String appName,
                                                    String target)

getApplicationRefInTarget

@DuckTyped
ApplicationRef getApplicationRefInTarget(String appName,
                                                    String target,
                                                    boolean includeInstances)

isAppRefEnabledInTarget

@DuckTyped
boolean isAppRefEnabledInTarget(String appName,
                                           String target)

isAppEnabledInTarget

@DuckTyped
boolean isAppEnabledInTarget(String appName,
                                        String target)

isAppReferencedByPaaSTarget

@DuckTyped
boolean isAppReferencedByPaaSTarget(String appName)

getAllReferencedTargetsForApplication

@DuckTyped
List<String> getAllReferencedTargetsForApplication(String appName)

getAllTargets

@DuckTyped
List<String> getAllTargets()

getTargets

@DuckTyped
List<String> getTargets(String tgt)

getApplicationsInTarget

@DuckTyped
List<Application> getApplicationsInTarget(String target)

getVirtualServersForApplication

@DuckTyped
String getVirtualServersForApplication(String target,
                                                  String appName)

getEnabledForApplication

@DuckTyped
String getEnabledForApplication(String target,
                                           String appName)

getReferenceContainerNamed

@DuckTyped
ReferenceContainer getReferenceContainerNamed(String name)

getClusterForInstance

@DuckTyped
Cluster getClusterForInstance(String instanceName)

getAllReferenceContainers

@DuckTyped
List<ReferenceContainer> getAllReferenceContainers()

getReferenceContainersOf

@DuckTyped
List<ReferenceContainer> getReferenceContainersOf(Config config)

getInstancesOnNode

@DuckTyped
List<Server> getInstancesOnNode(String nodeName)

getClustersOnNode

@DuckTyped
List<Cluster> getClustersOnNode(String nodeName)

getExtensionByType

<T extends DomainExtension> T getExtensionByType(Class<T> type)

checkIfExtensionExists

@DuckTyped
<P extends ConfigBeanProxy> boolean checkIfExtensionExists(Class<P> configBeanType)

Type Parameters:

P - Type that extends the ConfigBeanProxy which is the type of class we accept as parameter

Parameters:

configBeanType - The config bean type we want to check whether the configuration exists for it or not.

Returns:

true if configuration for the type exists in the target area of domain.xml and false if not.

getDeploymentGroupNamed

@DuckTyped
DeploymentGroup getDeploymentGroupNamed(String target)

getDeploymentGroupsForInstance

@DuckTyped
List<DeploymentGroup> getDeploymentGroupsForInstance(String namedInstance)