Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Ignite provides a few options to set custom attributes on client side - : per call (ServiceCallContext) or and per connection (UserAttributes). But Now there is no opportunity to specify set attributes on the "application level". Scenario is:

  1. Application acquires Ignite connections connect from connection pool are used by different applications.
  2. While processing data application need access to application attributes - an associative array of Strings specified on an application sideApplication need specify ApplicationAttributes. Business logic might depend on such attributes - application language, application name for audit, etc ([2], [4]).
  3. Another application re-uses this connect with own attributes values.

It's proposed to provide such the opportunity to set attributes for application. Then there will be hierarchy of attributes:

  1. Call level - ServiceCallContext
  2. Application level - ApplicationAttributes
  3. Connection level - UserAttributes, SecuritySubject

User defined functions might want The access to different level of attributes. For example, SecuritySubject can be used to provide fine-grained access control to cache data. For example, CacheInterceptor saves the subject id it the attributes must be provided for functions that are pre-created on Ignite cluster and aren't deployed by specific application. Examples:

  • CacheInterceptor saves the SecuritySubject along with data and it can be used for fine-grained access control in QuerySqlFunction.
  • Service extracts attribute from ServiceCallContext and, if absent, get default one from ApplicationAttributes.

It. Then it's proposed to introduce SessionContext API that is available from the functions and provides access to all this the attributes while processing data in hierarchical orderin all levels (call, application, connection).

Requirements:

  1. The attributes ​​are explicitly set by application on only once for Ignite API entry point (Ignite, IgniteClient, JDBC).
  2. The attributes are fixed for every Ignite API call (can't be changed in the middle of the data processing)available on all participating nodes of the application requests and queries.
  3. The attributes must be accessible in stored functions on all nodes participated in requests and queriespre-defined functions:
    1. QuerySqlFunction
    2. CacheInterceptor
    3. Service
    4. ComputeTask, ComputeJob

Attributes API that aren't part of the IEP:

  1. ClientListenerConnectionContext#attributes - it's actually how client stores UserAttribute in connection context.
  2. ComputeTaskSession#setAttribute - this mechanism is available only within Compute API. It allows attributes to be changed during task lifetime, use-case is different - send sync/async notifications between jobs about events happened during task lifetime.

...

  1. The list of attributes that can be set using #setClientInfo is arbitrary. The documentation recommends strictly limiting the set of attributes, but this is not necessary. For example, Oracle does not have such a limitation [5]. The setClientInfo array is completely translated into the getClientAttributes array ApplicationAttributes array.
  2. The parameters set in setClientInfo are passed along with each JdbcRequest (this requires a new feature in JdbcThinFeature).
  3. The client must reset the set values ​​itself.

...

Ignite provides SessionContextProviderResource to access to SessionContext. Provider instead of direct instance of the context is used for optimization. Injecting instance

  1. Injecting requires to have new instance of CacheInterceptor or QuerySqlFunction target class

...

  1. for every

...

  1. call (every row or key).
  2. Instead single object is maintained with injected Provider.
  3. Provider implementation is responsible for extracting context from Ignite thread.
  4. Note, it proposes to make possible use non-static QuerySqlFunction to inject the resource.

Code Block
languagejava
/** SessionContext interface. It's an entrypoint for all attributes. */
public class SessionContext {
    /** @return Attribute by name. */
    public @Nullable String getAttribute(String attrName);

    /** @return Current SecuritySubject. */
	public @Nullable SecuritySubject getSecuritySubject();
 }
 
/** Example, use it in QuerySqlFunction. */
public static class UserDefinedFunctions {
    /** */
    @SessionContextProviderResource
    public SessionContextProvider sesCtxProv;

     /** @return Session ID set with application attributes. */
    @QuerySqlFunction
    public @Nullable String sessionId() {             
		SessionContext sesCtx = sesCtxProv.getSessionContext();

        return sesCtx == null ? null : sesCtx.getAttribute("SESSION_ID");
    }
}

...