Package org.wildfly.subsystem.service.capability

Interface CapabilityServiceInstaller

All Superinterfaces:
org.wildfly.service.Installer<org.jboss.as.controller.CapabilityServiceTarget>, ResourceServiceInstaller
All Known Implementing Classes:
CapabilityServiceInstaller.DefaultCapabilityServiceInstaller
public interface CapabilityServiceInstaller extends ResourceServiceInstaller, org.wildfly.service.Installer<org.jboss.as.controller.CapabilityServiceTarget>
A ResourceServiceInstaller that encapsulates service installation into a CapabilityServiceTarget.
Author:
Paul Ferraro

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    CapabilityServiceInstaller.Builder<T,V>
    Builds a CapabilityServiceInstaller.
    static class 
    CapabilityServiceInstaller.DefaultBuilder<T,V>
     
    static class 
    CapabilityServiceInstaller.DefaultCapabilityServiceInstaller
     

    Nested classes/interfaces inherited from interface org.wildfly.service.Installer

    org.wildfly.service.Installer.AbstractBuilder<B extends Object,I extends org.wildfly.service.Installer<ST>,ST extends org.jboss.msc.service.ServiceTarget,SB extends DSB,DSB extends org.jboss.msc.service.ServiceBuilder<?>>, org.wildfly.service.Installer.AbstractNullaryBuilder<B extends Object,I extends org.wildfly.service.Installer<ST>,ST extends org.jboss.msc.service.ServiceTarget,SB extends DSB,DSB extends org.jboss.msc.service.ServiceBuilder<?>>, org.wildfly.service.Installer.AbstractUnaryBuilder<B extends Object,I extends org.wildfly.service.Installer<ST>,ST extends org.jboss.msc.service.ServiceTarget,SB extends DSB,DSB extends org.jboss.msc.service.ServiceBuilder<?>,T extends Object,V extends Object>, org.wildfly.service.Installer.BlockingBuilder<B extends Object>, org.wildfly.service.Installer.Configuration<SB extends DSB,DSB extends org.jboss.msc.service.ServiceBuilder<?>>, org.wildfly.service.Installer.DefaultInstaller<ST extends org.jboss.msc.service.ServiceTarget,SB extends DSB,DSB extends org.jboss.msc.service.ServiceBuilder<?>>, org.wildfly.service.Installer.StartWhen, org.wildfly.service.Installer.UnaryBuilder<B extends Object,I extends org.wildfly.service.Installer<ST>,ST extends org.jboss.msc.service.ServiceTarget,SB extends org.jboss.msc.service.ServiceBuilder<?>,T extends Object,V extends Object>, org.wildfly.service.Installer.UnaryService<T extends Object,V extends Object>

  • Field Summary

    Fields inherited from interface org.wildfly.subsystem.service.ResourceServiceInstaller

    NONE

  • Method Summary

    Modifier and Type
    Method
    Description
    static <T, V> CapabilityServiceInstaller.Builder<T,V>
    builder(org.jboss.as.controller.capability.RuntimeCapability<Void> capability, Function<T,V> mapper, Supplier<T> factory)
    Returns a CapabilityServiceInstaller builder for the specified capability whose installed service provides the value supplied by the specified factory and mapping function.
    static <V> CapabilityServiceInstaller.Builder<V,V>
    builder(org.jboss.as.controller.capability.RuntimeCapability<Void> capability, Supplier<V> factory)
    Returns a CapabilityServiceInstaller builder for the specified capability whose installed service provides the value supplied by the specified factory.
    static <V> CapabilityServiceInstaller.Builder<V,V>
    builder(org.jboss.as.controller.capability.RuntimeCapability<Void> capability, ServiceDependency<V> dependency)
    Returns a CapabilityServiceInstaller builder for the specified capability whose installed service provides the value supplied by the specified dependency.
    static <V> CapabilityServiceInstaller.Builder<V,V>
    builder(org.jboss.as.controller.capability.RuntimeCapability<Void> capability, V value)
    Returns a CapabilityServiceInstaller builder for the specified capability whose installed service provides the specified value.
    default Consumer<org.jboss.as.controller.OperationContext>
    install(org.jboss.as.controller.OperationContext context)
    Installs a service into the target associated with the specified operation context.

    Methods inherited from interface org.wildfly.service.Installer

    install

  • Method Details

    • builder

      static <V> CapabilityServiceInstaller.Builder<V,V> builder(org.jboss.as.controller.capability.RuntimeCapability<Void> capability, V value)
      Returns a CapabilityServiceInstaller builder for the specified capability whose installed service provides the specified value. By default, the installed service will start when installed since the provided value is already available.
      Type Parameters:
      V - the service value type
      Parameters:
      capability - the target capability
      value - the service value
      Returns:
      a service installer builder

    • builder

      static <V> CapabilityServiceInstaller.Builder<V,V> builder(org.jboss.as.controller.capability.RuntimeCapability<Void> capability, ServiceDependency<V> dependency)
      Returns a CapabilityServiceInstaller builder for the specified capability whose installed service provides the value supplied by the specified dependency. By default, the installed service will start when the specified dependency is available.
      Type Parameters:
      V - the service value type
      Parameters:
      capability - the target capability
      dependency - a service dependency
      Returns:
      a service installer builder

    • builder

      static <V> CapabilityServiceInstaller.Builder<V,V> builder(org.jboss.as.controller.capability.RuntimeCapability<Void> capability, Supplier<V> factory)
      Returns a CapabilityServiceInstaller builder for the specified capability whose installed service provides the value supplied by the specified factory. By default, the installed service will start when required.
      Type Parameters:
      V - the service value type
      Parameters:
      capability - the target capability
      factory - provides the service value
      Returns:
      a service installer builder

    • builder

      static <T, V> CapabilityServiceInstaller.Builder<T,V> builder(org.jboss.as.controller.capability.RuntimeCapability<Void> capability, Function<T,V> mapper, Supplier<T> factory)
      Returns a CapabilityServiceInstaller builder for the specified capability whose installed service provides the value supplied by the specified factory and mapping function. By default, the installed service will start when required.
      Type Parameters:
      T - the source value type
      V - the service value type
      Parameters:
      capability - the target capability
      mapper - a function that returns the service value given the value supplied by the factory
      factory - provides the input to the specified mapper
      Returns:
      a service installer builder

    • install

      default Consumer<org.jboss.as.controller.OperationContext> install(org.jboss.as.controller.OperationContext context)
      Description copied from interface: ResourceServiceInstaller
      Installs a service into the target associated with the specified operation context.
      Specified by:
      install in interface ResourceServiceInstaller
      Parameters:
      context - an operation context
      Returns:
      a mechanism to remove the installed service