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) Deprecated. use fromBaseCapability(String) on base
RuntimeCapability<T>	fromBaseCapability(String dynamicElement) Creates a fully named capability from a dynamically named base capability.
org.jboss.msc.service.ServiceName	getCapabilityServiceName() Gets the name of the service provided by this capability, if there is one.
org.jboss.msc.service.ServiceName	getCapabilityServiceName(Class<?> serviceValueType) Gets the name of service provided by this capability.
org.jboss.msc.service.ServiceName	getCapabilityServiceName(String dynamicNameElement) Gets the name of the service provided by this capability, if there is one.
org.jboss.msc.service.ServiceName	getCapabilityServiceName(String dynamicNameElement, Class<?> serviceValueType) Gets the name of service provided by this capability.
Class<?>	getCapabilityServiceValueType() Gets the valid type to pass to getCapabilityServiceName(Class).
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

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

Deprecated. use fromBaseCapability(String) on base

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()

Gets the name of the service provided by this capability, if there is one.

Returns:

the name of the service. Will not be null

Throws:

IllegalArgumentException - if the capability does not provide a service

getCapabilityServiceName

public org.jboss.msc.service.ServiceName getCapabilityServiceName(Class<?> serviceValueType)

Gets the name of service provided by this capability.

Parameters:

serviceValueType - the expected type of the service's value. Only used to provide validate that the service value type provided by the capability matches the caller's expectation. May be null in which case no validation is performed

Returns:

the name of the service. Will not be null

Throws:

IllegalArgumentException - if the capability does not provide a service or if its value type is not assignable to serviceValueType

getCapabilityServiceName

public org.jboss.msc.service.ServiceName getCapabilityServiceName(String dynamicNameElement)

Gets the name of the service provided by this capability, if there is one. Only usable with dynamically named capabilities.

Parameters:

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

Returns:

the name of the service. Will not be null

Throws:

IllegalArgumentException - if the capability does not provide a service

AssertionError - if AbstractCapability.isDynamicallyNamed() does not return true

getCapabilityServiceName

public org.jboss.msc.service.ServiceName getCapabilityServiceName(String dynamicNameElement,
                                                                  Class<?> serviceValueType)

Gets the name of service provided by this capability.

Parameters:

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

serviceValueType - the expected type of the service's value. Only used to provide validate that the service value type provided by the capability matches the caller's expectation. May be null in which case no validation is performed

Returns:

the name of the service. Will not be null

Throws:

IllegalArgumentException - if the capability does not provide a service or if its value type is not assignable to serviceValueType

IllegalStateException - if AbstractCapability.isDynamicallyNamed() does not return true

getCapabilityServiceValueType

public Class<?> getCapabilityServiceValueType()

Gets the valid type to pass to getCapabilityServiceName(Class).

Returns:

the valid type. May be null if this capability does not provide a service

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

fromBaseCapability

public RuntimeCapability<T> fromBaseCapability(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.

Parameters:

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

Returns:

the fully named capability.

Throws:

AssertionError - if AbstractCapability.isDynamicallyNamed() returns false