-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
AS7-1854 Add a basis for extensions to better encapsulate the notion …
…of a 'resource'
- Loading branch information
1 parent
b0014c6
commit f1e743c
Showing
25 changed files
with
594 additions
and
273 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
164 changes: 164 additions & 0 deletions
164
controller/src/main/java/org/jboss/as/controller/SimpleResourceDefinition.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| /* | ||
| * JBoss, Home of Professional Open Source. | ||
| * Copyright 2011, Red Hat, Inc., 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.controller; | ||
|
|
||
| import org.jboss.as.controller.descriptions.DefaultResourceAddDescriptionProvider; | ||
| import org.jboss.as.controller.descriptions.DefaultResourceDescriptionProvider; | ||
| import org.jboss.as.controller.descriptions.DefaultResourceRemoveDescriptionProvider; | ||
| import org.jboss.as.controller.descriptions.DescriptionProvider; | ||
| import org.jboss.as.controller.descriptions.ModelDescriptionConstants; | ||
| import org.jboss.as.controller.descriptions.ResourceDescriptionResolver; | ||
| import org.jboss.as.controller.registry.ImmutableManagementResourceRegistration; | ||
| import org.jboss.as.controller.registry.ManagementResourceRegistration; | ||
|
|
||
| /** | ||
| * Basic implementation of {@link ResourceDefinition}. | ||
| * | ||
| * @author Brian Stansberry (c) 2011 Red Hat Inc. | ||
| */ | ||
| public class SimpleResourceDefinition implements ResourceDefinition { | ||
|
|
||
| private final PathElement pathElement; | ||
| private final ResourceDescriptionResolver descriptionResolver; | ||
| private final DescriptionProvider descriptionProvider; | ||
| private final OperationStepHandler addHandler; | ||
| private final OperationStepHandler removeHandler; | ||
|
|
||
| /** | ||
| * {@link ResourceDefinition} that uses the given {code descriptionProvider} to describe the resource. | ||
| * | ||
| * @param pathElement the path. Cannot be {@code null}. | ||
| * @param descriptionProvider the description provider. Cannot be {@code null} | ||
| * | ||
| * @throws IllegalArgumentException if any parameter is {@code null}. | ||
| */ | ||
| public SimpleResourceDefinition(final PathElement pathElement, final DescriptionProvider descriptionProvider) { | ||
| if (pathElement == null) { | ||
| throw new IllegalArgumentException("pathElement is null"); | ||
| } | ||
| if (descriptionProvider == null) { | ||
| throw new IllegalArgumentException("descriptionProvider is null"); | ||
| } | ||
| this.pathElement = pathElement; | ||
| this.descriptionResolver = null; | ||
| this.descriptionProvider = descriptionProvider; | ||
| this.addHandler = null; | ||
| this.removeHandler = null; | ||
| } | ||
|
|
||
| /** | ||
| * {@link ResourceDefinition} that uses the given {code descriptionResolver} to configure a | ||
| * {@link DefaultResourceDescriptionProvider} to describe the resource. | ||
| * | ||
| * @param pathElement the path. Cannot be {@code null}. | ||
| * @param descriptionResolver the description resolver to use in the description provider. Cannot be {@code null} | ||
| * | ||
| * @throws IllegalArgumentException if any parameter is {@code null}. | ||
| */ | ||
| public SimpleResourceDefinition(final PathElement pathElement, final ResourceDescriptionResolver descriptionResolver) { | ||
| this(pathElement, descriptionResolver, null, null); | ||
| } | ||
|
|
||
| /** | ||
| * {@link ResourceDefinition} that uses the given {code descriptionResolver} to configure a | ||
| * {@link DefaultResourceDescriptionProvider} to describe the resource. | ||
| * | ||
| * @param pathElement the path. Cannot be {@code null}. | ||
| * @param descriptionResolver the description resolver to use in the description provider. Cannot be {@code null} * | ||
| * @param addHandler a handler to {@link #registerOperations(ManagementResourceRegistration) register} for the resource "add" operation. | ||
| * Can be {@null} | ||
| * @param removeHandler a handler to {@link #registerOperations(ManagementResourceRegistration) register} for the resource "remove" operation. | ||
| * Can be {@null} | ||
| * | ||
| * @throws IllegalArgumentException if any parameter is {@code null}. | ||
| */ | ||
| public SimpleResourceDefinition(final PathElement pathElement, final ResourceDescriptionResolver descriptionResolver, | ||
| final OperationStepHandler addHandler, final OperationStepHandler removeHandler) { | ||
| if (pathElement == null) { | ||
| throw new IllegalArgumentException("pathElement is null"); | ||
| } | ||
| if (descriptionResolver == null) { | ||
| throw new IllegalArgumentException("descriptionResolver is null"); | ||
| } | ||
| this.pathElement = pathElement; | ||
| this.descriptionResolver = descriptionResolver; | ||
| this.descriptionProvider = null; | ||
| this.addHandler = addHandler; | ||
| this.removeHandler = removeHandler; | ||
| } | ||
|
|
||
| @Override | ||
| public PathElement getPathElement() { | ||
| return pathElement; | ||
| } | ||
|
|
||
| @Override | ||
| public DescriptionProvider getDescriptionProvider(ImmutableManagementResourceRegistration resourceRegistration) { | ||
| return descriptionProvider == null | ||
| ? new DefaultResourceDescriptionProvider(resourceRegistration, descriptionResolver) | ||
| : descriptionProvider; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| * Registers an add operation handler or a remove operation handler if one was provided to the constructor. | ||
| */ | ||
| @Override | ||
| public void registerOperations(ManagementResourceRegistration resourceRegistration) { | ||
| if (addHandler != null) { | ||
| registerAddOperation(resourceRegistration, addHandler); | ||
| } | ||
| if (removeHandler != null) { | ||
| registerRemoveOperation(resourceRegistration, removeHandler); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void registerAttributes(ManagementResourceRegistration resourceRegistration) { | ||
| // no-op | ||
| } | ||
|
|
||
| /** | ||
| * Gets the {@link ResourceDescriptionResolver} used by this resource definition, or {@code null} | ||
| * if a {@code ResourceDescriptionResolver} is not used. | ||
| * | ||
| * @return the resource description resolver, or {@code null} | ||
| */ | ||
| public ResourceDescriptionResolver getResourceDescriptionResolver() { | ||
| return descriptionResolver; | ||
| } | ||
|
|
||
| protected void registerAddOperation(final ManagementResourceRegistration registration, final OperationStepHandler handler) { | ||
| DescriptionProvider provider = handler instanceof DescriptionProvider | ||
| ? (DescriptionProvider) handler | ||
| : new DefaultResourceAddDescriptionProvider(registration, descriptionResolver); | ||
| registration.registerOperationHandler(ModelDescriptionConstants.ADD, handler, provider); | ||
| } | ||
|
|
||
| protected void registerRemoveOperation(final ManagementResourceRegistration registration, final OperationStepHandler handler) { | ||
| DescriptionProvider provider = handler instanceof DescriptionProvider | ||
| ? (DescriptionProvider) handler | ||
| : new DefaultResourceRemoveDescriptionProvider(descriptionResolver); | ||
| registration.registerOperationHandler(ModelDescriptionConstants.REMOVE, handler, provider); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.