org.rhq.common.jbossas.client.controller

Class WebJBossASClient

java.lang.Object

org.rhq.common.jbossas.client.controller.JBossASClient

org.rhq.common.jbossas.client.controller.WebJBossASClient

public class WebJBossASClient
extends JBossASClient

Convenience methods to access the web management API.

Author:

John Mazzitelli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebJBossASClient.ConnectorConfiguration
static class	WebJBossASClient.SSLConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTOR
static String	DEFAULT_HOST
static String	SSL
static String	SUBSYSTEM_WEB
static String	VIRTUAL_SERVER

Fields inherited from class org.rhq.common.jbossas.client.controller.JBossASClient

ADD, ADDRESS, BATCH, BATCH_STEPS, FAILURE_DESCRIPTION, log, NAME, OPERATION, OUTCOME, OUTCOME_SUCCESS, PERSISTENT, READ_ATTRIBUTE, READ_RESOURCE, REMOVE, RESULT, SUBSYSTEM, SYSTEM_PROPERTY, VALUE, WRITE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
WebJBossASClient(org.jboss.as.controller.client.ModelControllerClient client)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnector(String name, WebJBossASClient.ConnectorConfiguration connectorConfig) Add a new web connector, which may be a secure SSL connector (HTTPS) or not (HTTP).
void	changeConnector(String connectorName, String attribName, String attribValue) Use this to modify an attribute for an existing connector.
org.jboss.dmr.ModelNode	getConnector(String name) Returns the connector node with all its attributes.
boolean	isConnector(String name) Checks to see if there is already a connector with the given name.
boolean	isWebSubsystem() Checks to see if the web subsystem exists.
void	removeConnector(String doomedConnectorName) Removes the given web connector.
void	setEnableWelcomeRoot(boolean enableFlag) The enable-welcome-root setting controls whether or not to deploy JBoss' welcome-content application at root context.

Methods inherited from class org.rhq.common.jbossas.client.controller.JBossASClient

createBatchRequest, createReadAttributeRequest, createReadAttributeRequest, createRequest, createWriteAttributeRequest, execute, findNodeInList, getFailureDescription, getModelControllerClient, getResultListAsStrings, getResults, getStringAttribute, getStringAttribute, isSuccess, readResource, readResource, remove, setPossibleExpression

Methods inherited from class java.lang.Object

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

Field Detail

SUBSYSTEM_WEB

public static final String SUBSYSTEM_WEB

See Also:

Constant Field Values

VIRTUAL_SERVER

public static final String VIRTUAL_SERVER

See Also:

Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

CONNECTOR

public static final String CONNECTOR

See Also:

Constant Field Values

SSL

public static final String SSL

See Also:

Constant Field Values

Constructor Detail

WebJBossASClient

public WebJBossASClient(org.jboss.as.controller.client.ModelControllerClient client)

Method Detail

isWebSubsystem

public boolean isWebSubsystem()
                       throws Exception

Checks to see if the web subsystem exists. This should always exist unless the server is just starting up and its web subsystem has not even initialized yet.

Returns:

true if the web subsystem is ready

Throws:

Exception

setEnableWelcomeRoot

public void setEnableWelcomeRoot(boolean enableFlag)
                          throws Exception

The enable-welcome-root setting controls whether or not to deploy JBoss' welcome-content application at root context. If you want to deploy your own app at the root context, you need to disable the enable-welcome-root setting on the default host virtual server. If you want to show the JBoss' welcome screen, you need to enable this setting.

Parameters:

enableFlag - true if the welcome screen at the root context should be enabled; false otherwise

Throws:

Exception

isConnector

public boolean isConnector(String name)
                    throws Exception

Checks to see if there is already a connector with the given name.

Parameters:

name - the name to check

Returns:

true if there is a connector with the given name already in existence

Throws:

Exception

getConnector

public org.jboss.dmr.ModelNode getConnector(String name)
                                     throws Exception

Returns the connector node with all its attributes. Will be null if it doesn't exist.

Parameters:

name - the name of the connector whose node is to be returned

Returns:

the node if there is a connector with the given name already in existence, null otherwise

Throws:

Exception

changeConnector

public void changeConnector(String connectorName,
                   String attribName,
                   String attribValue)
                     throws Exception

Use this to modify an attribute for an existing connector.

Parameters:

connectorName - the existing connector whose attribute is to be changed

attribName - the attribute to get a new value

attribValue - the new value of the attribute

Throws:

Exception - if failed to change the attribute on the named connector

removeConnector

public void removeConnector(String doomedConnectorName)
                     throws Exception

Removes the given web connector.

Parameters:

doomedConnectorName - the name of the web connector to remove.

Throws:

Exception

addConnector

public void addConnector(String name,
                WebJBossASClient.ConnectorConfiguration connectorConfig)
                  throws Exception

Add a new web connector, which may be a secure SSL connector (HTTPS) or not (HTTP).

Parameters:

name -

connectorConfig -

Throws:

Exception