You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ignite.apache.org by GitBox <gi...@apache.org> on 2022/07/20 10:08:34 UTC

[GitHub] [ignite-extensions] antkr commented on a diff in pull request #166: IGNITE-17381 Add docs for Ignite Sessions

antkr commented on code in PR #166:
URL: https://github.com/apache/ignite-extensions/pull/166#discussion_r925419334


##########
docs/_docs/spring/spring-sessions.adoc:
##########
@@ -0,0 +1,65 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+= Apache Ignite With Spring Session
+
+== Overview
+
+
+Apache Ignite Spring Session integration provides SessionRepository and ReactiveSessionRepository implementation backed by Redis and configuration support. Spring Session simplifies support for clustered sessions without being tied to an application container specific solution.
+
+
+== Maven Configuration
+
+Add the `ignite-spring-session-ext` extension to your Maven use your Ignite servers or clients with Spring Session.
+
+The extension can be added with Maven as follows:
+
+[tabs]
+--
+tab:pom.xml[]
+[source,xml]
+----
+<dependencies>
+  <dependency>
+    <groupId>org.springframework.session</groupId>
+    <artifactId>spring-session-core</artifactId>
+  </dependency>
+  <dependency>
+    <groupId>org.apache.ignite</groupId>
+    <artifactId>ignite-spring-session-ext</artifactId>
+    <version>1.0.0</version>
+  </dependency>
+</dependencies>
+----
+--
+
+Once added, Ignite instance will connect to Spring on start-up automatically. You can use Spring Session annotations in your code. For example, here is how you can create a simple controller:

Review Comment:
   It will happen automatically only if the Ignite extension is enabled, we must use this annotation: https://github.com/apache/ignite-extensions/blob/f5f3e997fd090dc1801885c466bccb04ee54dc9e/modules/spring-session-ext/src/main/java/org/apache/ignite/spring/sessions/EnableIgniteHttpSession.java#L37



##########
docs/_docs/spring/spring-sessions.adoc:
##########
@@ -0,0 +1,65 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+= Apache Ignite With Spring Session
+
+== Overview
+
+
+Apache Ignite Spring Session integration provides SessionRepository and ReactiveSessionRepository implementation backed by Redis and configuration support. Spring Session simplifies support for clustered sessions without being tied to an application container specific solution.

Review Comment:
   Redis should not be mentioned here as we are storing everything in Ignite cache.



##########
docs/_docs/spring/spring-sessions.adoc:
##########
@@ -0,0 +1,65 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+= Apache Ignite With Spring Session
+
+== Overview
+
+
+Apache Ignite Spring Session integration provides SessionRepository and ReactiveSessionRepository implementation backed by Redis and configuration support. Spring Session simplifies support for clustered sessions without being tied to an application container specific solution.
+
+
+== Maven Configuration
+
+Add the `ignite-spring-session-ext` extension to your Maven use your Ignite servers or clients with Spring Session.
+
+The extension can be added with Maven as follows:
+
+[tabs]
+--
+tab:pom.xml[]
+[source,xml]
+----
+<dependencies>
+  <dependency>
+    <groupId>org.springframework.session</groupId>
+    <artifactId>spring-session-core</artifactId>
+  </dependency>
+  <dependency>
+    <groupId>org.apache.ignite</groupId>
+    <artifactId>ignite-spring-session-ext</artifactId>
+    <version>1.0.0</version>
+  </dependency>
+</dependencies>
+----
+--
+
+Once added, Ignite instance will connect to Spring on start-up automatically. You can use Spring Session annotations in your code. For example, here is how you can create a simple controller:
+

Review Comment:
   Second requirement is to mark an Ignite instance with @SpringSessionIgnite:
   https://github.com/apache/ignite-extensions/blob/master/modules/spring-session-ext/src/main/java/org/apache/ignite/spring/sessions/SpringSessionIgnite.java



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org