org.wildfly.swarm

Class Swarm

java.lang.Object

org.wildfly.swarm.Swarm

Direct Known Subclasses:

Container

@Vetoed
public class Swarm
extends Object

Default main(...) if an application does not provide one.

This simply constructs a default container, starts it and performs a default deployment. Typically only useful for barren WAR applications.

Author:

Bob McWhirter, Ken Finnigan

Field Summary

Fields

Modifier and Type	Field and Description
static ArtifactManager	ARTIFACT_MANAGER
static String	VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static List<org.jboss.shrinkwrap.api.spec.JavaArchive>	allArtifacts()
static org.jboss.shrinkwrap.api.spec.JavaArchive	artifact(String gav)
static org.jboss.shrinkwrap.api.spec.JavaArchive	artifact(String gav, String asName)
static ArtifactManager	artifactManager()
Swarm	component(Class<?> cls)
org.jboss.shrinkwrap.api.Archive<?>	createDefaultDeployment() Provides access to the default ShrinkWrap deployment.
Swarm	deploy() Deploy the default WAR deployment.
Swarm	deploy(org.jboss.shrinkwrap.api.Archive<?> deployment) Deploy an archive.
Swarm	fraction(Fraction fraction) Add a fraction to the container.
CommandLine	getCommandLine()
boolean	hasStageConfig()
static void	main(String... args) Main entry-point.
Swarm	outboundSocketBinding(String socketBindingGroup, OutboundSocketBinding binding)
void	setArgs(String... args)
Swarm	socketBinding(String socketBindingGroup, SocketBinding binding)
StageConfig	stageConfig()
Swarm	start() Start the container.
Swarm	start(org.jboss.shrinkwrap.api.Archive<?> deployment) Start the container with a deployment.
Swarm	start(boolean eagerlyOpen)
Swarm	stop() Stop the container, undeploying all deployments.
Swarm	withStageConfig(URL url)
Swarm	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

ARTIFACT_MANAGER

public static ArtifactManager ARTIFACT_MANAGER

Constructor Detail

Swarm

public Swarm()
      throws Exception

Construct a new, un-started container.

Throws:

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

Swarm

public Swarm(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.

Swarm

public Swarm(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.

Swarm

public Swarm(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

getCommandLine

public CommandLine getCommandLine()

setArgs

public void setArgs(String... args)

withXmlConfig

public Swarm withXmlConfig(URL url)

withStageConfig

public Swarm withStageConfig(URL url)

stageConfig

public StageConfig stageConfig()

hasStageConfig

public boolean hasStageConfig()

fraction

public Swarm fraction(Fraction fraction)

Add a fraction to the container.

Parameters:

fraction - The fraction to add.

Returns:

The container.

component

public Swarm component(Class<?> cls)

outboundSocketBinding

public Swarm outboundSocketBinding(String socketBindingGroup,
                                   OutboundSocketBinding binding)

socketBinding

public Swarm socketBinding(String socketBindingGroup,
                           SocketBinding binding)

start

public Swarm start()
            throws Exception

Start the container.

Returns:

The container.

Throws:

Exception - if an error occurs.

start

public Swarm start(boolean eagerlyOpen)
            throws Exception

Throws:

Exception

start

public Swarm 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)

stop

public Swarm stop()
           throws Exception

Stop the container, undeploying all deployments.

Returns:

THe container.

Throws:

Exception - If an error occurs.

deploy

public Swarm deploy()
             throws Exception

Deploy the default WAR deployment.

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

Returns:

The container.

Throws:

DeploymentException - if an error occurs.

Exception

deploy

public Swarm deploy(org.jboss.shrinkwrap.api.Archive<?> deployment)
             throws Exception

Deploy an archive.

Parameters:

deployment - The ShrinkWrap archive to deploy.

Returns:

The container.

Throws:

DeploymentException - if an error occurs.

Exception

createDefaultDeployment

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

Provides access to the default ShrinkWrap deployment.

Throws:

Exception

main

public static void main(String... args)
                 throws Exception

Main entry-point.

Parameters:

args - Ignored.

Throws:

Exception - if an error occurs.

artifactManager

public static ArtifactManager artifactManager()
                                       throws IOException

Throws:

IOException

artifact

public static org.jboss.shrinkwrap.api.spec.JavaArchive artifact(String gav)
                                                          throws Exception

Throws:

Exception

artifact

public static org.jboss.shrinkwrap.api.spec.JavaArchive artifact(String gav,
                                                                 String asName)
                                                          throws Exception

Throws:

Exception

allArtifacts

public static List<org.jboss.shrinkwrap.api.spec.JavaArchive> allArtifacts()
                                                                    throws Exception

Throws:

Exception