org.glassfish.api.admin
Interface ServerEnvironment

@Contract
public interface ServerEnvironment

Allow access to the environment under which GlassFish operates. TODO : dochez : this needs to be reconciled with ServerContext and simplified...

Author:

Jerome Dochez

Nested Class Summary

static class

ServerEnvironment.Status

Field Summary

static java.lang.String	DEFAULT_INSTANCE_NAME
static java.lang.String	kCompileJspDirName folder where the compiled JSP pages reside

Method Summary

java.io.File	getApplicationCompileJspPath() Returns the path for compiled JSP Pages from an application that is deployed on this instance.
java.io.File	getApplicationEJBStubPath()
java.io.File	getApplicationGeneratedXMLPath()
java.io.File	getApplicationPolicyFilePath()
java.io.File	getApplicationRepositoryPath() Gets the directory to store deployed applications Normally ROOT/applications
java.io.File	getApplicationStubPath() Gets the directory to store generated stuff.
java.io.File	getConfigDirPath()
java.io.File	getDomainRoot() Deprecated. As of GlassFish 3.1 replaced with getInstanceRoot()
java.io.File	getDomainXML() The domain.xml config file
java.lang.String	getInstanceName() Every server has a name that can be found in the server element in domain.xml
java.io.File	getInstanceRoot()
java.io.File	getJKS() A Java KeyStore which is locked by administrator's master password.
java.io.File	getLibPath() Gets the directory for hosting user-provided jar files.
java.io.File	getMasterPasswordFile() A JCEKS keystore which is locked with a fixed-key.
RuntimeType	getRuntimeType() Returns the process type of this instance.
com.sun.enterprise.module.bootstrap.StartupContext	getStartupContext() return the startup context used to initialize this runtime
ServerEnvironment.Status	getStatus() Gets the server status
java.io.File	getTrustStore() The truststore used by the server.
boolean	isDas()
boolean	isInstance()

Field Detail

kCompileJspDirName

static final java.lang.String kCompileJspDirName

folder where the compiled JSP pages reside

See Also:

Constant Field Values

DEFAULT_INSTANCE_NAME

static final java.lang.String DEFAULT_INSTANCE_NAME

See Also:

Constant Field Values

Method Detail

getDomainRoot

@Deprecated
java.io.File getDomainRoot()

Deprecated. As of GlassFish 3.1 replaced with getInstanceRoot()

Returns:

the instance root

getInstanceRoot

java.io.File getInstanceRoot()

getStartupContext

com.sun.enterprise.module.bootstrap.StartupContext getStartupContext()

return the startup context used to initialize this runtime

getConfigDirPath

java.io.File getConfigDirPath()

getLibPath

java.io.File getLibPath()

Gets the directory for hosting user-provided jar files. Normally ROOT/lib

getApplicationRepositoryPath

java.io.File getApplicationRepositoryPath()

Gets the directory to store deployed applications Normally ROOT/applications

getApplicationStubPath

java.io.File getApplicationStubPath()

Gets the directory to store generated stuff. Normally ROOT/generated

getApplicationCompileJspPath

java.io.File getApplicationCompileJspPath()

Returns the path for compiled JSP Pages from an application that is deployed on this instance. By default all such compiled JSPs should lie in the same folder.

getApplicationGeneratedXMLPath

java.io.File getApplicationGeneratedXMLPath()

getApplicationEJBStubPath

java.io.File getApplicationEJBStubPath()

getApplicationPolicyFilePath

java.io.File getApplicationPolicyFilePath()

getMasterPasswordFile

java.io.File getMasterPasswordFile()

A JCEKS keystore which is locked with a fixed-key. This is the "security-by-obfuscation" carried over from V2.

Returns:

File representing the JCEKS store containing the real master password

getJKS

java.io.File getJKS()

A Java KeyStore which is locked by administrator's master password.

Returns:

File representing the JKS which is server's keystore in developer-product case

getTrustStore

java.io.File getTrustStore()

The truststore used by the server.

Returns:

File for the truststore

getDomainXML

java.io.File getDomainXML()

The domain.xml config file

Returns:

File for the domain.xml config file

getStatus

ServerEnvironment.Status getStatus()

Gets the server status

getRuntimeType

RuntimeType getRuntimeType()

Returns the process type of this instance.

Returns:

the instance process type

getInstanceName

java.lang.String getInstanceName()

Every server has a name that can be found in the server element in domain.xml

Returns:

the name of this server i.e. "my" name

isInstance

boolean isInstance()

isDas

boolean isDas()