org.wildfly.swarm.container

Class Container

java.lang.Object

org.wildfly.swarm.container.Container

Direct Known Subclasses:

Swarm

public class Container
extends Object

A WildFly-Swarm container.

Author:

Bob McWhirter, Ken Finnigan

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
Container() Construct a new, un-started container.
Container(boolean debugBootstrap) Construct a new, un-started container.
Container(boolean debugBootstrap, String... args) Construct a new, un-started container, configured using command-line arguments.
Container(String... args) Construct a new, un-started container, configured using command-line arguments.

Method Summary

Modifier and Type	Method and Description
void	applyFractionDefaults(Server server)
org.jboss.shrinkwrap.api.Archive<?>	createDefaultDeployment() Provides access to the default ShrinkWrap deployment.
org.wildfly.swarm.container.Container.PostInitContext	createPostInitContext()
Container	deploy() Deploy the default WAR deployment.
Container	deploy(org.jboss.shrinkwrap.api.Archive<?> deployment) Deploy an archive.
protected String	determineDeploymentType()
protected String	determineDeploymentTypeInternal()
Container	fraction(org.wildfly.swarm.spi.api.Fraction fraction) Add a fraction to the container.
Container	fraction(Supplier<org.wildfly.swarm.spi.api.Fraction> supplier)
List<org.wildfly.swarm.spi.api.Fraction>	fractions()
String[]	getArgs() Get the possibly null container main method arguments.
org.wildfly.swarm.spi.api.SocketBindingGroup	getSocketBindingGroup(String name)
boolean	hasStageConfig()
Container	iface(String name, String expression) Configure a network interface.
List<Interface>	ifaces()
static boolean	isFatJar()
Map<String,List<org.wildfly.swarm.spi.api.OutboundSocketBinding>>	outboundSocketBindings()
void	setArgs(String[] args) Set the main method arguments.
Container	socketBindingGroup(org.wildfly.swarm.spi.api.SocketBindingGroup group) Configure a socket-binding-group.
List<org.wildfly.swarm.spi.api.SocketBindingGroup>	socketBindingGroups()
Map<String,List<org.wildfly.swarm.spi.api.SocketBinding>>	socketBindings()
org.wildfly.swarm.spi.api.StageConfig	stageConfig()
Container	start() Start the container.
Container	start(org.jboss.shrinkwrap.api.Archive<?> deployment) Start the container with a deployment.
Container	start(boolean eagerlyOpen)
Container	stop() Stop the container, undeploying all deployments.
Container	withStageConfig(URL url)
Container	withXmlConfig(URL url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final String VERSION

Constructor Detail

Container

public Container()
          throws Exception

Construct a new, un-started container.

Throws:

Exception - If an error occurs performing classloading and initialization magic.

Container

public Container(boolean debugBootstrap)
          throws Exception

Construct a new, un-started container.

Parameters:

debugBootstrap - - flag to indicate if the module layer should be put into bootstrap debug mode. Same as the jboss-module -debuglog mode which enables trace logging to System.out during the initial bootstrap of the module layer.

Throws:

Exception - If an error occurs performing classloading and initialization magic.

Container

public Container(String... args)
          throws Exception

Construct a new, un-started container, configured using command-line arguments.

Parameters:

args - The command-line arguments arguments

Throws:

Exception - If an error occurs performing classloading and initialization magic.

Container

public Container(boolean debugBootstrap,
                 String... args)
          throws Exception

Construct a new, un-started container, configured using command-line arguments.

Parameters:

debugBootstrap - - flag to indicate if the module layer should be put into bootstrap debug mode. Same as the jboss-module -debuglog mode which enables trace logging to System.out during the initial bootstrap of the module layer.

args - The command-line arguments arguments

Throws:

Exception - If an error occurs performing classloading and initialization magic.

Method Detail

withXmlConfig

public Container withXmlConfig(URL url)

withStageConfig

public Container withStageConfig(URL url)

stageConfig

public org.wildfly.swarm.spi.api.StageConfig stageConfig()

hasStageConfig

public boolean hasStageConfig()

isFatJar

public static boolean isFatJar()
                        throws IOException

Throws:

IOException

applyFractionDefaults

public void applyFractionDefaults(Server server)
                           throws Exception

Throws:

Exception

fraction

public Container fraction(org.wildfly.swarm.spi.api.Fraction fraction)

Add a fraction to the container.

Parameters:

fraction - The fraction to add.

Returns:

The container.

fraction

public Container fraction(Supplier<org.wildfly.swarm.spi.api.Fraction> supplier)

fractions

public List<org.wildfly.swarm.spi.api.Fraction> fractions()

iface

public Container iface(String name,
                       String expression)

Configure a network interface.

Parameters:

name - The name of the interface.

expression - The expression to define the interface.

Returns:

The container.

ifaces

public List<Interface> ifaces()

socketBindingGroup

public Container socketBindingGroup(org.wildfly.swarm.spi.api.SocketBindingGroup group)

Configure a socket-binding-group.

Parameters:

group - The socket-binding group to add.

Returns:

The container.

socketBindingGroups

public List<org.wildfly.swarm.spi.api.SocketBindingGroup> socketBindingGroups()

getSocketBindingGroup

public org.wildfly.swarm.spi.api.SocketBindingGroup getSocketBindingGroup(String name)

socketBindings

public Map<String,List<org.wildfly.swarm.spi.api.SocketBinding>> socketBindings()

outboundSocketBindings

public Map<String,List<org.wildfly.swarm.spi.api.OutboundSocketBinding>> outboundSocketBindings()

start

public Container start()
                throws Exception

Start the container.

Returns:

The container.

Throws:

Exception - if an error occurs.

start

public Container start(boolean eagerlyOpen)
                throws Exception

Throws:

Exception

stop

public Container stop()
               throws Exception

Stop the container, undeploying all deployments.

Returns:

THe container.

Throws:

Exception - If an error occurs.

start

public Container start(org.jboss.shrinkwrap.api.Archive<?> deployment)
                throws Exception

Start the container with a deployment.

Effectively calls start().deploy(deployment)

Parameters:

deployment - The deployment to deploy.

Returns:

The container.

Throws:

Exception - if an error occurs.

See Also:

start(), deploy(Archive)

deploy

public Container deploy()
                 throws DeploymentException

Deploy the default WAR deployment.

For WAR-based applications, the primary WAR artifact iwll be deployed.

Returns:

The container.

Throws:

DeploymentException - if an error occurs.

deploy

public Container deploy(org.jboss.shrinkwrap.api.Archive<?> deployment)
                 throws DeploymentException

Deploy an archive.

Parameters:

deployment - The ShrinkWrap archive to deploy.

Returns:

The container.

Throws:

DeploymentException - if an error occurs.

getArgs

public String[] getArgs()

Get the possibly null container main method arguments.

Returns:

main method arguments, possibly null

setArgs

public void setArgs(String[] args)

Set the main method arguments. This will be available as a ValueService under the name wildfly.swarm.main-args

Parameters:

args - arguments passed to the main(String[]) method.

createPostInitContext

public org.wildfly.swarm.container.Container.PostInitContext createPostInitContext()

createDefaultDeployment

public org.jboss.shrinkwrap.api.Archive<?> createDefaultDeployment()

Provides access to the default ShrinkWrap deployment.

determineDeploymentType

protected String determineDeploymentType()
                                  throws IOException

Throws:

IOException

determineDeploymentTypeInternal

protected String determineDeploymentTypeInternal()
                                          throws IOException

Throws:

IOException