org.wildfly.swarm.container

Class Container

java.lang.Object

org.wildfly.swarm.container.Container

public class Container
extends Object

A WildFly-Swarm container.

Author:

Bob McWhirter, Ken Finnigan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Container.InitContext Initialization Context to be passed to Fractions to allow them to provide additional functionality into the Container.

Constructor Summary

Constructors

Constructor and Description
Container() Construct a new, un-started container.

Method Summary

Modifier and Type	Method and Description
void	applyFractionDefaults(Server server)
<T extends org.jboss.shrinkwrap.api.Archive> T	create(String name, Class<T> type) Create a ShrinkWrap archive with a given name and type.
Container	deploy() Deploy the default WAR deployment.
Container	deploy(org.jboss.shrinkwrap.api.Archive deployment) Deploy an archive.
Container	deploy(Deployment deployment) Deploy a deployment
Container	fraction(Fraction fraction) Add a fraction to the container.
List<Fraction>	fractions()
org.jboss.shrinkwrap.api.Domain	getShrinkWrapDomain() Retrieve the ShrinkWrap domain for creating archives.
Container	iface(String name, String expression) Configure a network interface.
List<Interface>	ifaces()
Container	socketBindingGroup(SocketBindingGroup group) Configure a socket-binding-group.
List<SocketBindingGroup>	socketBindingGroups()
Container	start() Start the container.
Container	start(Deployment deployment) Start the container with a deployment.
Container	stop() Stop the container, undeploying all deployments.
Container	subsystem(Fraction fraction) Add a fraction to the container.

Methods inherited from class java.lang.Object

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

Constructor Detail

Container

public Container()
          throws Exception

Construct a new, un-started container.

Throws:

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

Method Detail

getShrinkWrapDomain

public org.jboss.shrinkwrap.api.Domain getShrinkWrapDomain()

Retrieve the ShrinkWrap domain for creating archives.

Returns:

The ShrinkWrap Domain.

See Also:

create(String, Class)

applyFractionDefaults

public void applyFractionDefaults(Server server)
                           throws Exception

Throws:

Exception

subsystem

public Container subsystem(Fraction fraction)

Add a fraction to the container.

Parameters:

fraction - The fraction to add.

Returns:

The container.

fraction

public Container fraction(Fraction fraction)

Add a fraction to the container.

Parameters:

fraction - The fraction to add.

Returns:

The container.

fractions

public List<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(SocketBindingGroup group)

Configure a socket-binding-group.

Parameters:

group - The socket-binding group to add.

Returns:

The container.

socketBindingGroups

public List<SocketBindingGroup> socketBindingGroups()

start

public Container start()
                throws Exception

Start the container.

Returns:

The container.

Throws:

Exception - if an error occurs.

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

create

public <T extends org.jboss.shrinkwrap.api.Archive> T create(String name,
                                                             Class<T> type)

Create a ShrinkWrap archive with a given name and type.

Type Parameters:

T - An interface of a ShrinkWrap archive type.

Parameters:

name - The name of the archive.

type - The type of the archive.

Returns:

The newly created archive.

deploy

public Container deploy()
                 throws Exception

Deploy the default WAR deployment.

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

Returns:

The container.

Throws:

Exception - if an error occurs.

deploy

public Container deploy(org.jboss.shrinkwrap.api.Archive deployment)
                 throws Exception

Deploy an archive.

Parameters:

deployment - The ShrinkWrap archive to deploy.

Returns:

The container.

Throws:

Exception - if an error occurs.

deploy

public Container deploy(Deployment deployment)
                 throws Exception

Deploy a deployment

Parameters:

deployment - The deployment to deploy.

Returns:

The container.

Throws:

Exception - if an error occurs.