org.smartfrog.sfcore.compound
Interface Compound

All Superinterfaces:

ChildMinder, Diagnostics, Liveness, Prim, java.rmi.Remote, RemoteReferenceResolver, RemoteReferenceResolverHelper

All Known Subinterfaces:

CopyFile, DetachingCompound, ProcessCompound

All Known Implementing Classes:

ApacheImpl, ArrayCompoundImpl, Autoloader, Comparator, CompoundImpl, Constant, Container, CopyFileImpl, Delay, Delay, DeployByCopyImpl, Deployer, DetachingCompoundImpl, DisplayThresholderImpl, Dup, During, EventCompoundImpl, FileUsingCompoundImpl, FireBreak, Generator, GraphImpl, LibraryArtifactImpl, LibraryImpl, Negate, NetElemImpl, OnEvent, Parallel, Plus, Printer, ProcessCompoundImpl, RandomSequence, Repeat, Retract, Retry, Run, Sequence, SFSetPropertyImpl, Spawn, Tester, ThresholderImpl, TideMeterImpl, Timeout, Times, Try, UpdatableCompound

public interface Compound
extends Prim, ChildMinder

Defines the compound component interface. A compound deploys component descriptions, and maintains them as part of itself. This includes liveness, termination.

Method Summary

Prim	sfCreateNewApp(java.lang.String name, ComponentDescription cmp, Context parms) A high-level component deployment method - creates a new self-managing application, running it through its entire startup lifecycle.
Prim	sfCreateNewChild(java.lang.Object name, ComponentDescription cmp, Context parms) A high-level component deployment method - creates a child of this Compound, running it through its entire startup lifecycle.
Prim	sfCreateNewChild(java.lang.Object name, Prim parent, ComponentDescription cmp, Context parms) A high-level component deployment method - creates a child of this Compound, running it through its entire startup lifecycle.
Prim	sfDeployComponentDescription(java.lang.Object name, Prim parent, ComponentDescription cmp, Context parms) An internal SmartFrog method.

Methods inherited from interface org.smartfrog.sfcore.prim.Prim

sfAddAttribute, sfAttributeKeyFor, sfAttributes, sfCompleteName, sfContainsAttribute, sfContainsValue, sfContext, sfDeploy, sfDeployedHost, sfDeployedProcessName, sfDeployWith, sfDetach, sfDetachAndTerminate, sfDumpState, sfIsDeployed, sfIsStarted, sfIsTerminated, sfIsTerminating, sfParent, sfParentageChanged, sfRemoveAttribute, sfReplaceAttribute, sfStart, sfTerminate, sfTerminatedWith, sfTerminateQuietlyWith, sfValues

Methods inherited from interface org.smartfrog.sfcore.prim.Liveness

sfPing

Methods inherited from interface org.smartfrog.sfcore.reference.RemoteReferenceResolver

sfResolve, sfResolve, sfResolveHere, sfResolveHere, sfResolveParent

Methods inherited from interface org.smartfrog.sfcore.reference.RemoteReferenceResolverHelper

sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolveWithParser

Methods inherited from interface org.smartfrog.sfcore.prim.Diagnostics

sfDiagnosticsReport

Methods inherited from interface org.smartfrog.sfcore.prim.ChildMinder

sfAddChild, sfChildren, sfContainsChild, sfRemoveChild

Method Detail

sfDeployComponentDescription

Prim sfDeployComponentDescription(java.lang.Object name,
                                  Prim parent,
                                  ComponentDescription cmp,
                                  Context parms)
                                  throws java.rmi.RemoteException,
                                         SmartFrogDeploymentException

An internal SmartFrog method. It deploys a compiled component and makes it an attribute of the parent compound. Also start heartbeating the deployed component if the component registers. Note that the remaining lifecycle methods must still be invoked on the created component - namely sfDeploy() and sfStart(). This is primarily an internal method - the prefered method for end users is sfCreateNewChild(java.lang.Object, org.smartfrog.sfcore.componentdescription.ComponentDescription, org.smartfrog.sfcore.common.Context).

Parameters:

cmp - compiled component to deploy

parent - of deployed component

name - name of attribute which the deployed component should adopt

parms - parameters for description

Returns:

deployed component if successful

Throws:

SmartFrogDeploymentException - failed to deploy compiled component

java.rmi.RemoteException - In case of Remote/nework error

sfCreateNewChild

Prim sfCreateNewChild(java.lang.Object name,
                      ComponentDescription cmp,
                      Context parms)
                      throws java.rmi.RemoteException,
                             SmartFrogDeploymentException

A high-level component deployment method - creates a child of this Compound, running it through its entire startup lifecycle. This is the preferred way of creating new child components of a Compound. The method is safe against multiple calls of lifecycle.

Parameters:

name - name of attribute which the deployed component should adopt

cmp - compiled component to deploy and start

parms - parameters for description

Returns:

deployed component if successful

Throws:

SmartFrogDeploymentException - failed to deploy compiled component

java.rmi.RemoteException - In case of Remote/nework error

sfCreateNewChild

Prim sfCreateNewChild(java.lang.Object name,
                      Prim parent,
                      ComponentDescription cmp,
                      Context parms)
                      throws java.rmi.RemoteException,
                             SmartFrogDeploymentException

A high-level component deployment method - creates a child of this Compound, running it through its entire startup lifecycle. This is the preferred way of creating new child components of a Compound. The method is safe against multiple calls of lifecycle.

Parameters:

name - name of attribute which the deployed component should adopt

parent - of deployed component

cmp - compiled component to deploy and start

parms - parameters for description

Returns:

deployed component if successful

Throws:

SmartFrogDeploymentException - failed to deploy compiled component

java.rmi.RemoteException - In case of Remote/nework error

sfCreateNewApp

Prim sfCreateNewApp(java.lang.String name,
                    ComponentDescription cmp,
                    Context parms)
                    throws java.rmi.RemoteException,
                           SmartFrogDeploymentException

A high-level component deployment method - creates a new self-managing application, running it through its entire startup lifecycle. This is the preferred way of creating new applications.

Parameters:

name - name the deployed application should adopt

cmp - compiled component to deploy and start

parms - parameters for description

Returns:

deployed component if successful

Throws:

SmartFrogDeploymentException - failed to deploy compiled component

java.rmi.RemoteException - In case of Remote/nework error