org.jboss.as.controller.capability

Interface ServiceNameProvider

All Known Implementing Classes:

ServiceNameProvider.DefaultProvider

public interface ServiceNameProvider

Interface a RuntimeCapability uses to provide service names to users of the capability.

Author:

Brian Stansberry (c) 2015 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ServiceNameProvider.DefaultProvider Default ServiceNameProvider implementation that provides a service name that is created by splitting the capability name on any '.' character.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getCapabilityServiceName

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

Gets the name of a service provided by the capability.

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

getCapabilityServiceName

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.

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

Throws:

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