TreeHook (OpenAM Server Only 7.3.1 Documentation)

```
@SupportedAll
public interface TreeHook
```
A TreeHook encapsulates some functionality that should be executed at the end of a tree, after authentication. They can be added by nodes.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface TreeHook.Metadata
Annotation that describes the metadata of the node.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`NODE_ID_KEY`	Node ID key.
`static String`	`NODE_TYPE_KEY`	Node type key.
`static String`	`SESSION_HOOK_CLASS_KEY`	Session hook class key.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`accept()`	Main method that will contain the logic that needs to be executed when the session hook is called.

- Field Detail
  - SESSION_HOOK_CLASS_KEY
```
static final String SESSION_HOOK_CLASS_KEY
```
    Session hook class key.
    
    See Also:
    
    Constant Field Values
  - NODE_ID_KEY
```
static final String NODE_ID_KEY
```
    Node ID key.
    
    See Also:
    
    Constant Field Values
  - NODE_TYPE_KEY
```
static final String NODE_TYPE_KEY
```
    Node type key.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - accept
```
void accept()
     throws org.forgerock.openam.auth.node.api.TreeHookException
```
    Main method that will contain the logic that needs to be executed when the session hook is called.
    
    Throws:
    
    org.forgerock.openam.auth.node.api.TreeHookException - if an exception occurs.