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

Nested Classes

Modifier and Type	Interface and Description
static class	ServerEnvironment.Status

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_INSTANCE_NAME
static String	kCompileJspDirName folder where the compiled JSP pages reside

Method Summary

Methods

Modifier and Type	Method and Description
File	getApplicationAltDDPath() Gets the directory to store external alternate deployment descriptor Normally ROOT/generated/altdd
File	getApplicationCompileJspPath() Returns the path for compiled JSP Pages from an application that is deployed on this instance.
File	getApplicationEJBStubPath()
File	getApplicationGeneratedXMLPath()
File	getApplicationPolicyFilePath()
File	getApplicationRepositoryPath() Gets the directory to store deployed applications Normally ROOT/applications
File	getApplicationStubPath() Gets the directory to store generated stuff.
File	getConfigDirPath()
File	getDomainRoot() Deprecated. As of GlassFish 3.1 replaced with getInstanceRoot()
String	getInstanceName() Every server has a name that can be found in the server element in domain.xml
File	getInstanceRoot()
File	getJKS() A Java KeyStore which is locked by administrator's master password.
File	getLibPath() Gets the directory for hosting user-provided jar files.
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
File	getTrustStore() The truststore used by the server.
boolean	isDas()
boolean	isInstance()

Field Detail

kCompileJspDirName

static final String kCompileJspDirName

folder where the compiled JSP pages reside

See Also:

Constant Field Values

DEFAULT_INSTANCE_NAME

static final String DEFAULT_INSTANCE_NAME

See Also:

Constant Field Values

Method Detail

getDomainRoot

@Deprecated
File getDomainRoot()

Deprecated. As of GlassFish 3.1 replaced with getInstanceRoot()

Returns:

the instance root

getInstanceRoot

File getInstanceRoot()

getStartupContext

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

return the startup context used to initialize this runtime

getConfigDirPath

File getConfigDirPath()

getLibPath

File getLibPath()

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

getApplicationRepositoryPath

File getApplicationRepositoryPath()

Gets the directory to store deployed applications Normally ROOT/applications

getApplicationStubPath

File getApplicationStubPath()

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

getApplicationCompileJspPath

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

File getApplicationGeneratedXMLPath()

getApplicationEJBStubPath

File getApplicationEJBStubPath()

getApplicationPolicyFilePath

File getApplicationPolicyFilePath()

getApplicationAltDDPath

File getApplicationAltDDPath()

Gets the directory to store external alternate deployment descriptor Normally ROOT/generated/altdd

getMasterPasswordFile

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

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

File getTrustStore()

The truststore used by the server.

Returns:

File for the truststore

getStatus

ServerEnvironment.Status getStatus()

Gets the server status

getRuntimeType

RuntimeType getRuntimeType()

Returns the process type of this instance.

Returns:

the instance process type

getInstanceName

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()