WebSocketHandshakeExtractor (ninja-core 7.0.1-SNAPSHOT API)

java.lang.Object
- ninja.websockets.WebSocketHandshakeExtractor

All Implemented Interfaces:

ArgumentExtractor<WebSocketHandshake>
```
public class WebSocketHandshakeExtractor
extends Object
implements ArgumentExtractor<WebSocketHandshake>
```
Extracts a WebSocketHandshake stored in the Context as an attribute. Allows you to simply request it as a parameter in a controller method :-).

Author:

jjlauer

Constructor Summary

Constructors
Constructor Description

WebSocketHandshakeExtractor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`WebSocketHandshake`	`extract(Context context)`	Extract the argument from the context
`Class<WebSocketHandshake>`	`getExtractedType()`	Get the type of the argument that is extracted
`String`	`getFieldName()`	Get the field name that is being extracted, if this value is extracted from a field

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebSocketHandshakeExtractor
```
public WebSocketHandshakeExtractor()
```
- Method Detail
  - extract
```
public WebSocketHandshake extract(Context context)
```
    Description copied from interface: ArgumentExtractor
    
    Extract the argument from the context
    
    Specified by:
    
    extract in interface ArgumentExtractor<WebSocketHandshake>
    
    Parameters:
    
    context - The argument to extract
    
    Returns:
    
    The extracted argument
  - getExtractedType
```
public Class<WebSocketHandshake> getExtractedType()
```
    Description copied from interface: ArgumentExtractor
    
    Get the type of the argument that is extracted
    
    Specified by:
    
    getExtractedType in interface ArgumentExtractor<WebSocketHandshake>
    
    Returns:
    
    The type of the argument that is being extracted
  - getFieldName
```
public String getFieldName()
```
    Description copied from interface: ArgumentExtractor
    
    Get the field name that is being extracted, if this value is extracted from a field
    
    Specified by:
    
    getFieldName in interface ArgumentExtractor<WebSocketHandshake>
    
    Returns:
    
    The field name, or null if the argument isn't extracted from a named field