Package org.apache.iceberg.catalog

Class SessionCatalog.SessionContext

java.lang.Object

org.apache.iceberg.catalog.SessionCatalog.SessionContext

Enclosing interface:

SessionCatalog

public static final class SessionCatalog.SessionContext
extends Object

Context for a session.

Constructor Summary

Constructors

Constructor	Description
SessionContext(String sessionId, String identity, Map<String,String> credentials, Map<String,String> properties)
SessionContext(String sessionId, String identity, Map<String,String> credentials, Map<String,String> properties, Object wrappedIdentity)

Method Summary

Modifier and Type	Method	Description
static SessionCatalog.SessionContext	createEmpty()
Map<String,String>	credentials()	Returns the session's credential map.
String	identity()	Returns a string that identifies the current user or principal.
Map<String,String>	properties()	Returns a map of properties currently set for the session.
String	sessionId()	Returns a string that identifies this session.
Object	wrappedIdentity()	Returns the opaque wrapped identity object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SessionContext

public SessionContext(String sessionId,
 String identity,
 Map<String,String> credentials,
 Map<String,String> properties)

SessionContext

public SessionContext(String sessionId,
 String identity,
 Map<String,String> credentials,
 Map<String,String> properties,
 Object wrappedIdentity)

Method Details

createEmpty

public static SessionCatalog.SessionContext createEmpty()

sessionId

public String sessionId()

Returns a string that identifies this session.

This can be used for caching state within a session.

Returns:

a string that identifies this session

identity

public String identity()

Returns a string that identifies the current user or principal.

This identity cannot change for a given session ID.

Returns:

a user or principal identity string

credentials

public Map<String,String> credentials()

Returns the session's credential map.

This cannot change for a given session ID.

Returns:

a credential string

properties

public Map<String,String> properties()

Returns a map of properties currently set for the session.

Returns:

a map of properties

wrappedIdentity

public Object wrappedIdentity()

Returns the opaque wrapped identity object.

Returns:

the wrapped identity