org.jboss.as.logging.loggers

Class LoggerAssignHandler

java.lang.Object

org.jboss.as.controller.AbstractModelUpdateHandler

org.jboss.as.logging.loggers.AbstractLogHandlerAssignmentHandler

org.jboss.as.logging.loggers.LoggerAssignHandler

All Implemented Interfaces:

OperationStepHandler

Direct Known Subclasses:

RootLoggerAssignHandler

public class LoggerAssignHandler
extends AbstractLogHandlerAssignmentHandler

Operation responsible assigning a handler to a logger.

Author:

Stan Silvert

Field Summary

Fields

Modifier and Type	Field and Description
static LoggerAssignHandler	INSTANCE
static String	OPERATION_NAME

Constructor Summary

Constructors

Constructor and Description
LoggerAssignHandler()

Method Summary

Methods

Modifier and Type	Method and Description
static org.jboss.msc.service.ServiceController<org.jboss.logmanager.Logger>	addHandler(OperationContext context, String loggerName, String handlerName, ServiceVerificationHandler verificationHandler) Adds the handler, represented by the handlerNameToAdd parameter, to the logger.
static List<org.jboss.msc.service.ServiceController<?>>	addHandlers(org.jboss.dmr.ModelNode handlers, OperationContext context, String loggerName, ServiceVerificationHandler verificationHandler) Adds the handlers to the logger.
protected String	getHandlerName(org.jboss.dmr.ModelNode operation) Returns the name of the handler.
protected String	getLoggerName(org.jboss.dmr.ModelNode operation)
static Collection<org.jboss.msc.service.ServiceController<?>>	installHandlers(org.jboss.msc.service.ServiceTarget serviceTarget, String loggerName, org.jboss.dmr.ModelNode handlers, ServiceVerificationHandler verificationHandler)
protected void	performRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model, ServiceVerificationHandler verificationHandler, List<org.jboss.msc.service.ServiceController<?>> newControllers) Make any runtime changes necessary to effect the changes indicated by the given operation.
protected void	updateModel(org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model) Update the given node in the persistent configuration model based on the values in the given operation.

Methods inherited from class org.jboss.as.logging.loggers.AbstractLogHandlerAssignmentHandler

createFailureMessage, handlerExists, updateHandlersForAssign, updateHandlersForUnassign

Methods inherited from class org.jboss.as.controller.AbstractModelUpdateHandler

execute, requiresRuntime, requiresRuntimeVerification, rollbackRuntime, updateModel

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

See Also:

Constant Field Values

INSTANCE

public static final LoggerAssignHandler INSTANCE

Constructor Detail

LoggerAssignHandler

public LoggerAssignHandler()

Method Detail

updateModel

protected void updateModel(org.jboss.dmr.ModelNode operation,
               org.jboss.dmr.ModelNode model)
                    throws OperationFailedException

Description copied from class: AbstractModelUpdateHandler

Update the given node in the persistent configuration model based on the values in the given operation.

Specified by:

updateModel in class AbstractModelUpdateHandler

Parameters:

operation - the operation

model - persistent configuration model node that corresponds to the address of operation

Throws:

OperationFailedException - if operation is invalid or populating the model otherwise fails

getHandlerName

protected String getHandlerName(org.jboss.dmr.ModelNode operation)
                         throws OperationFailedException

Description copied from class: AbstractLogHandlerAssignmentHandler

Returns the name of the handler.

Specified by:

getHandlerName in class AbstractLogHandlerAssignmentHandler

Parameters:

operation - the model node to retrieve the name from.

Returns:

the handler name.

Throws:

OperationFailedException - if a failure occurs.

getLoggerName

protected String getLoggerName(org.jboss.dmr.ModelNode operation)

performRuntime

protected void performRuntime(OperationContext context,
                  org.jboss.dmr.ModelNode operation,
                  org.jboss.dmr.ModelNode model,
                  ServiceVerificationHandler verificationHandler,
                  List<org.jboss.msc.service.ServiceController<?>> newControllers)
                       throws OperationFailedException

Description copied from class: AbstractModelUpdateHandler

Make any runtime changes necessary to effect the changes indicated by the given operation. Executes after AbstractModelUpdateHandler.updateModel(org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode), so the given model parameter will reflect any changes made in that method.

This default implementation does nothing.

Overrides:

performRuntime in class AbstractModelUpdateHandler

Parameters:

context - the operation context

operation - the operation being executed

model - persistent configuration model node that corresponds to the address of operation

verificationHandler - step handler that can be added as a listener to any new services installed in order to validate the services installed correctly during the VERIFY stage

newControllers - holder for the ServiceController for any new services installed by the method. The method should add the ServiceController for any new services to this list. If the overall operation needs to be rolled back, the list will be used in AbstractModelUpdateHandler.rollbackRuntime(OperationContext, ModelNode, ModelNode, java.util.List) to automatically removed the newly added services

Throws:

OperationFailedException - if operation is invalid or updating the runtime otherwise fails

addHandler

public static org.jboss.msc.service.ServiceController<org.jboss.logmanager.Logger> addHandler(OperationContext context,
                                                                              String loggerName,
                                                                              String handlerName,
                                                                              ServiceVerificationHandler verificationHandler)
                                                                                       throws OperationFailedException

Adds the handler, represented by the handlerNameToAdd parameter, to the logger.

Parameters:

context - the context of the operation.

loggerName - the logger name.

handlerName - the name of the handler to add.

verificationHandler - a verification handler for the builder, or null if no verification handler is needed.

Returns:

the service that was installed.

Throws:

OperationFailedException - if an error occurs.

installHandlers

public static Collection<org.jboss.msc.service.ServiceController<?>> installHandlers(org.jboss.msc.service.ServiceTarget serviceTarget,
                                                                     String loggerName,
                                                                     org.jboss.dmr.ModelNode handlers,
                                                                     ServiceVerificationHandler verificationHandler)

addHandlers

public static List<org.jboss.msc.service.ServiceController<?>> addHandlers(org.jboss.dmr.ModelNode handlers,
                                                           OperationContext context,
                                                           String loggerName,
                                                           ServiceVerificationHandler verificationHandler)
                                                                    throws OperationFailedException

Adds the handlers to the logger.

Parameters:

context - the context of the operation.

loggerName - the name of the logger.

verificationHandler - a verification handler for the builder, or null if no verification handler is needed.

Returns:

a collection of the installed controllers.

Throws:

OperationFailedException - if an error occurs.