Package org.jboss.as.remoting.management

Class ManagementRemotingServices

java.lang.Object

org.jboss.as.remoting.RemotingServices

org.jboss.as.remoting.management.ManagementRemotingServices

public final class ManagementRemotingServices
extends RemotingServices

Utility class to add remoting services

Author:

David M. Lloyd, Kabir Khan, Richard Opalka

Field Summary

Fields

Modifier and Type	Field	Description
static String	DOMAIN_CHANNEL	The name of the channel used between slave and master DCs
static String	HTTP_CONNECTOR
static String	HTTPS_CONNECTOR
static String	MANAGEMENT_CHANNEL	The name of the external management channel
static String	MANAGEMENT_CONNECTOR
static org.jboss.msc.service.ServiceName	MANAGEMENT_ENDPOINT	The name of the endpoint service used for management
static String	SERVER_CHANNEL	The name of the channel used for Server to HC comms
static org.jboss.msc.service.ServiceName	SHUTDOWN_EXECUTOR_NAME

Fields inherited from class org.jboss.as.remoting.RemotingServices

HTTP_LISTENER_REGISTRY, REMOTING_BASE, SUBSYSTEM_ENDPOINT

Method Summary

Modifier and Type	Method	Description
static void	installDomainConnectorServices(org.jboss.as.controller.OperationContext context, org.jboss.msc.service.ServiceTarget serviceTarget, org.jboss.msc.service.ServiceName endpointName, org.jboss.msc.service.ServiceName networkInterfaceBinding, int port, org.xnio.OptionMap options, org.jboss.msc.service.ServiceName saslAuthenticationFactory, org.jboss.msc.service.ServiceName sslContext)	Installs a remoting stream server for a domain instance
static void	installManagementChannelOpenListenerService(org.jboss.msc.service.ServiceTarget serviceTarget, org.jboss.msc.service.ServiceName endpointName, String channelName, org.jboss.msc.service.ServiceName operationHandlerName, org.xnio.OptionMap options, boolean onDemand)	Set up the services to create a channel listener.
static void	installManagementChannelServices(org.jboss.msc.service.ServiceTarget serviceTarget, org.jboss.msc.service.ServiceName endpointName, org.jboss.as.controller.remote.ModelControllerOperationHandlerFactory operationHandlerServiceFactory, org.jboss.msc.service.ServiceName modelControllerName, String channelName, org.jboss.msc.service.ServiceName executorServiceName, org.jboss.msc.service.ServiceName scheduledExecutorServiceName)	Set up the services to create a channel listener and operation handler service.
static void	isManagementResourceRemoveable(org.jboss.as.controller.OperationContext context, org.jboss.as.controller.PathAddress otherManagementEndpoint)	Manual check because introducing a capability can't be done without a full refactoring.
static void	removeManagementChannelOpenListenerService(org.jboss.as.controller.OperationContext context, org.jboss.msc.service.ServiceName endpointName, String channelName)
static void	removeManagementChannelServices(org.jboss.as.controller.OperationContext context, org.jboss.msc.service.ServiceName endpointName, String channelName)

Methods inherited from class org.jboss.as.remoting.RemotingServices

channelServiceName, connectorServiceName, installConnectorServicesForNetworkInterfaceBinding, installConnectorServicesForSocketBinding, installRemotingManagementEndpoint, installRemotingManagementEndpoint, removeConnectorServices, serverServiceName

Methods inherited from class java.lang.Object

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

Field Detail

MANAGEMENT_ENDPOINT

public static final org.jboss.msc.service.ServiceName MANAGEMENT_ENDPOINT

The name of the endpoint service used for management

SHUTDOWN_EXECUTOR_NAME

public static final org.jboss.msc.service.ServiceName SHUTDOWN_EXECUTOR_NAME

MANAGEMENT_CHANNEL

public static final String MANAGEMENT_CHANNEL

The name of the external management channel

See Also:

Constant Field Values

DOMAIN_CHANNEL

public static final String DOMAIN_CHANNEL

