ServletRequestedSessionIdFromCookieAttribute (Undertow 2.1.0.Final API)

Skip navigation links

Undertow 2.1.0.Final

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- io.undertow.servlet.attribute.ServletRequestedSessionIdFromCookieAttribute

All Implemented Interfaces:: ExchangeAttribute

public class ServletRequestedSessionIdFromCookieAttribute
extends Object
implements ExchangeAttribute

The request session ID

Author:: Stuart Douglas

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ServletRequestedSessionIdFromCookieAttribute.Builder

Field Summary

Fields
Modifier and Type Field and Description

static ServletRequestedSessionIdFromCookieAttribute INSTANCE

static String REQUESTED_SESSION_ID_FROM_COOKIE

Constructor Summary

Constructors
Constructor and Description

ServletRequestedSessionIdFromCookieAttribute()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`readAttribute(HttpServerExchange exchange)` Resolve the attribute from the HTTP server exchange.
`void`	`writeAttribute(HttpServerExchange exchange, String newValue)` Sets a new value for the attribute.

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

- Field Detail
  - REQUESTED_SESSION_ID_FROM_COOKIE
```
public static final String REQUESTED_SESSION_ID_FROM_COOKIE
```
    See Also:
    
    Constant Field Values
  - INSTANCE
```
public static final ServletRequestedSessionIdFromCookieAttribute INSTANCE
```
- Constructor Detail
  - ServletRequestedSessionIdFromCookieAttribute
```
public ServletRequestedSessionIdFromCookieAttribute()
```
- Method Detail
  - readAttribute
```
public String readAttribute(HttpServerExchange exchange)
```
    Description copied from interface: ExchangeAttribute
    
    Resolve the attribute from the HTTP server exchange. This may return null if the attribute is not present.
    
    Specified by:
    
    readAttribute in interface ExchangeAttribute
    
    Parameters:
    
    exchange - The exchange
    
    Returns:
    
    The attribute
  - writeAttribute
```
public void writeAttribute(HttpServerExchange exchange,
                           String newValue)
                    throws ReadOnlyAttributeException
```
    Description copied from interface: ExchangeAttribute
    
    Sets a new value for the attribute. Not all attributes are writable.
    
    Specified by:
    
    writeAttribute in interface ExchangeAttribute
    
    Parameters:
    
    exchange - The exchange
    
    newValue - The new value for the attribute
    
    Throws:
    
    ReadOnlyAttributeException - when attribute cannot be written

Skip navigation links

Undertow 2.1.0.Final

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2020 JBoss by Red Hat. All rights reserved.