/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.subsystem.test;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.ADD;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.DEFAULT_INTERFACE;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.HOST;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.INET_ADDRESS;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.INTERFACE;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP_ADDR;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.PATH;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.PORT;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.SOCKET_BINDING;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.SOCKET_BINDING_GROUP;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.SYSTEM_PROPERTY;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.VALUE;
import static org.jboss.as.controller.descriptions.common.PathDescription.RELATIVE_TO;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.jboss.as.controller.PathAddress;
import org.jboss.as.controller.PathElement;
import org.jboss.as.controller.descriptions.ModelDescriptionConstants;
import org.jboss.as.controller.descriptions.common.CommonProviders;
import org.jboss.as.controller.operations.common.InterfaceAddHandler;
import org.jboss.as.controller.operations.common.InterfaceCriteriaWriteHandler;
import org.jboss.as.controller.operations.common.PathAddHandler;
import org.jboss.as.controller.operations.common.PathRemoveHandler;
import org.jboss.as.controller.operations.common.SocketBindingGroupRemoveHandler;
import org.jboss.as.controller.operations.common.SystemPropertyAddHandler;
import org.jboss.as.controller.operations.common.SystemPropertyRemoveHandler;
import org.jboss.as.controller.operations.common.SystemPropertyValueWriteAttributeHandler;
import org.jboss.as.controller.registry.AttributeAccess;
import org.jboss.as.controller.registry.ManagementResourceRegistration;
import org.jboss.as.controller.registry.Resource;
import org.jboss.as.controller.resource.SocketBindingGroupResourceDefinition;
import org.jboss.as.server.controller.descriptions.ServerDescriptionProviders;
import org.jboss.as.server.services.net.BindingGroupAddHandler;
import org.jboss.as.server.services.net.LocalDestinationOutboundSocketBindingResourceDefinition;
import org.jboss.as.server.services.net.RemoteDestinationOutboundSocketBindingResourceDefinition;
import org.jboss.as.server.services.net.SocketBindingResourceDefinition;
import org.jboss.as.server.services.net.SpecifiedInterfaceAddHandler;
import org.jboss.as.server.services.net.SpecifiedInterfaceRemoveHandler;
import org.jboss.dmr.ModelNode;
/**
* Allows easy initialization of parts of the model that subsystems frequently need
*
* @author <a href="kabir.khan@jboss.com">Kabir Khan</a>
*/
public class ControllerInitializer {
public static final String INTERFACE_NAME = "test-interface";
public static final String SOCKET_BINDING_GROUP_NAME = "test-socket-binding-group";
protected volatile String bindAddress = "localhost";
protected final Map<String, String> systemProperties = new HashMap<String, String>();
protected final Map<String, Integer> socketBindings = new HashMap<String, Integer>();
protected final Map<String, OutboundSocketBinding> outboundSocketBindings = new HashMap<String, OutboundSocketBinding>();
protected final Map<String, PathInfo> paths = new HashMap<String, PathInfo>();
/**
* Adds a system property to the model.
* This initializes the system property part of the model with the operations to add it.
*
* @param key the system property name
* @param value the system property value
*/
public void addSystemProperty(String key, String value) {
if (key == null) {
throw new IllegalArgumentException("Null key");
}
if (value == null) {
throw new IllegalArgumentException("Null value");
}
systemProperties.put(key, value);
}
/**
* Sets the bindAddress that will be used for socket bindings.
* The default is 'localhost'
*
* @param address the default bind address
*/
public void setBindAddress(String address) {
if (address == null) {
throw new IllegalArgumentException("Null address");
}
bindAddress = address;
}
/**
* Adds a socket binding to the model.
* This initializes the interface and socket binding group part of the model with the operations to add it.
*
* @param name the socket binding name
* @param port the socket binding port
*/
public void addSocketBinding(String name, int port) {
if (name == null) {
throw new IllegalArgumentException("Null name");
}
if (port < 0) {
throw new IllegalArgumentException("Null port");
}
socketBindings.put(name, port);
}
/**
* Adds a remote outbound socket binding to the model.
*
* @param name the socket binding name
* @param destinationHost The destination host
* @param destinationPort the destination port
*/
public void addRemoteOutboundSocketBinding(final String name, final String destinationHost, final int destinationPort) {
if (name == null) {
throw new IllegalArgumentException("Null name");
}
if (destinationPort < 0) {
throw new IllegalArgumentException("Negative destination port");
}
if (destinationHost == null || destinationHost.trim().isEmpty()) {
throw new IllegalArgumentException("Null or empty destination host");
}
outboundSocketBindings.put(name, new OutboundSocketBinding(destinationHost, destinationPort, true));
}
/**
* Adds a path to the model
* This initializes the path part of the model with the operations to add it.
*
* @param name the name of the path
* @param path the absolute path, or the name of a path (if used with {@code relativeTo}
* @param relativeTo a path relative to {@code path}
*/
public void addPath(String name, String path, String relativeTo) {
if (name == null) {
throw new IllegalArgumentException("Null name");
}
if (path == null) {
throw new IllegalArgumentException("Null path");
}
PathInfo pathInfo = new PathInfo(name, path, relativeTo);
paths.put(name, pathInfo);
}
/**
* Called by framework to set up the model
*
* @param rootResource the root model resource
* @param rootRegistration the root model registry
*/
protected void initializeModel(Resource rootResource, ManagementResourceRegistration rootRegistration) {
initializeSystemPropertiesModel(rootResource, rootRegistration);
initializeSocketBindingsModel(rootResource, rootRegistration);
initializePathsModel(rootResource, rootRegistration);
}
/**
* Called by framework to get the additional boot operations
*
* @return the additional boot operations
*/
protected List<ModelNode> initializeBootOperations(){
List<ModelNode> ops = new ArrayList<ModelNode>();
initializeSystemPropertiesOperations(ops);
initializePathsOperations(ops);
initializeSocketBindingsOperations(ops);
initializeRemoteOutboundSocketBindingsOperations(ops);
return ops;
}
/**
* Initializes the system properties part of the model
*
* @param rootResource the root model resource
* @param rootRegistration the root model registry
*/
protected void initializeSystemPropertiesModel(Resource rootResource, ManagementResourceRegistration rootRegistration) {
if (systemProperties.size() == 0) {
return;
}
rootResource.getModel().get(SYSTEM_PROPERTY);
ManagementResourceRegistration sysProps = rootRegistration.registerSubModel(PathElement.pathElement(SYSTEM_PROPERTY), ServerDescriptionProviders.SYSTEM_PROPERTIES_PROVIDER);
sysProps.registerOperationHandler(SystemPropertyAddHandler.OPERATION_NAME, SystemPropertyAddHandler.INSTANCE_WITHOUT_BOOTTIME, SystemPropertyAddHandler.INSTANCE_WITHOUT_BOOTTIME, false);
sysProps.registerOperationHandler(SystemPropertyRemoveHandler.OPERATION_NAME, SystemPropertyRemoveHandler.INSTANCE, SystemPropertyRemoveHandler.INSTANCE, false);
sysProps.registerReadWriteAttribute(VALUE, null, SystemPropertyValueWriteAttributeHandler.INSTANCE, AttributeAccess.Storage.CONFIGURATION);
}
/**
* Initializes the interface, socket binding group and socket binding part of the model
*
* @param rootResource the root model resource
* @param rootRegistration the root model registry
*/
protected void initializeSocketBindingsModel(Resource rootResource, ManagementResourceRegistration rootRegistration) {
if (socketBindings.size() == 0 && outboundSocketBindings.isEmpty()) {
return;
}
rootResource.getModel().get(INTERFACE);
rootResource.getModel().get(SOCKET_BINDING_GROUP);
ManagementResourceRegistration interfaces = rootRegistration.registerSubModel(PathElement.pathElement(INTERFACE), CommonProviders.SPECIFIED_INTERFACE_PROVIDER);
interfaces.registerOperationHandler(SpecifiedInterfaceAddHandler.OPERATION_NAME, SpecifiedInterfaceAddHandler.INSTANCE, SpecifiedInterfaceAddHandler.INSTANCE, false);
interfaces.registerOperationHandler(SpecifiedInterfaceRemoveHandler.OPERATION_NAME, SpecifiedInterfaceRemoveHandler.INSTANCE, SpecifiedInterfaceRemoveHandler.INSTANCE, false);
InterfaceCriteriaWriteHandler.register(interfaces);
// Sockets
ManagementResourceRegistration socketGroup = rootRegistration.registerSubModel(new SocketBindingGroupResourceDefinition(BindingGroupAddHandler.INSTANCE, SocketBindingGroupRemoveHandler.INSTANCE, false));
socketGroup.registerSubModel(SocketBindingResourceDefinition.INSTANCE);
// client-socket-binding (for remote destination)
socketGroup.registerSubModel(RemoteDestinationOutboundSocketBindingResourceDefinition.INSTANCE);
// client-socket-binding (for local destination)
socketGroup.registerSubModel(LocalDestinationOutboundSocketBindingResourceDefinition.INSTANCE);
}
/**
* Initializes the interface, socket binding group and socket binding part of the model
*
* @param rootResource the root model resource
* @param rootRegistration the root model registry
*/
protected void initializePathsModel(Resource rootResource, ManagementResourceRegistration rootRegistration) {
if (paths.size() == 0) {
return;
}
rootResource.getModel().get(PATH);
ManagementResourceRegistration paths = rootRegistration.registerSubModel(PathElement.pathElement(PATH), CommonProviders.SPECIFIED_PATH_PROVIDER);
paths.registerOperationHandler(PathAddHandler.OPERATION_NAME, PathAddHandler.SPECIFIED_INSTANCE, PathAddHandler.SPECIFIED_INSTANCE, false);
paths.registerOperationHandler(PathRemoveHandler.OPERATION_NAME, PathRemoveHandler.SPECIFIED_INSTANCE, PathRemoveHandler.SPECIFIED_INSTANCE, false);
}
/**
* Creates the additional add system property operations
*
* @param ops the operations list to add our ops to
*/
protected void initializeSystemPropertiesOperations(List<ModelNode> ops) {
for (Map.Entry<String, String> prop : systemProperties.entrySet()) {
ModelNode op = new ModelNode();
op.get(OP).set(ADD);
op.get(OP_ADDR).set(PathAddress.pathAddress(PathElement.pathElement(SYSTEM_PROPERTY, prop.getKey())).toModelNode());
op.get(VALUE).set(prop.getValue());
ops.add(op);
}
}
/**
* Creates the additional add interface, socket binding group and socket binding operations
*
* @param ops the operations list to add our ops to
*/
protected void initializeSocketBindingsOperations(List<ModelNode> ops) {
if (socketBindings.size() == 0) {
return;
}
//Add the interface
ModelNode criteria = new ModelNode();
criteria.get(INET_ADDRESS).set(bindAddress);
ModelNode op = InterfaceAddHandler.getAddInterfaceOperation(
PathAddress.pathAddress(PathElement.pathElement(INTERFACE, INTERFACE_NAME)).toModelNode(),
criteria);
ops.add(op);
//Add the socket binding group
op = new ModelNode();
op.get(OP).set(ADD);
op.get(OP_ADDR).set(PathAddress.pathAddress(PathElement.pathElement(SOCKET_BINDING_GROUP, SOCKET_BINDING_GROUP_NAME)).toModelNode());
op.get(DEFAULT_INTERFACE).set(INTERFACE_NAME);
ops.add(op);
for (Map.Entry<String, Integer> binding : socketBindings.entrySet()) {
op = new ModelNode();
op.get(OP).set(ADD);
op.get(OP_ADDR).set(PathAddress.pathAddress(PathElement.pathElement(SOCKET_BINDING_GROUP, SOCKET_BINDING_GROUP_NAME),
PathElement.pathElement(SOCKET_BINDING, binding.getKey())).toModelNode());
op.get(PORT).set(binding.getValue());
ops.add(op);
}
}
/**
* Creates and add to the <code>ops</code> the <code>add</code> operation for the
* remote outbound socket configurations
*
* @param ops the operations list to add our ops to
*/
protected void initializeRemoteOutboundSocketBindingsOperations(List<ModelNode> ops) {
if (outboundSocketBindings.size() == 0) {
return;
}
for (Map.Entry<String, OutboundSocketBinding> entry : outboundSocketBindings.entrySet()) {
final OutboundSocketBinding binding = entry.getValue();
if (!binding.isRemote()) {
// skip local outbound socket bindings
continue;
}
final String bindingName = entry.getKey();
final ModelNode op = new ModelNode();
op.get(OP).set(ADD);
final PathAddress address = PathAddress.pathAddress(PathElement.pathElement(SOCKET_BINDING_GROUP, SOCKET_BINDING_GROUP_NAME),
PathElement.pathElement(ModelDescriptionConstants.REMOTE_DESTINATION_OUTBOUND_SOCKET_BINDING, bindingName));
op.get(OP_ADDR).set(address.toModelNode());
// setup the other parameters for the add operation
op.get(HOST).set(binding.getDestination());
op.get(PORT).set(binding.getDestinationPort());
// add the ADD operation to the operations list
ops.add(op);
}
}
protected void initializePathsOperations(List<ModelNode> ops) {
if (paths.size() == 0) {
return;
}
for (PathInfo path : paths.values()) {
ModelNode op = new ModelNode();
op.get(OP).set(ADD);
op.get(OP_ADDR).set(PathAddress.pathAddress(PathElement.pathElement(PATH, path.getName())).toModelNode());
op.get(PATH).set(path.getPath());
if (path.getRelativeTo() != null) {
op.get(RELATIVE_TO).set(path.getRelativeTo());
}
ops.add(op);
}
}
private static class PathInfo {
private final String name;
private final String path;
private final String relativeTo;
public PathInfo(String name, String path, String relativeTo) {
this.name = name;
this.path = path;
this.relativeTo = relativeTo;
}
public String getName() {
return name;
}
public String getPath() {
return path;
}
public String getRelativeTo() {
return relativeTo;
}
}
private static class OutboundSocketBinding {
private final String destination;
private final int port;
private final boolean remote;
OutboundSocketBinding(final String destination, final int port, final boolean remote) {
this.destination = destination;
this.port = port;
this.remote = remote;
}
int getDestinationPort() {
return this.port;
}
String getDestination() {
return this.destination;
}
boolean isRemote() {
return this.remote;
}
}
}