org.jboss.as.controller.capability

Class RuntimeCapability<T>

java.lang.Object

org.jboss.as.controller.capability.AbstractCapability

org.jboss.as.controller.capability.RuntimeCapability<T>

Type Parameters:

T - the type of the runtime API object exposed by the capability

public class RuntimeCapability<T>
extends AbstractCapability

A capability exposed in a running WildFly process.

Author:

Brian Stansberry (c) 2014 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RuntimeCapability.Builder<T> Builder for a RuntimeCapability.

Constructor Summary

Constructors

Constructor and Description
RuntimeCapability(String name, T runtimeAPI, Set<String> requirements) Deprecated. use a RuntimeCapability.Builder
RuntimeCapability(String name, T runtimeAPI, Set<String> requirements, Set<String> optionalRequirements) Deprecated. use a RuntimeCapability.Builder
RuntimeCapability(String name, T runtimeAPI, String... requirements) Deprecated. use a RuntimeCapability.Builder

Method Summary

Modifier and Type	Method and Description
static String	buildDynamicCapabilityName(String baseName, String dynamicNameElement) Constructs a full capability name from a static base name and a dynamic element.
static <T> RuntimeCapability<T>	fromBaseCapability(RuntimeCapability<T> base, String dynamicElement) Creates a fully named capability from a dynamically named base capability.
org.jboss.msc.service.ServiceName	getCapabilityServiceName(Class serviceType) Gets the name of service provided by this capability whose value is of the given type.
T	getRuntimeAPI() Object encapsulating the API exposed by this capability to other capabilities that require it, if it does expose such an API.

Methods inherited from class org.jboss.as.controller.capability.AbstractCapability

equals, getDynamicName, getDynamicOptionalRequirements, getDynamicRequirements, getName, getOptionalRequirements, getRequirements, getRuntimeOnlyRequirements, hashCode, isDynamicallyNamed, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RuntimeCapability

@Deprecated
public RuntimeCapability(String name,
                                     T runtimeAPI,
                                     Set<String> requirements,
                                     Set<String> optionalRequirements)

Deprecated. use a RuntimeCapability.Builder

Creates a new capability

Parameters:

name - the name of the capability. Cannot be null

runtimeAPI - implementation of the API exposed by this capability to other capabilities. May be null

requirements - names of other capabilities upon which this capability has a hard requirement. May be null

optionalRequirements - names of other capabilities upon which this capability has an optional requirement. May be null

RuntimeCapability

@Deprecated
public RuntimeCapability(String name,
                                     T runtimeAPI,
                                     Set<String> requirements)

Deprecated. use a RuntimeCapability.Builder

Creates a new capability

Parameters:

name - the name of the capability. Cannot be null

runtimeAPI - implementation of the API exposed by this capability to other capabilities. May be null

requirements - names of other capabilities upon which this capability has a hard requirement. May be null

RuntimeCapability

@Deprecated
public RuntimeCapability(String name,
                                     T runtimeAPI,
                                     String... requirements)

Deprecated. use a RuntimeCapability.Builder

Creates a new capability

Parameters:

name - the name of the capability. Cannot be null

runtimeAPI - implementation of the API exposed by this capability to other capabilities. May be null

requirements - names of other capabilities upon which this capability has a hard requirement. May be null

Method Detail

buildDynamicCapabilityName

public static String buildDynamicCapabilityName(String baseName,
                                                String dynamicNameElement)

Constructs a full capability name from a static base name and a dynamic element.

Parameters:

baseName - the base name. Cannot be null

dynamicNameElement - the dynamic portion of the name. Cannot be null

Returns:

the full capability name. Will not return null

fromBaseCapability

public static <T> RuntimeCapability<T> fromBaseCapability(RuntimeCapability<T> base,
                                                          String dynamicElement)

Creates a fully named capability from a dynamically named base capability. Capability providers should use this method to generate fully named capabilities in logic that handles dynamically named resources.

Type Parameters:

T - the type of the runtime API object exposed by the capability

Parameters:

base - the base capability. Cannot be null, and AbstractCapability.isDynamicallyNamed() must return true

dynamicElement - the dynamic portion of the full capability name. Cannot be null or empty

Returns:

the fully name capability.

getCapabilityServiceName

public org.jboss.msc.service.ServiceName getCapabilityServiceName(Class serviceType)

Gets the name of service provided by this capability whose value is of the given type.

Parameters:

serviceType - the expected type of the service's value. Cannot be null

Returns:

the name of the service. Will not be null

Throws:

IllegalArgumentException - if serviceType is null or the capability does not provide a service of type serviceType

getRuntimeAPI

public T getRuntimeAPI()

Object encapsulating the API exposed by this capability to other capabilities that require it, if it does expose such an API.

Returns:

the API object, or null if the capability exposes no API to other capabilities