org.smartfrog.sfcore.prim
Class PrimHookSet

java.lang.Object
  org.smartfrog.sfcore.prim.PrimHookSet

All Implemented Interfaces:

MessageKeys

public class PrimHookSet
extends java.lang.Object
implements MessageKeys

This class implements the collection of PrimHooks to be applied to each component in a process when a lifecycle method is invoked.

Field Summary

protected java.util.Vector

theSet The set of PrimHooks.

Fields inherited from interface org.smartfrog.sfcore.common.MessageKeys

CANNOT_LINK_TO_PREDICATE, COMPONENT_TERMINATED, COPY_FAILED, COPY_SERIALIZE_FAILED, ERROR_NO_SECURITY_BUT_REQUIRED, ILLEGAL_BOOLEAN_PARAMETER, ILLEGAL_NUMERIC_PARAMETER, ILLEGAL_STRING_PARAMETER, ILLEGAL_VECTOR_PARAMETER, LIVENESS_SEND_FAILURE, LIVENESS_SEND_FAILURE_IN, MISSING_PARAMETER, MSG_CLASS_NOT_FOUND, MSG_CONNECT_ERR, MSG_CONT_OTHER_DEPLOY, MSG_DEPLOY_COMP_TERMINATED, MSG_DEPLOY_SUCCESS, MSG_DEPLOYWITH_PHASE_FAILED, MSG_DETACH_SUCCESS, MSG_DETACH_TERMINATE_SUCCESS, MSG_ERR_DEPLOY_FROM_URL, MSG_ERR_PARSE, MSG_ERR_RESOLVE_PHASE, MSG_ERR_SF_RUNNING, MSG_ERR_TERM, MSG_FAILED_INET_ADDRESS_LOOKUP, MSG_FAILED_TO_CONTACT_PARENT, MSG_FILE_NOT_FOUND, MSG_HOOK_ACTION_FAILED, MSG_ILLEGAL_ACCESS, MSG_ILLEGAL_CLASS_TYPE, MSG_ILLEGAL_CLASS_TYPE_EXPECTING_GOT, MSG_ILLEGAL_REFERENCE, MSG_INPUTSTREAM_NULL, MSG_INSTANTIATION_ERROR, MSG_INVALID_OBJECT_TYPE, MSG_INVOCATION_TARGET, MSG_LANG_NOT_FOUND, MSG_LIVENESS_START_FAILED, MSG_LOADING_URL, MSG_METHOD_NOT_FOUND, MSG_NON_REP_ATTRIB, MSG_NOT_COMPONENT_REFERENCE, MSG_NOT_FOUND_ATTRIBUTE, MSG_NOT_FOUND_REFERENCE, MSG_NOT_VALUE_REFERENCE, MSG_NULL_DEF_METHOD, MSG_NULL_URL, MSG_OBJECT_REGISTRATION_FAILED, MSG_PARENT_LOCATION_FAILED, MSG_PING_SUCCESS, MSG_RANDM_ERR, MSG_REMOTE_CONNECT_ERR, MSG_REPEATED_ATTRIBUTE, MSG_SF_DEAD, MSG_SF_READY, MSG_SF_TERMINATED, MSG_STACKTRACE_FOLLOWS, MSG_START_COMP_TERMINATED, MSG_TERMINATE_SUCCESS, MSG_UNHANDLED_EXCEPTION, MSG_UNKNOWN_HOST, MSG_UNRESOLVED_REFERENCE, MSG_UNRESOLVED_REFERENCE_IN, MSG_UPDATE_SUCCESS, MSG_URL_NOT_FOUND, MSG_URL_TO_PARSE_NOT_FOUND, MSG_WARNING_LIVENESS_ENABLED, MSG_WARNING_STACKTRACE_DISABLED, MSG_WARNING_STACKTRACE_ENABLED, ROOT_MUST_BE_COMPONENT, WARN_NO_SECURITY

Constructor Summary

PrimHookSet()
create an empty set.

Method Summary

void	addHook(PrimHook hook) Add a hook to the set.
void	applyHooks(Prim prim, TerminationRecord terminationRecord) Applies user written hooks to the component.
void	removeHook(PrimHook hook) Remove a hook from the set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

theSet

protected java.util.Vector theSet

The set of PrimHooks.

Constructor Detail

PrimHookSet

public PrimHookSet()

create an empty set.

Method Detail

addHook

public void addHook(PrimHook hook)

Add a hook to the set.

Parameters:

hook - the hook to add

removeHook

public void removeHook(PrimHook hook)
                throws SmartFrogLifecycleException

Remove a hook from the set.

Parameters:

hook - Hook to remove

Throws:

SmartFrogLifecycleException - failed to find the hook

applyHooks

public void applyHooks(Prim prim,
                       TerminationRecord terminationRecord)
                throws SmartFrogLifecycleException

Applies user written hooks to the component.

Parameters:

prim - The prim on which the hook is being applied

terminationRecord - It is used only in the TerminationWith hooks, it is a TerminationRecord indicating the cause of the termination. It is null in all other hooks

Throws:

SmartFrogLifecycleException - thrown by one of the hooks