Index (Simple Public APIs of Glassfish 7.1.0-M1 API)

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ApplicationClientClassLoader - Interface in org.glassfish.embeddable.client: Marks class loaders in gf-client and gf-client-module which can provide a container initialized by the Java agent.
ApplicationClientCLIEncoding - Class in org.glassfish.embeddable.client: This class is used to share arguments as a string property between Java Agent and Java Main class.
ApplicationClientContainer - Interface in org.glassfish.embeddable.client: Shared interface required to avoid circular dependency of gf-client.jar and gf-client-module.jar

B

bootstrap() - Static method in class org.glassfish.embeddable.GlassFishRuntime: Bootstrap a GlassFishRuntime with default BootstrapProperties.
bootstrap(BootstrapProperties) - Static method in class org.glassfish.embeddable.GlassFishRuntime: Bootstrap GlassFish runtime based on runtime configuration passed in the bootstrapProperties object.
bootstrap(BootstrapProperties, ClassLoader) - Static method in class org.glassfish.embeddable.GlassFishRuntime: Bootstrap GlassFish runtime based on runtime configuration passed in the bootstrapProperties object.
BootstrapProperties - Class in org.glassfish.embeddable: Encapsulates the set of properties required to bootstrap GlassFishRuntime.
BootstrapProperties() - Constructor for class org.glassfish.embeddable.BootstrapProperties: Create BootstrapProperties with default properties.
BootstrapProperties(Properties) - Constructor for class org.glassfish.embeddable.BootstrapProperties: Create BootstrapProperties with custom properties.
build(BootstrapProperties) - Method in interface org.glassfish.embeddable.spi.RuntimeBuilder: Builds a custom GlassFishRuntime with the supplied bootstrap options
build(BootstrapProperties, ClassLoader) - Method in interface org.glassfish.embeddable.spi.RuntimeBuilder: Builds a custom GlassFishRuntime with the supplied bootstrap options

C

CommandResult - Interface in org.glassfish.embeddable: Encapsulates the result of a command invoked using CommandRunner.run(java.lang.String, java.lang.String...).
CommandResult.ExitStatus - Enum Class in org.glassfish.embeddable: A command can have following types of exit status.
CommandRunner - Interface in org.glassfish.embeddable: GlassFish has a very sophisticated command line interface (CLI) viz., 'asadmin' to executive administrative commands.
CONFIG_FILE_READ_ONLY - Static variable in class org.glassfish.embeddable.GlassFishProperties: Key for specifying whether the specified configuration file (domain.xml) or config/domain.xml at the user specified instanceRoot should be operated by GlassFish in read only mode or not.
CONFIG_FILE_URI_PROP_NAME - Static variable in class org.glassfish.embeddable.GlassFishProperties: Key for specifying absolute URI which configuration file (domain.xml) GlassFish should run with.
CONFIG_ROOT - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Directory with asenv.conf, GlassFishVariable.INSTALL_ROOT/config

D

decodeArg(String) - Static method in class org.glassfish.embeddable.client.ApplicationClientCLIEncoding: Replaces occurrences of comma encoding with commas.
deploy(File, String...) - Method in interface org.glassfish.embeddable.Deployer: Deploys an application identified by a file.
deploy(InputStream, String...) - Method in interface org.glassfish.embeddable.Deployer: Deploys an application from the specified InputStream object.
deploy(URI, String...) - Method in interface org.glassfish.embeddable.Deployer: Deploys an application identified by a URI.
Deployer - Interface in org.glassfish.embeddable: Deployer service for GlassFish.
DERBY_ROOT - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Derby database main directory, containing lib directory with jar files.
displayAndExit() - Method in exception class org.glassfish.embeddable.client.UserError: Displays the user error message, and any messages along the exception chain, if any, and then exits.
dispose() - Method in interface org.glassfish.embeddable.GlassFish: Call this method if you don't need this GlassFish instance any more.
DISPOSED - Enum constant in enum class org.glassfish.embeddable.GlassFish.Status: GlassFish is disposed and ready to be garbage collected.
DOMAINS_ROOT - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Directory where we have domains

E

