org.fabric3.api.node

Interface Fabric

public interface Fabric

Main API for interfacing with a service fabric.

Method Summary

Modifier and Type	Method and Description
Fabric	addExtension(java.lang.String name) Adds an extension to the fabric configuration.
Fabric	addExtension(java.net.URL location) Adds an extension to the fabric configuration.
Fabric	addProfile(java.lang.String name) Adds a profile to the fabric configuration.
Fabric	addProfile(java.net.URL location) Adds a profile to the fabric configuration.
<T> T	createTransportDispatcher(java.lang.Class<T> interfaze, java.util.Map<java.lang.String,java.lang.Object> properties) Creates and returns the dispatcher for a transport identified by the given interface.
Domain	getDomain() Returns the fabric domain
<T> T	getSystemService(java.lang.Class<T> interfaze) Returns the system service.
<T> Fabric	registerSystemService(java.lang.Class<T> interfaze, T instance) Registers an instance as a system component.
Fabric	start() Starts the connection to the fabric.
Fabric	startRuntime() Starts the container runtime.
Fabric	startTransports() Starts the remote transports to receive requests.
Fabric	stop() Stops the connection to the fabric.

Method Detail

addProfile

Fabric addProfile(java.lang.String name)

Adds a profile to the fabric configuration. The profile name is either the full artifact id without version information or its shortened for, i.e. without the 'profile-' prefix. This method must be called before start().

Parameters:

name - the profile name

Returns:

the fabric

addProfile

Fabric addProfile(java.net.URL location)

Adds a profile to the fabric configuration. This method must be called before start().

Parameters:

location - the profile location

Returns:

the fabric

addExtension

Fabric addExtension(java.lang.String name)

Adds an extension to the fabric configuration. The profile name is the full artifact id without version information. This method must be called before start().

Parameters:

name - the extension name

Returns:

the fabric

addExtension

Fabric addExtension(java.net.URL location)

Adds an extension to the fabric configuration. This method must be called before start().

Parameters:

location - the extension location

Returns:

the fabric

start

Fabric start()
      throws FabricException

Starts the connection to the fabric.

Returns:

the fabric

Throws:

FabricException - if there is an error connecting.

startRuntime

Fabric startRuntime()
             throws FabricException

Starts the container runtime.

Returns:

the fabric

Throws:

FabricException - if there is an error starting the runtime.

startTransports

Fabric startTransports()
                throws FabricException

Starts the remote transports to receive requests.

Returns:

the fabric

Throws:

FabricException - if there is an error starting the transports.

stop

Fabric stop()
     throws FabricException

Stops the connection to the fabric.

Returns:

the fabric

Throws:

FabricException - if there an error stopping the connection

createTransportDispatcher

<T> T createTransportDispatcher(java.lang.Class<T> interfaze,
                                java.util.Map<java.lang.String,java.lang.Object> properties)

Creates and returns the dispatcher for a transport identified by the given interface. NOTE: This method must be called before the runtime is started.

Parameters:

interfaze - the dispatcher interface

properties - optional transport properties

Returns:

the dispatcher or null if not found

getSystemService

<T> T getSystemService(java.lang.Class<T> interfaze)

Returns the system service. This method is for use integrating Fabric3 with host containers.

Parameters:

interfaze - the service interface

Returns:

the service or null if not found

registerSystemService

<T> Fabric registerSystemService(java.lang.Class<T> interfaze,
                                 T instance)
                          throws FabricException

Registers an instance as a system component. This method must be called before start()}.

Parameters:

interfaze - the service interface of the instance

instance - the instance

Returns:

the fabric

Throws:

FabricException - if there is a registration error

getDomain

Domain getDomain()

Returns the fabric domain

Returns:

the domain