org.jboss.wildscribe.modeldumper

Class Configuration

java.lang.Object

org.jboss.wildscribe.modeldumper.Configuration

public class Configuration
extends Object

The configuration used to export the model of a running server to a DMR file.

Author:

James R. Perkins

Method Summary

Modifier and Type	Method and Description
Configuration	addRequiredExtension(String name) Adds a required extension to validate the extension has been added to the running server.
Configuration	addRequiredExtensions(Collection<String> names) Adds the required extensions to validate the extensions have been added to the running server.
Configuration	addRequiredExtensions(String... names) Adds the required extensiosn to validate the extensions have been added to the running server.
org.jboss.dmr.ModelNode	getAddress() The address where the model should be dumped from.
String	getHostName() Returns the host name used for the management connection.
int	getPort() Returns the management port fot the client to connect to.
String	getProtocol() Returns the protocol used for the management connection.
Set<String>	getRequiredExtensions() Returns the required extensions to validate they have been added to the running server.
Path	getTargetFile() Returns the target file to write the model to.
static Configuration	of(Path targetFile) Creates a new configuration for the model exporter.
Configuration	setAddress(org.jboss.dmr.ModelNode address) Sets the address where the model should be dumped from.
Configuration	setHostName(String hostName) Sets the host name used for the management connection.
Configuration	setPort(int port) Sets the management port for the client to connect to.
Configuration	setProtocol(String protocol) Sets the protocol used for the management connection.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static Configuration of(Path targetFile)

Creates a new configuration for the model exporter.

Parameters:

targetFile - the file to write the model to

Returns:

a new configuration

getAddress

public org.jboss.dmr.ModelNode getAddress()

The address where the model should be dumped from. The default is null.

Returns:

the model where the model should be dumped from or null

setAddress

public Configuration setAddress(org.jboss.dmr.ModelNode address)

Sets the address where the model should be dumped from.

Parameters:

address - the address where the model should be dumped from or null for the root resource

Returns:

this configuration

getHostName

public String getHostName()

Returns the host name used for the management connection. The default is localhost.

Returns:

the management host name

setHostName

public Configuration setHostName(String hostName)

Sets the host name used for the management connection.

Parameters:

hostName - the host name

Returns:

this configuration

getPort

public int getPort()

Returns the management port fot the client to connect to. The default is 9990.

Returns:

the management port

setPort

public Configuration setPort(int port)

Sets the management port for the client to connect to.

Parameters:

port - the management port

Returns:

this configuration

getProtocol

public String getProtocol()

Returns the protocol used for the management connection. The default is null.

Returns:

the management protocol

setProtocol

public Configuration setProtocol(String protocol)

Sets the protocol used for the management connection.

Parameters:

protocol - the protocol or null to use a default value

Returns:

this configuration

addRequiredExtension

public Configuration addRequiredExtension(String name)

Adds a required extension to validate the extension has been added to the running server.

Parameters:

name - the extension name

Returns:

this configuration

addRequiredExtensions

public Configuration addRequiredExtensions(String... names)

Adds the required extensiosn to validate the extensions have been added to the running server.

Parameters:

names - the extension names

Returns:

this configuration

addRequiredExtensions

public Configuration addRequiredExtensions(Collection<String> names)

Adds the required extensions to validate the extensions have been added to the running server.

Parameters:

names - the extension names

Returns:

this configuration

getRequiredExtensions

public Set<String> getRequiredExtensions()

Returns the required extensions to validate they have been added to the running server.

Returns:

the extensions

getTargetFile

public Path getTargetFile()

Returns the target file to write the model to.

Returns:

the target file