|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Flow<P extends Presence,C extends Communication,R>
Flow are the high-level component to provide flow-related functionality. Every component is mandatorly assigned to a flow componen. Flows shows tree structure, refining the overall processes of the given application. According to the specification of the Brillien, there are several services provided by a flow: - sharing - acknowledgement about the commmunication of their components - possible fault handling - etc.
Field Summary |
---|
Fields inherited from interface com.vii.brillien.kernel.axiom.atomic.Presence |
---|
CONSONANT, RESIDENT, SPARKLE |
Method Summary | ||
---|---|---|
void |
activate(C c,
Long timeout)
Activates the flow instance, making it started. |
|
C |
getActivationData()
Gets the parameters gotten while the given flow has been activated with. |
|
String |
getFlowID()
Gets the flow ID of the Presence. |
|
|
getFlowResult()
Returns the result of the flow if it exists |
|
HashMap<String,Object> |
getStateSpace()
This method retrieves the state space of the flow called when the flow will be suspended |
|
boolean |
isIndispensable()
Tells whether this Flow represents an action which cannot fail, so cluster replication is needed. |
|
boolean |
isSuspended()
Tells whether the flow has been suspended. |
|
void |
oppress(String message)
Sets all state of a flow to "Error" state marking it to be terminated. |
|
void |
report(Presence reporter,
String message)
Report method to share any communication related information of the components with the container flow instance. |
|
void |
report(Presence reporter,
String message,
List<Object> params)
Report method to share any communication related information of the components with the container flow instance. |
|
void |
revivified()
Notify the given flow instance about the occured revivfication process. |
|
Flow<P,C,R> |
setFlowID(String flowID)
Setter method for the ID |
|
void |
setFlowResult(Object result)
Sets the result of the flow |
|
void |
setIndispensable(boolean indispensable)
Setter method for an indispensable flow |
|
void |
setStateSpace(HashMap<String,Object> stateSpace)
This method sets the state space of the flow called when the flow will be reactivated |
|
void |
suspend()
All Indispensable flows can be suspended and resumed. |
|
void |
terminate()
Sets all state of a flow to "Exit" state marking it to be terminated. |
Methods inherited from interface com.vii.brillien.kernel.axiom.atomic.Context |
---|
addExceptionLeveling, clearExceptionLeveling, getSharing, getShifter, hasSharing, levelException, registerSharing, removeExceptionLeveling, removeSharing |
Methods inherited from interface com.vii.brillien.kernel.axiom.atomic.Unit |
---|
activateUnitAll, activateUnitCallable, activateUnitMessaging, addPresence, addPresences, addSubUnit, addSubUnits, classify, clearPresences, clearSubUnits, communicationUnitReceived, complement, getCharacteristicFunction, getPresences, getSubUnits, hasUnitActivity, intersect, isSubSet, isUnitInExitState, isUnitInValidStates, isUnitWaitingForResponse, order, passivateUnitAll, passivateUnitCallable, passivateUnitMessaging, printUnitErrorStates, removePresence, removePresences, removeSubUnit, removeSubUnits, retrieveUnit, scrutinise, setCharacteristicFunction, subset, symmetricDifference, union |
Methods inherited from interface com.vii.brillien.kernel.axiom.atomic.Presence |
---|
activateAll, addSuperUnits, clearSuperUnits, getApiKeyPresenceName, getApiVersion, getFlow, getLoggedUser, getLoggedUser, getPresence, getPresenceManager, getSharing, getSSOPresenceName, getSuperUnits, loginUser, passivateAll, printErrorStates, removeSuperUnits, retrieve, setApiVersion, setFlow, setPresenceManager |
Methods inherited from interface com.vii.brillien.kernel.axiom.Presence |
---|
aspirationTimeIsUp, getAspirationPattern, getAspirationTimeMeasure, getFullName, getInterface, getMessageProcessorParameterNames, getMessageProcessorParameterTypes, getName, hasMessageProcessorReturnValue, isAspirationPeriodical, reset, setAspirationPattern, setAspirationPeriodical, setAspirationTimeMeasure, setName |
Methods inherited from interface com.vii.brillien.kernel.axiom.Aspirer |
---|
activateCallable, getResult, hasActivity, isWaitingForInputData, isWaitingForResponse, passivateCallable, plan, sendAGet, sendDelegatedSet, sendError, sendError, sendError, sendGet, sendGet, sendResponse, sendSet, sendUnitAGet, sendUnitDelegatedSet, sendUnitGet, sendUnitGet, sendUnitSet |
Methods inherited from interface java.util.concurrent.Callable |
---|
call |
Methods inherited from interface com.vii.brillien.kernel.axiom.Sensor |
---|
activateMessaging, communicationReceived, errorReceived, passivateMessaging, presenseChangedState |
Methods inherited from interface com.vii.brillien.kernel.axiom.Progressor |
---|
addState, changeState, getActualStates, getPotentialStates, getStateDivision, hasStateMachine, initStateMashine, isInExitState, isInState, isInValidStates, panic, registerStateChangeNotification, removeState, setStateDivision, unregisterStateChangeNotification |
Method Detail |
---|
String getFlowID()
Presence
Flow<P,C,R> setFlowID(String flowID)
flowID
- identifier of the given flow
boolean isIndispensable()
void setIndispensable(boolean indispensable)
void report(Presence reporter, String message)
reporter
- reporter Presence referencemessage
- communication' message namevoid report(Presence reporter, String message, List<Object> params)
reporter
- reporter Presence referencemessage
- communication' message nameparams
- communication' message oarameters<T> T getFlowResult()
void setFlowResult(Object result)
void activate(C c, Long timeout) throws BrillienException
BrillienException
- in case of operation failureC getActivationData()
void oppress(String message) throws BrillienException
BrillienException
- in case of operation failurevoid terminate() throws BrillienException
BrillienException
- in case of operation failureboolean isSuspended()
void suspend() throws BrillienException
BrillienException
- in case of suspend failure or the non-indispensable nature of the given flow instancevoid revivified() throws BrillienException
BrillienException
HashMap<String,Object> getStateSpace()
void setStateSpace(HashMap<String,Object> stateSpace) throws BrillienException
BrillienException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |