Top Description Inners Fields Constructors Methods
io.undertow.server.session

public Class SslSessionConfig

extends Object
implements SessionConfig
Class Inheritance
All Implemented Interfaces
io.undertow.server.session.SessionConfig
Imports
io.undertow.UndertowLogger, io.undertow.server.HttpServerExchange, .SSLSessionInfo, java.util.Arrays, .HashMap, .Map
Session config that stores the session ID in the current SSL session.

It allows for a fallback to be provided for non-ssl connections

Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
SslSessionConfig.Key

Field Summary

Modifier and TypeField and Description
private final SessionConfig
fallbackSessionConfig

private final Map<String, SslSessionConfig.Key>
reverse

private final Map<SslSessionConfig.Key, String>
sessions

Constructor Summary

AccessConstructor and Description
public
SslSessionConfig(final SessionConfig fallbackSessionConfig, SessionManager sessionManager)

public
SslSessionConfig(SessionManager sessionManager)

Method Summary

Modifier and TypeMethod and Description
public void
clearSession(final HttpServerExchange
The exchange
exchange, final String
The session id
sessionId)

Implements io.undertow.server.session.SessionConfig.clearSession.

Clears this session from the exchange, removing the attachment and making any changes to the response necessary, such as clearing cookies.

public String
findSessionId(final HttpServerExchange
The exchange
exchange)

Implements io.undertow.server.session.SessionConfig.findSessionId.

Retrieves a session id of an existing session from an exchange.

public String
rewriteUrl(final String originalUrl, final String sessionId)

Implements io.undertow.server.session.SessionConfig.rewriteUrl.

public SessionConfig.SessionCookieSource
sessionCookieSource(HttpServerExchange exchange)

Implements io.undertow.server.session.SessionConfig.sessionCookieSource.

public void
setSessionId(final HttpServerExchange
The exchange
exchange, final String
The session
sessionId)

Implements io.undertow.server.session.SessionConfig.setSessionId.

Attaches the session to the exchange.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fallbackSessionConfigback to summary
private final SessionConfig fallbackSessionConfig
reverseback to summary
private final Map<String, SslSessionConfig.Key> reverse
sessionsback to summary
private final Map<SslSessionConfig.Key, String> sessions

Constructor Detail

SslSessionConfigback to summary
public SslSessionConfig(final SessionConfig fallbackSessionConfig, SessionManager sessionManager)
SslSessionConfigback to summary
public SslSessionConfig(SessionManager sessionManager)

Method Detail

clearSessionback to summary
public void clearSession(final HttpServerExchange exchange, final String sessionId)

Implements io.undertow.server.session.SessionConfig.clearSession.

Doc from io.undertow.server.session.SessionConfig.clearSession.

Clears this session from the exchange, removing the attachment and making any changes to the response necessary, such as clearing cookies.

Parameters
exchange:HttpServerExchange

The exchange

sessionId:String

The session id

Annotations
@Override
findSessionIdback to summary
public String findSessionId(final HttpServerExchange exchange)

Implements io.undertow.server.session.SessionConfig.findSessionId.

Doc from io.undertow.server.session.SessionConfig.findSessionId.

Retrieves a session id of an existing session from an exchange.

Parameters
exchange:HttpServerExchange

The exchange

Returns:String

The session id, or null

Annotations
@Override
rewriteUrlback to summary
public String rewriteUrl(final String originalUrl, final String sessionId)

Implements io.undertow.server.session.SessionConfig.rewriteUrl.

Annotations
@Override
sessionCookieSourceback to summary
public SessionConfig.SessionCookieSource sessionCookieSource(HttpServerExchange exchange)

Implements io.undertow.server.session.SessionConfig.sessionCookieSource.

Annotations
@Override
setSessionIdback to summary
public void setSessionId(final HttpServerExchange exchange, final String sessionId)

Implements io.undertow.server.session.SessionConfig.setSessionId.

Doc from io.undertow.server.session.SessionConfig.setSessionId.

Attaches the session to the exchange. The method should attach the exchange under an attachment key, and should also modify the exchange to allow the session to be re-attached on the next request.

Generally this will involve setting a cookie

Once a session has been attached it must be possible to retrieve it via findSessionId(io.undertow.server.HttpServerExchange)

Parameters
exchange:HttpServerExchange

The exchange

sessionId:String

The session

Annotations
@Override
io.undertow.server.session back to summary

private final Class SslSessionConfig.Key

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final byte[]
id

Constructor Summary

AccessConstructor and Description
private
Key(byte[] id)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

idback to summary
private final byte[] id

Constructor Detail

Keyback to summary
private Key(byte[] id)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override