encodeArg(String) - Static method in class org.glassfish.embeddable.client.ApplicationClientCLIEncoding: Replaces commas in an argument value (which can confuse the ACC agent argument parsing because shells strip out double-quotes) with a special sequence.

F

FAILURE - Enum constant in enum class org.glassfish.embeddable.CommandResult.ExitStatus
formatUserError(String, String...) - Static method in exception class org.glassfish.embeddable.client.UserError: Creates a new UserError instance having formatted the message with the arguments provided.

G

getApplicationClientContainer() - Method in interface org.glassfish.embeddable.client.ApplicationClientClassLoader
getCommandRunner() - Method in interface org.glassfish.embeddable.GlassFish: Gets a CommandRunner instance, using which the user can run asadmin commands.
getConfigFileURI() - Method in class org.glassfish.embeddable.GlassFishProperties: Get the absolute configurationFileURI set using GlassFishProperties.setConfigFileURI(String)
getDeployedApplications() - Method in interface org.glassfish.embeddable.Deployer: Return names of all the deployed applications.
getDeployer() - Method in interface org.glassfish.embeddable.GlassFish: Gets a Deployer instance to deploy an application.
getEnvName() - Method in enum class org.glassfish.embeddable.GlassFishVariable
getEnvToSystemPropertyMapping() - Static method in enum class org.glassfish.embeddable.GlassFishVariable: The map contains pairs of GlassFishVariable.getEnvName() and GlassFishVariable.getSystemPropertyName().
getExitStatus() - Method in interface org.glassfish.embeddable.CommandResult
getFailureCause() - Method in interface org.glassfish.embeddable.CommandResult: This method returns any exception raised during command invocation, If the command's exit status is CommandResult.ExitStatus.SUCCESS, then this method will return null.
getInstallRoot() - Method in class org.glassfish.embeddable.BootstrapProperties: Get the location installation root set using BootstrapProperties.setInstallRoot(java.lang.String)
getInstanceRoot() - Method in class org.glassfish.embeddable.GlassFishProperties: Get the location instance root set using GlassFishProperties.setInstanceRoot(String)
getOutput() - Method in interface org.glassfish.embeddable.CommandResult
getPort(String) - Method in class org.glassfish.embeddable.GlassFishProperties: Get the port number set using GlassFishProperties.setPort(String, int)
getProperties() - Method in class org.glassfish.embeddable.BootstrapProperties: Get the underlying Properties object which backs this BootstrapProperties.
getProperties() - Method in class org.glassfish.embeddable.GlassFishProperties: Get the underlying Properties object which backs this GlassFishProperties.
getProperty(String) - Method in class org.glassfish.embeddable.BootstrapProperties: Get the value of the property with the specified key.
getProperty(String) - Method in class org.glassfish.embeddable.GlassFishProperties
getPropertyName() - Method in enum class org.glassfish.embeddable.GlassFishVariable
getPropertyNames() - Method in class org.glassfish.embeddable.GlassFishProperties
getService(Class<T>) - Method in interface org.glassfish.embeddable.GlassFish: A service has a service interface and optionally a name.
getService(Class<T>, String) - Method in interface org.glassfish.embeddable.GlassFish: A service has a service interface and optionally a name.
getStatus() - Method in interface org.glassfish.embeddable.GlassFish: Get the current status of GlassFish.
getSystemPropertyName() - Method in enum class org.glassfish.embeddable.GlassFishVariable
GlassFish - Interface in org.glassfish.embeddable: Represents a GlassFish instance and provides the ability to: perform life cycle operations viz., start, stop and dispose.
GlassFish.Status - Enum Class in org.glassfish.embeddable: Represents the status of GlassFish.
GlassFishException - Exception Class in org.glassfish.embeddable: A custom Exception type used in the embedded glassfish startup modules.
GlassFishException(String) - Constructor for exception class org.glassfish.embeddable.GlassFishException
GlassFishException(String, Throwable) - Constructor for exception class org.glassfish.embeddable.GlassFishException
GlassFishException(Throwable) - Constructor for exception class org.glassfish.embeddable.GlassFishException
GlassFishProperties - Class in org.glassfish.embeddable: Encapsulates the set of properties required to create a new GlassFish instance.
GlassFishProperties() - Constructor for class org.glassfish.embeddable.GlassFishProperties: Create GlassFishProperties with default properties.
GlassFishProperties(Properties) - Constructor for class org.glassfish.embeddable.GlassFishProperties: Create GlassFishProperties with custom properties.
GlassFishRuntime - Class in org.glassfish.embeddable: This is the entry point API to bootstrap GlassFish.
GlassFishRuntime() - Constructor for class org.glassfish.embeddable.GlassFishRuntime: Default constructor, doesn't do anything
GlassFishVariable - Enum Class in org.glassfish.embeddable: GlassFish variables used as environment options or system properties and their mapping.

