org.codehaus.cargo.container.jetty

Class Jetty7xEmbeddedLocalContainer

java.lang.Object

org.codehaus.cargo.util.log.LoggedObject

org.codehaus.cargo.container.spi.AbstractContainer

org.codehaus.cargo.container.spi.AbstractLocalContainer

org.codehaus.cargo.container.spi.AbstractEmbeddedLocalContainer

org.codehaus.cargo.container.jetty.internal.AbstractJettyEmbeddedLocalContainer

org.codehaus.cargo.container.jetty.Jetty7xEmbeddedLocalContainer

All Implemented Interfaces:

Container, EmbeddedLocalContainer, RunnableContainer, LocalContainer, Loggable

Direct Known Subclasses:

Jetty8xEmbeddedLocalContainer

public class Jetty7xEmbeddedLocalContainer
extends AbstractJettyEmbeddedLocalContainer

A Jetty 7.x instance running embedded.

Version:

$Id: Jetty7xEmbeddedLocalContainer.java 3435 2012-09-30 20:31:42Z alitokmen $

Field Summary

Fields inherited from class org.codehaus.cargo.container.jetty.internal.AbstractJettyEmbeddedLocalContainer

server

Constructor Summary

Constructors

Constructor and Description
Jetty7xEmbeddedLocalContainer(LocalConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addDeployables() Add the cargo deployables and the Cargo Ping Check.
void	addHandler(Object handler) Deploy the handler representing the webapp to jetty.
protected void	addJettyHandlers() Add Jetty handlers.
protected void	configureJettyConnectors() Configure Jetty connectors.
Object	createHandler(Deployable deployable) Create a WebAppContext for the Deployable.
Object	createHandler(String contextPath, String war) Create a WebAppContext for the webapp given as a string.
protected void	createServerObject() Create a Jetty Server Object.
protected void	doStart() Implementation of RunnableContainer.start() that all containers extending this class must implement.
String	getId()
String	getName()
void	removeHandler(Object handler) Undeploy the handler representing the webapp.
void	setDefaultRealm(Object webapp) If a default realm is available, set it on the given webapp.
protected void	setSecurityRealm() Defines a security realm and adds defined users to it.
protected void	startJetty() Starts the Jetty server.

Methods inherited from class org.codehaus.cargo.container.jetty.internal.AbstractJettyEmbeddedLocalContainer

doStop, getCapability, getServer, waitForCompletion

Methods inherited from class org.codehaus.cargo.container.spi.AbstractEmbeddedLocalContainer

getClassLoader, getType, setClassLoader, startInternal, stopInternal

Methods inherited from class org.codehaus.cargo.container.spi.AbstractLocalContainer

executePostStartTasks, forceStopInternal, getConfiguration, getFileHandler, getOutput, getState, getTimeout, isAppend, setAppend, setConfiguration, setFileHandler, setOutput, setState, setTimeout, start, stop, verify, waitForPortShutdown

Methods inherited from class org.codehaus.cargo.util.log.LoggedObject

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.cargo.container.LocalContainer

getConfiguration, getFileHandler, setConfiguration, setFileHandler

Methods inherited from interface org.codehaus.cargo.container.Container

getState

Methods inherited from interface org.codehaus.cargo.util.log.Loggable

getLogger, setLogger

Methods inherited from interface org.codehaus.cargo.container.internal.RunnableContainer

getOutput, getTimeout, isAppend, setAppend, setOutput, setTimeout, start, stop

Constructor Detail

Jetty7xEmbeddedLocalContainer

public Jetty7xEmbeddedLocalContainer(LocalConfiguration configuration)

See Also:

AbstractJettyEmbeddedLocalContainer.AbstractJettyEmbeddedLocalContainer(org.codehaus.cargo.container.configuration.LocalConfiguration)

Method Detail

getId

public String getId()

Returns:

the short name of the container. Note: this is not a unique id. It is simply the name in a computer-usable format.

See Also:

Container.getId()

getName

public String getName()

Returns:

the human readable name of the Container (ex: "Resin 3.x", "JBoss 3.0.8", etc).

See Also:

Container.getName()

setDefaultRealm

public void setDefaultRealm(Object webapp)
                     throws Exception

If a default realm is available, set it on the given webapp.

Parameters:

webapp - the webapp to set the realm on

Throws:

Exception - on invokation error

doStart

protected void doStart()
                throws Exception

Implementation of RunnableContainer.start() that all containers extending this class must implement.

Specified by:

doStart in class AbstractEmbeddedLocalContainer

Throws:

Exception - if any error is raised during the container start

See Also:

AbstractEmbeddedLocalContainer.doStart()

configureJettyConnectors

protected void configureJettyConnectors()
                                 throws ClassNotFoundException,
                                        InstantiationException,
                                        IllegalAccessException,
                                        InvocationTargetException,
                                        NoSuchMethodException

Configure Jetty connectors.

Throws:

ClassNotFoundException - thrown if the connectors could not be configured

InstantiationException - thrown if the connectors could not be configured

IllegalAccessException - thrown if the connectors could not be configured

InvocationTargetException - thrown if the connectors could not be configured

NoSuchMethodException - thrown if the connectors could not be configured

addJettyHandlers

protected void addJettyHandlers()
                         throws ClassNotFoundException,
                                InstantiationException,
                                IllegalAccessException,
                                InvocationTargetException,
                                NoSuchMethodException

Add Jetty handlers.

Throws:

ClassNotFoundException - thrown if the handlers could not be added

InstantiationException - thrown if the handlers could not be added

IllegalAccessException - thrown if the handlers could not be added

InvocationTargetException - thrown if the handlers could not be added

NoSuchMethodException - thrown if the handlers could not be added

addDeployables

protected void addDeployables()
                       throws Exception

Add the cargo deployables and the Cargo Ping Check.

Throws:

Exception - thrown if the deployables could not be added

startJetty

protected void startJetty()

Starts the Jetty server.

createHandler

public Object createHandler(Deployable deployable)
                     throws Exception

Create a WebAppContext for the Deployable. NB also force the defaultRealm to be set on it if one is present.

Parameters:

deployable - the cargo webapp to deploy

Returns:

a jetty webapp

Throws:

Exception - on invokation exception

createHandler

public Object createHandler(String contextPath,
                   String war)
                     throws Exception

Create a WebAppContext for the webapp given as a string. NB Also force the defaultRealm to be set if one is present.

Parameters:

contextPath - the context path for the webapp

war - the webapp

Returns:

a jetty webapp

Throws:

Exception - on invokation exception

addHandler

public void addHandler(Object handler)
                throws Exception

Deploy the handler representing the webapp to jetty. If jetty is already started, then start the handler.

Parameters:

handler - the handler representing the webapp

Throws:

Exception - on invocation exception

removeHandler

public void removeHandler(Object handler)
                   throws Exception

Undeploy the handler representing the webapp.

Parameters:

handler - the handler representing the webapp

Throws:

Exception - on invocation exception

setSecurityRealm

protected void setSecurityRealm()
                         throws Exception

Defines a security realm and adds defined users to it. If a user has specified the standard ServletPropertySet.USERS property, then we try and turn these into an in-memory default realm, and then set that realm on all of the webapps. TODO: this is not ideal. We need a way to specify N named realms to the server so that individual webapps can find their appropriate realms by name.

Throws:

Exception - in case of error

createServerObject

protected void createServerObject()
                           throws Exception

Create a Jetty Server Object.

Overrides:

createServerObject in class AbstractJettyEmbeddedLocalContainer

Throws:

Exception - in case of error

See Also:

AbstractJettyEmbeddedLocalContainer.createServerObject()