public interface Domain extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag, SystemPropertyBag, ConfigLoader
| Modifier and Type | Interface and Description |
|---|---|
static class |
Domain.Duck |
| Modifier and Type | Field and Description |
|---|---|
static String |
DOMAIN_NAME_PROPERTY |
| Modifier and Type | Method and Description |
|---|---|
<P extends org.jvnet.hk2.config.ConfigBeanProxy> |
checkIfExtensionExists(Class<P> configBeanType) |
List<Application> |
getAllDefinedSystemApplications() |
List<org.glassfish.api.admin.config.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.
|
Applications |
getApplications()
Gets the value of the applications property.
|
List<Application> |
getApplicationsInTarget(String target) |
Cluster |
getClusterForInstance(String instanceName) |
Cluster |
getClusterNamed(String name) |
Clusters |
getClusters()
Gets the value of the clusters property.
|
List<Cluster> |
getClustersOnNode(String nodeName) |
Config |
getConfigNamed(String name) |
Configs |
getConfigs()
Gets the value of the configs property.
|
String |
getEnabledForApplication(String target,
String appName) |
<T extends DomainExtension> |
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<org.jvnet.hk2.config.types.Property> |
getProperty()
Properties as per
PropertyBag |
org.glassfish.api.admin.config.ReferenceContainer |
getReferenceContainerNamed(String name) |
List<org.glassfish.api.admin.config.ReferenceContainer> |
getReferenceContainersOf(Config config) |
Resources |
getResources()
Gets the value of the resources property.
|
SecureAdmin |
getSecureAdmin()
Gets the SecureAdmin value defined in the domain.
|
Server |
getServerNamed(String name) |
Servers |
getServers()
Gets the value of the servers property.
|
List<Server> |
getServersInTarget(String target) |
Application |
getSystemApplicationReferencedFrom(String sn,
String appName) |
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 |
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.
|
getProperty, getPropertyValue, getPropertyValuecontainsProperty, getPropertyValue, getSystemProperty, getSystemPropertyValuestatic final String DOMAIN_NAME_PROPERTY
String getApplicationRoot()
Stringvoid setApplicationRoot(String value) throws PropertyVetoException
value - allowed object is
StringPropertyVetoExceptionString getLogRoot()
Stringvoid setLogRoot(String value) throws PropertyVetoException
value - allowed object is
StringPropertyVetoExceptionString getLocale()
Stringvoid setLocale(String value) throws PropertyVetoException
value - allowed object is
StringPropertyVetoExceptionString getVersion()
SecureAdmin getSecureAdmin()
SecureAdminvoid setSecureAdmin(SecureAdmin secureAdmin)
secureAdmin - @NotNull Applications getApplications()
Applicationsvoid setApplications(Applications value) throws PropertyVetoException
value - allowed object is
ApplicationsPropertyVetoException@NotNull SystemApplications getSystemApplications()
void setSystemApplications(SystemApplications value) throws PropertyVetoException
value - allowed object is
ApplicationsPropertyVetoException@NotNull Resources getResources()
Resourcesvoid setResources(Resources value) throws PropertyVetoException
value - allowed object is
ResourcesPropertyVetoException@NotNull Configs getConfigs()
Configsvoid setConfigs(Configs value) throws PropertyVetoException
value - allowed object is
ConfigsPropertyVetoException@NotNull Servers getServers()
Serversvoid setServers(Servers value) throws PropertyVetoException
value - allowed object is
ServersPropertyVetoException@NotNull Clusters getClusters()
Clustersvoid setClusters(Clusters value) throws PropertyVetoException
value - allowed object is
ClustersPropertyVetoExceptionvoid setNodes(Nodes value) throws PropertyVetoException
value - allowed object is
NodesPropertyVetoExceptionNodeAgents getNodeAgents()
NodeAgentsvoid setNodeAgents(NodeAgents value) throws PropertyVetoException
value - allowed object is
NodeAgentsPropertyVetoException@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 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()
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
SystemPropertygetSystemProperty in interface SystemPropertyBag@ToDo(priority=IMPORTANT,
details="Provide PropertyDesc for legal props")
@PropertiesDesc(props={})
List<org.jvnet.hk2.config.types.Property> getProperty()
PropertyBaggetProperty in interface org.jvnet.hk2.config.types.PropertyBagList<DomainExtension> getExtensions()
@DuckTyped String getName()
@DuckTyped List<Application> getAllDefinedSystemApplications()
@DuckTyped ApplicationRef getApplicationRefInServer(String sn, String name)
@DuckTyped List<ApplicationRef> getApplicationRefsInServer(String sn)
@DuckTyped List<Application> getSystemApplicationsReferencedFrom(String sn)
sn - the string denoting name of the server@DuckTyped Application getSystemApplicationReferencedFrom(String sn, String appName)
@DuckTyped boolean isNamedSystemApplicationReferencedFrom(String appName, String serverName)
@DuckTyped boolean isServer(String name)
@DuckTyped boolean isCurrentInstanceMatchingTarget(String target, String appName, String currentInstance, List<String> referencedTargets)
@DuckTyped List<ApplicationRef> getApplicationRefsInTarget(String target)
@DuckTyped ApplicationRef getApplicationRefInTarget(String appName, String target)
@DuckTyped ApplicationRef getApplicationRefInTarget(String appName, String target, boolean includeInstances)
@DuckTyped boolean isAppReferencedByPaaSTarget(String appName)
@DuckTyped List<String> getAllReferencedTargetsForApplication(String appName)
@DuckTyped List<Application> getApplicationsInTarget(String target)
@DuckTyped String getVirtualServersForApplication(String target, String appName)
@DuckTyped org.glassfish.api.admin.config.ReferenceContainer getReferenceContainerNamed(String name)
@DuckTyped List<org.glassfish.api.admin.config.ReferenceContainer> getAllReferenceContainers()
@DuckTyped List<org.glassfish.api.admin.config.ReferenceContainer> getReferenceContainersOf(Config config)
<T extends DomainExtension> T getExtensionByType(Class<T> type)
@DuckTyped <P extends org.jvnet.hk2.config.ConfigBeanProxy> boolean checkIfExtensionExists(Class<P> configBeanType)
P - Type that extends the ConfigBeanProxy which is the type of class we accept as parameterconfigBeanType - The config bean type we want to check whether the configuration exists for it or not.Copyright © 2013. All Rights Reserved.