H

handles(BootstrapProperties) - Method in interface org.glassfish.embeddable.spi.RuntimeBuilder
HOST_NAME - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Autodetected host name.

I

IMQ_BIN - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: JMS Message Broker bin directory
IMQ_LIB - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: JMS Message Broker lib directory
INIT - Enum constant in enum class org.glassfish.embeddable.GlassFish.Status: Initial state of a newly created GlassFish.
INSTALL_ROOT - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Which installation root the GlassFish should run with.
INSTANCE_ROOT - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Instance directory
isConfigFileReadOnly() - Method in class org.glassfish.embeddable.GlassFishProperties: Check whether the specified configuration file or config/domain.xml at the specified instance root is operated read only or not.

J

JAVA_HOME - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Java home directory set by JVM automatically via java.home or via JAVA_HOME by user.
JAVA_ROOT - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Java home set by AS_JAVA, has higher priority than JAVA_HOME.

K

KEYSTORE_FILE - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: File containing the private key and server certificates.
KEYSTORE_PASSWORD - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Deprecated, for removal: This API element is subject to removal in a future version.
It is not safe to set passwords as system properties.
KEYSTORE_TYPE - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: JKS/JCEKS/PKCS12/...

L

launch(String[]) - Method in interface org.glassfish.embeddable.client.ApplicationClientContainer: Executes the client.

M

messageForGUIDisplay() - Method in exception class org.glassfish.embeddable.client.UserError

N

newGlassFish() - Method in class org.glassfish.embeddable.GlassFishRuntime: Create a new instance of GlassFish with default GlassFishProperties
newGlassFish(GlassFishProperties) - Method in class org.glassfish.embeddable.GlassFishRuntime: Creates a new instance of GlassFish.
NODES_ROOT - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Node agents directory

O

org.glassfish.embeddable - package org.glassfish.embeddable: Provides classes and interfaces necessary to embed GlassFish and perform lifecycle operations, application deployments and runtime configurations.
org.glassfish.embeddable.client - package org.glassfish.embeddable.client
org.glassfish.embeddable.spi - package org.glassfish.embeddable.spi: Provides classes and interfaces necessary to plugin a custom GlassFish runtime.
org.glassfish.main.api.simple - module org.glassfish.main.api.simple: Basic GlassFish interfaces and classes used by all implementations.
OSGI_PLATFORM - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: OSGi implementation selector.

P

PRODUCT_ROOT - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Install root parent, resolved from GlassFishVariable.INSTANCE_ROOT.

R

run(String, String...) - Method in interface org.glassfish.embeddable.CommandRunner: Execute an administrative command in GlassFish using the supplied command arguments.
RuntimeBuilder - Interface in org.glassfish.embeddable.spi: This is an SPI for plugging in a GlassFishRuntime.

S

