org.jboss.as.controller.capability

Class ServiceNameProvider.DefaultProvider

java.lang.Object

org.jboss.as.controller.capability.ServiceNameProvider.DefaultProvider

All Implemented Interfaces:

ServiceNameProvider

Enclosing interface:

ServiceNameProvider

public static class ServiceNameProvider.DefaultProvider
extends Object
implements ServiceNameProvider

Default ServiceNameProvider implementation that provides a service name that is created by splitting the capability name on any '.' character.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.as.controller.capability.ServiceNameProvider

ServiceNameProvider.DefaultProvider

Constructor Summary

Constructors

Constructor and Description
DefaultProvider(String capabilityName) Creates a provider for the given capability that provides no service names.
DefaultProvider(String capabilityName, Class legalType) Creates a provider for the given capability that provides no a service name for the given type.
DefaultProvider(String capabilityName, Map<Class,org.jboss.msc.service.ServiceName> services) Creates a provider for the given capability that provides the given service names for the given types.

Method Summary

Modifier and Type	Method and Description
static org.jboss.msc.service.ServiceName	capabilityToServiceName(String capabilityName) Converts a capability name to a service name by splitting the capability name on any '.' character.
org.jboss.msc.service.ServiceName	getCapabilityServiceName(Class<?> serviceType) Gets the name of a service provided by the capability.
org.jboss.msc.service.ServiceName	getCapabilityServiceName(Class<?> serviceType, String dynamicPortion) Gets the name of a service provided by the capability, including a dynamic portion of the capability name that won't be known at compile time.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultProvider

public DefaultProvider(String capabilityName)

Creates a provider for the given capability that provides no service names.

Parameters:

capabilityName - the capability name. Cannot be null or empty

DefaultProvider

public DefaultProvider(String capabilityName,
                       Class legalType)

Creates a provider for the given capability that provides no a service name for the given type.

Parameters:

capabilityName - the capability name. Cannot be null or empty

legalType - the type for which service names should be provided. Cannot be null

DefaultProvider

public DefaultProvider(String capabilityName,
                       Map<Class,org.jboss.msc.service.ServiceName> services)

Creates a provider for the given capability that provides the given service names for the given types.

Parameters:

capabilityName - the capability name. Cannot be null or empty

services - the mapping of valid types to services names. Cannot be null, but can be empty

Method Detail

capabilityToServiceName

public static org.jboss.msc.service.ServiceName capabilityToServiceName(String capabilityName)

Converts a capability name to a service name by splitting the capability name on any '.' character.

Parameters:

capabilityName - the capability name. Cannot be null or empty

Returns:

the service name. Will not be null

getCapabilityServiceName

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

Description copied from interface: ServiceNameProvider

Gets the name of a service provided by the capability.

Specified by:

getCapabilityServiceName in interface ServiceNameProvider

Parameters:

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

Returns:

the name of the service. Will not be null

getCapabilityServiceName

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

Description copied from interface: ServiceNameProvider

Gets the name of a service provided by the capability, including a dynamic portion of the capability name that won't be known at compile time.

Specified by:

getCapabilityServiceName in interface ServiceNameProvider

Parameters:

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

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

Returns:

the name of the service. Will not be null