IExtension (SNF4J 1.10.0 API)

All Known Implementing Classes:

PerMessageDeflateExtension
```
public interface IExtension
```
A Web Socket extension.

Author:

SNF4J.ORG

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IExtension`	`acceptOffer(List<String> offer)` Called by the Web Socket server to accept the received extension negotiation offer.
`Object`	`getGroupId()` Returns an object that identifies the group to which the extension belongs.
`String`	`getName()` Returns the name of the extension.
`List<String>`	`offer()` Called by the Web Socket client to prepare the extension negotiation offer.
`List<String>`	`response()` Called by the Web Socket server to prepare the extension negotiation response.
`void`	`updateDecoders(ICodecPipeline pipeline)` Called to update the decoder pipeline.
`void`	`updateEncoders(ICodecPipeline pipeline)` Called to update the encoder pipeline.
`IExtension`	`validateResponse(List<String> response)` Called by the Web Socket client to validate the received extension negotiation response.

- Method Detail
  - getName
```
String getName()
```
    Returns the name of the extension.
    
    Returns:
    
    the name of the extension
  - getGroupId
```
Object getGroupId()
```
    Returns an object that identifies the group to which the extension belongs. This identifier is used to group different extensions that cannot coexist in the list of extensions being the outcome of the negotiation process.
    
    Returns:
    
    an object identifying the group
  - acceptOffer
```
IExtension acceptOffer(List<String> offer)
                throws InvalidExtensionException
```
    Called by the Web Socket server to accept the received extension negotiation offer. The received offer is split into a list of following tokens:
```
extension-name, param-name1, param-value1, ... , param-nameN, param-valueN
```
    If a parameter was offered with no value its value in the list will be null. For example following extension negotiation offer
```
foo; y=10; x; z="5"
```
    will be split into following list of tokens:
```
"foo", "y", "10", "x", null, "z", "5"
```
    Parameters:
    
    offer - the offer split into a list of tokens
    
    Returns:
    
    the extension that will be used by the Web Socket server, or null if the negotiation offer could not be accepted by this extension.
    
    Throws:
    
    InvalidExtensionException - if the negotiation offer syntax was invalid
  - validateResponse
```
IExtension validateResponse(List<String> response)
                     throws InvalidExtensionException
```
    Called by the Web Socket client to validate the received extension negotiation response. The received response is split into a list of following tokens:
```
extension-name, param-name1, param-value1, ... , param-nameN, param-valueN
```
    If a parameter was responded with no value its value in the list will be null. For example following extension negotiation response
```
foo; y=10; x; z="5"
```
    will be split into following list of tokens:
```
"foo", "y", "10", "x", null, "z", "5"
```
    Parameters:
    
    response - the response split into a list of tokens
    
    Returns:
    
    the extension that will be used by the Web Socket client, or null if the negotiation response could not be validated by this extension.
    
    Throws:
    
    InvalidExtensionException - if the negotiation response syntax was invalid
  - offer
```
List<String> offer()
```
    Called by the Web Socket client to prepare the extension negotiation offer. The prepared offer have to be split into a list of following tokens:
```
extension-name, param-name1, param-value1, ... , param-nameN, param-valueN
```
    If a parameter in the offer has no value its value in the list have to be null. For example following extension negotiation offer
```
foo; y; x=10
```
    have to be split into following list of tokens:
```
"foo", "y", null, "y", "10"
```
    Returns:
    
    the offer split into a list of tokens
  - response
```
List<String> response()
```
    Called by the Web Socket server to prepare the extension negotiation response. The prepared response have to be split into a list of following tokens:
```
extension-name, param-name1, param-value1, ... , param-nameN, param-valueN
```
    If a parameter in the response has no value its value in the list have to be null. For example following extension negotiation response
```
foo; y; x=10
```
    have to be split into following list of tokens:
```
"foo", "y", null, "y", "10"
```
    Returns:
    
    the response split into a list of tokens
  - updateEncoders
```
void updateEncoders(ICodecPipeline pipeline)
```
    Called to update the encoder pipeline.
    
    Parameters:
    
    pipeline - the pipeline to update
  - updateDecoders
```
void updateDecoders(ICodecPipeline pipeline)
```
    Called to update the decoder pipeline.
    
    Parameters:
    
    pipeline - the pipeline to update

Interface IExtension

Method Summary

Method Detail

getName

getGroupId

acceptOffer

validateResponse

offer

response

updateEncoders

updateDecoders