setApplicationClientContainer(ApplicationClientContainer) - Method in interface org.glassfish.embeddable.client.ApplicationClientClassLoader: Sets the container.
setConfigFile(File) - Method in class org.glassfish.embeddable.GlassFishProperties: Optionally set the location of configuration file (i.e., domain.xml) using which the GlassFish should run.
setConfigFile(URI) - Method in class org.glassfish.embeddable.GlassFishProperties: Optionally set the location of configuration file (i.e., domain.xml) using which the GlassFish should run.
setConfigFileReadOnly(boolean) - Method in class org.glassfish.embeddable.GlassFishProperties: Mention whether or not the GlassFish should writeback any changes to specified configuration file or config/domain.xml at the specified instance root.
setConfigFileURI(String) - Method in class org.glassfish.embeddable.GlassFishProperties: Deprecated, for removal: This API element is subject to removal in a future version.
setInstallRoot(String) - Method in class org.glassfish.embeddable.BootstrapProperties: Optionally set the installation root using which the GlassFish should run.
setInstanceRoot(String) - Method in class org.glassfish.embeddable.GlassFishProperties: Optionally set the instance root (aka domain dir) using which the GlassFish should run.
setPort(String, int) - Method in class org.glassfish.embeddable.GlassFishProperties: Set the port number for a network listener that the GlassFish server should use.
setProperty(String, String) - Method in class org.glassfish.embeddable.BootstrapProperties: Set any custom bootstrap property.
setProperty(String, String) - Method in class org.glassfish.embeddable.GlassFishProperties: Set any custom glassfish property.
setTerse(boolean) - Method in interface org.glassfish.embeddable.CommandRunner: Set the terse level.
setUsage(String) - Method in exception class org.glassfish.embeddable.client.UserError: Sets whether or not the usage message should be displayed after the error message is displayed to the user.
shutdown() - Method in class org.glassfish.embeddable.GlassFishRuntime: Shuts down the Runtime and dispose off all the GlassFish objects created via this Runtime
shutdownInternal() - Static method in class org.glassfish.embeddable.GlassFishRuntime
start() - Method in interface org.glassfish.embeddable.GlassFish: Start GlassFish.
STARTED - Enum constant in enum class org.glassfish.embeddable.GlassFish.Status: GlassFish is up and running.
STARTING - Enum constant in enum class org.glassfish.embeddable.GlassFish.Status: GlassFish is being started.
stop() - Method in interface org.glassfish.embeddable.GlassFish: Stop GlassFish.
STOPPED - Enum constant in enum class org.glassfish.embeddable.GlassFish.Status: GlassFish is stopped.
STOPPING - Enum constant in enum class org.glassfish.embeddable.GlassFish.Status: GlassFish is being stopped.
SUCCESS - Enum constant in enum class org.glassfish.embeddable.CommandResult.ExitStatus

T

TIMEOUT_START_SERVER - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Default start server timeout in seconds
TIMEOUT_STOP_SERVER - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Default stop server timeout in seconds
toExpression() - Method in enum class org.glassfish.embeddable.GlassFishVariable
toString() - Method in class org.glassfish.embeddable.BootstrapProperties
TRUSTSTORE_FILE - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: File containing server certificate chains
TRUSTSTORE_PASSWORD - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: Deprecated, for removal: This API element is subject to removal in a future version.
It is not safe to set passwords as system properties.
TRUSTSTORE_TYPE - Enum constant in enum class org.glassfish.embeddable.GlassFishVariable: JKS/JCEKS/PKCS12/...

U

undeploy(String, String...) - Method in interface org.glassfish.embeddable.Deployer: Undeploys an application from GlassFish This method takes a var-arg argument for the undeployment options.
UserError - Exception Class in org.glassfish.embeddable.client: Represents any user error, such as an invalid combination of command options, or specifying a non-existent JAR file.
UserError(String) - Constructor for exception class org.glassfish.embeddable.client.UserError
UserError(String, Throwable) - Constructor for exception class org.glassfish.embeddable.client.UserError
UserError(Throwable) - Constructor for exception class org.glassfish.embeddable.client.UserError

V

valueOf(String) - Static method in enum class org.glassfish.embeddable.CommandResult.ExitStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.glassfish.embeddable.GlassFish.Status: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.glassfish.embeddable.GlassFishVariable: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.glassfish.embeddable.CommandResult.ExitStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.glassfish.embeddable.GlassFish.Status: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.glassfish.embeddable.GlassFishVariable: Returns an array containing the constants of this enum class, in the order they are declared.

W

WARNING - Enum constant in enum class org.glassfish.embeddable.CommandResult.ExitStatus

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form