Referencing code as examples for using this extension (#28)

<!-- Please describe your pull request here. -->

## References

- TODO

<!-- References to relevant GitHub issues and pull requests, esp.
upstream and downstream changes -->

## Submitter checklist

- [ ] The PR request is well described and justified, including the body
and the references
- [ ] The PR title represents the desired changelog entry
- [ ] The repository's code style is followed (see the contributing
guide)
- [ ] Test coverage that demonstrates that the change works as expected
- [ ] For new features, there's necessary documentation in this pull
request or in a subsequent PR to
[wiremock.org](https://github.com/wiremock/wiremock.org)

<!--
Put an `x` into the [ ] to show you have filled the information.
The template comes from
https://github.com/wiremock/.github/blob/main/.github/pull_request_template.md
You can override it by creating .github/pull_request_template.md in your
own repository
-->

Author: dirkbolte

README.md

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.wiremock.extensions.state;
+package org.wiremock.extensions.state.examples;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -32,6 +32,8 @@
 import org.junit.jupiter.api.TestInstance;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.junit.jupiter.api.parallel.Execution;
+import org.wiremock.extensions.state.CaffeineStore;
+import org.wiremock.extensions.state.StateExtension;
 
 import java.net.URI;
 import java.util.Map;
@@ -44,6 +46,9 @@
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.parallel.ExecutionMode.SAME_THREAD;
 
+/**
+ * Sample test for creating a mock for a queue with java.
+ */
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 @Execution(SAME_THREAD)
 class StateExtensionListExampleTest {

src/test/java/org/wiremock/extensions/state/StateExtensionListExampleTest.java renamed to src/test/java/org/wiremock/extensions/state/examples/StateExtensionListExampleTest.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.wiremock.extensions.state;
+package org.wiremock.extensions.state.examples;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -32,6 +32,8 @@
 import org.junit.jupiter.api.TestInstance;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.junit.jupiter.api.parallel.Execution;
+import org.wiremock.extensions.state.CaffeineStore;
+import org.wiremock.extensions.state.StateExtension;
 
 import java.net.URI;
 import java.util.Map;
@@ -45,6 +47,9 @@
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.parallel.ExecutionMode.SAME_THREAD;
 
+/**
+ * Sample test for using this extension to record a state in java.
+ */
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 @Execution(SAME_THREAD)
 class StateExtensionStateExampleTest {

src/test/java/org/wiremock/extensions/state/StateExtensionStateExampleTest.java renamed to src/test/java/org/wiremock/extensions/state/examples/StateExtensionStateExampleTest.java

@@ -1,4 +1,4 @@
-package org.wiremock.extensions.state;
+package org.wiremock.extensions.state.examples;
 
 import com.github.tomakehurst.wiremock.WireMockServer;
 import com.github.tomakehurst.wiremock.client.WireMock;
@@ -15,9 +15,10 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInstance;
 import org.junit.jupiter.api.parallel.Execution;
+import org.wiremock.extensions.state.CaffeineStore;
+import org.wiremock.extensions.state.StateExtension;
 import org.wiremock.extensions.state.internal.ContextManager;
 
-import java.io.File;
 import java.net.URI;
 import java.time.Duration;
 import java.util.Locale;
@@ -30,20 +31,20 @@
 import static org.hamcrest.Matchers.is;
 import static org.junit.jupiter.api.parallel.ExecutionMode.SAME_THREAD;
 
+/**
+ * Sample test to demonstrate remote loading of stub mapping with this extension.
+ */
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 @Execution(SAME_THREAD)
-public class IntegrationTest {
-
-    static WireMockServer wireMockServer;
-    static WireMock wmClient;
-    static Stubbing wm;
+public class StubMappingLoadingExampleTest {
 
+    private static WireMockServer wireMockServer;
     private static final Store<String, Object> store = new CaffeineStore();
     static final ContextManager contextManager = new ContextManager(store);
 
 
     @BeforeAll
-    public static void initWithTempDir() throws Exception {
+    public static void initWithTempDir() {
         WireMockConfiguration options = wireMockConfig().withRootDirectory(Resources.getResource("remoteloader").getPath())
                 .templatingEnabled(true).globalTemplating(true)
                 .extensions(new StateExtension(store));
@@ -56,10 +57,10 @@ public static void initWithTempDir() throws Exception {
         wireMockServer = new WireMockServer(options);
         wireMockServer.start();
         WireMock.configureFor(wireMockServer.port());
-        wm = wireMockServer;
+        Stubbing wm = wireMockServer;
 
         Locale.setDefault(Locale.ENGLISH);
-        wmClient = WireMock.create().port(wireMockServer.port()).build();
+        WireMock.create().port(wireMockServer.port()).build();
     }
 
     @Test

src/test/java/org/wiremock/extensions/state/IntegrationTest.java renamed to src/test/java/org/wiremock/extensions/state/examples/StubMappingLoadingExampleTest.java

@@ -1,4 +1,4 @@
-package org.wiremock.extensions.state;
+package org.wiremock.extensions.state.functionality;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.github.tomakehurst.wiremock.common.ConsoleNotifier;
@@ -10,6 +10,8 @@
 import org.junit.jupiter.api.TestInstance;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.junit.jupiter.api.parallel.Execution;
+import org.wiremock.extensions.state.CaffeineStore;
+import org.wiremock.extensions.state.StateExtension;
 import org.wiremock.extensions.state.internal.ContextManager;
 
 import java.time.Duration;

src/test/java/org/wiremock/extensions/state/AbstractTestBase.java renamed to src/test/java/org/wiremock/extensions/state/functionality/AbstractTestBase.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.wiremock.extensions.state;
+package org.wiremock.extensions.state.functionality;
 
 import com.github.tomakehurst.wiremock.client.WireMock;
 import com.github.tomakehurst.wiremock.extension.Parameters;

src/test/java/org/wiremock/extensions/state/DeleteStateEventListenerTest.java renamed to src/test/java/org/wiremock/extensions/state/functionality/DeleteStateEventListenerTest.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.wiremock.extensions.state;
+package org.wiremock.extensions.state.functionality;
 
 import com.github.tomakehurst.wiremock.client.WireMock;
 import com.github.tomakehurst.wiremock.extension.Parameters;

src/test/java/org/wiremock/extensions/state/RecordStateEventListenerTest.java renamed to src/test/java/org/wiremock/extensions/state/functionality/RecordStateEventListenerTest.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.wiremock.extensions.state;
+package org.wiremock.extensions.state.functionality;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.github.tomakehurst.wiremock.client.WireMock;

src/test/java/org/wiremock/extensions/state/StateRequestMatcherTest.java renamed to src/test/java/org/wiremock/extensions/state/functionality/StateRequestMatcherTest.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.wiremock.extensions.state;
+package org.wiremock.extensions.state.functionality;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.github.tomakehurst.wiremock.client.WireMock;