org.jboss.as.logging

Interface ConfigurationProperty<T>

All Known Implementing Classes:

LogHandlerListAttributeDefinition, PropertyAttributeDefinition, PropertyObjectTypeAttributeDefinition

public interface ConfigurationProperty<T>

Used for configuring logging properties.

Author:

James R. Perkins

Method Summary

Modifier and Type	Method and Description
String	getPropertyName() Returns the property name for the logging configuration property.
T	resolvePropertyValue(OperationContext context, org.jboss.dmr.ModelNode model) Resolves the value of the model node the type.
ModelNodeResolver<T>	resolver() Returns the resolver for the attribute.
void	setPropertyValue(OperationContext context, org.jboss.dmr.ModelNode model, org.jboss.logmanager.config.PropertyConfigurable configuration) Sets the property on the configuration.

Method Detail

resolver

ModelNodeResolver<T> resolver()

Returns the resolver for the attribute.

Returns:

the resolver.

getPropertyName

String getPropertyName()

Returns the property name for the logging configuration property.

Returns:

the property name.

resolvePropertyValue

T resolvePropertyValue(OperationContext context,
                       org.jboss.dmr.ModelNode model)
                throws OperationFailedException

Resolves the value of the model node the type. Uses the ModelNodeResolver.resolveValue(org.jboss.as.controller.OperationContext, org.jboss.dmr.ModelNode) to resolve the value. If the resolver is null, either null is returned or a default value based on the type implementation.

Parameters:

context - the operation context.

model - the model used to resolve the value from.

Returns:

the resolved value or null.

Throws:

OperationFailedException - if the value is invalid.

setPropertyValue

void setPropertyValue(OperationContext context,
                      org.jboss.dmr.ModelNode model,
                      org.jboss.logmanager.config.PropertyConfigurable configuration)
               throws OperationFailedException

Sets the property on the configuration.

If the result of resolvePropertyValue(org.jboss.as.controller.OperationContext, org.jboss.dmr.ModelNode) is not null, the value is set on the property with String.valueOf(Object). If the result is null and the model is defined, ModelNode.asString() is used for the property, otherwise the property is removed from the handler.

Parameters:

context - the operation context used to resolve the value from the model.

model - the model used to resolve the value.

configuration - the configuration to set the value on.

Throws:

OperationFailedException - if the value is invalid.