The name of the channel used between slave and master DCs

See Also:

Constant Field Values

SERVER_CHANNEL

public static final String SERVER_CHANNEL

The name of the channel used for Server to HC comms

See Also:

Constant Field Values

MANAGEMENT_CONNECTOR

public static final String MANAGEMENT_CONNECTOR

See Also:

Constant Field Values

HTTP_CONNECTOR

public static final String HTTP_CONNECTOR

See Also:

Constant Field Values

HTTPS_CONNECTOR

public static final String HTTPS_CONNECTOR

See Also:

Constant Field Values

Method Detail

installDomainConnectorServices

public static void installDomainConnectorServices(org.jboss.as.controller.OperationContext context,
                                                  org.jboss.msc.service.ServiceTarget serviceTarget,
                                                  org.jboss.msc.service.ServiceName endpointName,
                                                  org.jboss.msc.service.ServiceName networkInterfaceBinding,
                                                  int port,
                                                  org.xnio.OptionMap options,
                                                  org.jboss.msc.service.ServiceName saslAuthenticationFactory,
                                                  org.jboss.msc.service.ServiceName sslContext)

Installs a remoting stream server for a domain instance

Parameters:

serviceTarget - the service target to install the services into

endpointName - the name of the endpoint to install the stream server into

networkInterfaceBinding - the network interface binding

port - the port

securityRealm - the security real name

options - the remoting options

installManagementChannelOpenListenerService

public static void installManagementChannelOpenListenerService(org.jboss.msc.service.ServiceTarget serviceTarget,
                                                               org.jboss.msc.service.ServiceName endpointName,
                                                               String channelName,
                                                               org.jboss.msc.service.ServiceName operationHandlerName,
                                                               org.xnio.OptionMap options,
                                                               boolean onDemand)

Set up the services to create a channel listener. This assumes that an endpoint service called endpointName exists.

Parameters:

serviceTarget - the service target to install the services into

endpointName - the name of the endpoint to install a channel listener into

channelName - the name of the channel

operationHandlerName - the name of the operation handler to handle request for this channel

options - the remoting options

onDemand - whether to install the services on demand

removeManagementChannelOpenListenerService

public static void removeManagementChannelOpenListenerService(org.jboss.as.controller.OperationContext context,
                                                              org.jboss.msc.service.ServiceName endpointName,
                                                              String channelName)

installManagementChannelServices

public static void installManagementChannelServices(org.jboss.msc.service.ServiceTarget serviceTarget,
                                                    org.jboss.msc.service.ServiceName endpointName,
                                                    org.jboss.as.controller.remote.ModelControllerOperationHandlerFactory operationHandlerServiceFactory,
                                                    org.jboss.msc.service.ServiceName modelControllerName,
                                                    String channelName,
                                                    org.jboss.msc.service.ServiceName executorServiceName,
                                                    org.jboss.msc.service.ServiceName scheduledExecutorServiceName)

Set up the services to create a channel listener and operation handler service.

Parameters:

serviceTarget - the service target to install the services into

endpointName - the endpoint name to install the services into

channelName - the name of the channel

executorServiceName - service name of the executor service to use in the operation handler service

scheduledExecutorServiceName - service name of the scheduled executor service to use in the operation handler service

removeManagementChannelServices

public static void removeManagementChannelServices(org.jboss.as.controller.OperationContext context,
                                                   org.jboss.msc.service.ServiceName endpointName,
                                                   String channelName)

isManagementResourceRemoveable

public static void isManagementResourceRemoveable(org.jboss.as.controller.OperationContext context,
                                                  org.jboss.as.controller.PathAddress otherManagementEndpoint)
                                           throws org.jboss.as.controller.OperationFailedException

Manual check because introducing a capability can't be done without a full refactoring. This has to go as soon as the management interfaces are redesigned.

Parameters:

context - the OperationContext

otherManagementEndpoint - : the address to check that may provide an exposed jboss-remoting endpoint.

Throws:

org.jboss.as.controller.OperationFailedException - in case we can't remove the management resource.