Skip to content

Commit

Permalink
Update overview.html
Browse files Browse the repository at this point in the history
  • Loading branch information
DineshSolanki authored Oct 19, 2023
1 parent c01c27d commit 586704f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion gh-pages/overview.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-10-19T20:45:21.4384896"><meta name="build-number" content="${buildNumber}"> <title>Overview | Help Instance</title><script id="virtual-toc-data" type="application/json">[{"id":"what-is-samay","level":0,"title":"What is Samay?","anchor":"#what-is-samay"},{"id":"glossary","level":0,"title":"Glossary","anchor":"#glossary"}]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.1.5-b176/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Overview | Help Instance"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Help Instance Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="overview.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Overview | Help Instance"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "overview.html#webpage", "url": "overview.html", "name": "Overview | Help Instance", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/#website", "url": "/", "name": "Help Instance Help" }</script><!-- End Schema.org --> <!-- Mermaid light/dark themes --> <link rel="stylesheet" type="text/css" href="mermaid.css"> </head> <body data-id="Overview" data-main-title="Overview" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Help Instance Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Overview" id="Overview.md" >Overview</h1> <p id="8e87aee0_2">Samay is a Java library that provides automatic timezone handling for Spring Boot applications. It allows easy extraction and usage of timezone information from HTTP requests.</p><section class="chapter"><h2 id="what-is-samay" data-toc="what-is-samay">What is Samay?</h2><p id="8e87aee0_3">Samay is designed to simplify timezone handling in Spring Boot web applications. It intercepts incoming HTTP requests, extracts the timezone from a custom header, stores it in a ThreadLocal variable, and makes it available throughout the request lifecycle.</p><p id="8e87aee0_4">This saves developers from having to manually extract and pass around timezone information in their application code. Samay handles this automatically via request interception and context propagation.</p><p id="8e87aee0_5">Some alternatives to Samay include:</p><ul class="list _ul" id="8e87aee0_6" ><li class="list__item" id="8e87aee0_7"><p>Manually extracting timezone on every request</p></li><li class="list__item" id="8e87aee0_8"><p>Passing timezone as a method parameter</p></li><li class="list__item" id="8e87aee0_9"><p>Using session/cookie to store timezone</p></li></ul><p id="8e87aee0_10">Samay provides a cleaner and more automated way to handle time zones.</p></section><section class="chapter"><h2 id="glossary" data-toc="glossary">Glossary</h2><p id="8e87aee0_11"><span class="control" id="8e87aee0_12">Request Interception</span> - Process of intercepting an HTTP request before it reaches the target controller. Useful for cross-cutting concerns like logging, security, etc.</p><p id="8e87aee0_13"><span class="control" id="8e87aee0_14">ThreadLocal</span> &mdash; A variable that provides thread-level isolation. Stores different values per thread. Used to propagate context across layers.</p><p id="8e87aee0_15"><span class="control" id="8e87aee0_16">Context Propagation</span> - Passing request-specific data like user ID, timezone, etc across application layers to avoid plumbing everywhere.</p><p id="8e87aee0_17">Let me know if you would like me to expand or modify this overview section further.</p></section><div class="last-modified"> Last modified: 19 October 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__next" href="using-samay.html">Using Samay</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.1.5-b176/app.js"></script></body></html>
<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-10-19T20:45:21.4384896"><meta name="build-number" content="${buildNumber}"> <title>Overview | Help Instance</title><script id="virtual-toc-data" type="application/json">[{"id":"what-is-samay","level":0,"title":"What is Samay?","anchor":"#what-is-samay"},{"id":"glossary","level":0,"title":"Glossary","anchor":"#glossary"}]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.1.5-b176/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Overview | Help Instance"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Help Instance Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="overview.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Overview | Help Instance"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "overview.html#webpage", "url": "overview.html", "name": "Overview | Help Instance", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/#website", "url": "/", "name": "Help Instance Help" }</script><!-- End Schema.org --> <!-- Mermaid light/dark themes --> <link rel="stylesheet" type="text/css" href="mermaid.css"> </head> <body data-id="Overview" data-main-title="Overview" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Help Instance Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Overview" id="Overview.md" >Overview</h1> <p id="8e87aee0_2">Samay is a Java library that provides automatic timezone handling for Spring Boot applications. It allows easy extraction and usage of timezone information from HTTP requests.</p><section class="chapter"><h2 id="what-is-samay" data-toc="what-is-samay">What is Samay?</h2><p id="8e87aee0_3">Samay is designed to simplify timezone handling in Spring Boot web applications. It intercepts incoming HTTP requests, extracts the timezone from a custom header, stores it in a ThreadLocal variable, and makes it available throughout the request lifecycle.</p><p id="8e87aee0_4">This saves developers from having to manually extract and pass around timezone information in their application code. Samay handles this automatically via request interception and context propagation.</p><p id="8e87aee0_5">Some alternatives to Samay include:</p><ul class="list _ul" id="8e87aee0_6" ><li class="list__item" id="8e87aee0_7"><p>Manually extracting timezone on every request</p></li><li class="list__item" id="8e87aee0_8"><p>Passing timezone as a method parameter</p></li><li class="list__item" id="8e87aee0_9"><p>Using session/cookie to store timezone</p></li></ul><p id="8e87aee0_10">Samay provides a cleaner and more automated way to handle time zones.</p></section><section class="chapter"><h2 id="glossary" data-toc="glossary">Glossary</h2><p id="8e87aee0_11"><span class="control" id="8e87aee0_12">Request Interception</span> - Process of intercepting an HTTP request before it reaches the target controller. Useful for cross-cutting concerns like logging, security, etc.</p><p id="8e87aee0_13"><span class="control" id="8e87aee0_14">ThreadLocal</span> &mdash; A variable that provides thread-level isolation. Stores different values per thread. Used to propagate context across layers.</p><p id="8e87aee0_15"><span class="control" id="8e87aee0_16">Context Propagation</span> - Passing request-specific data like user ID, timezone, etc across application layers to avoid plumbing everywhere.</p></section><div class="last-modified"> Last modified: 19 October 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__next" href="using-samay.html">Using Samay</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.1.5-b176/app.js"></script></body></html>

0 comments on commit 586704f

Please sign in to comment.