You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shiro.apache.org by bd...@apache.org on 2021/09/20 22:26:10 UTC
[shiro-site] branch pages-block1 created (now 0745f4c)
This is an automated email from the ASF dual-hosted git repository.
bdemers pushed a change to branch pages-block1
in repository https://gitbox.apache.org/repos/asf/shiro-site.git.
at 0745f4c Port a few pages
This branch includes the following new commits:
new 0745f4c Port a few pages
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[shiro-site] 01/01: Port a few pages
Posted by bd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
bdemers pushed a commit to branch pages-block1
in repository https://gitbox.apache.org/repos/asf/shiro-site.git
commit 0745f4c91810dcc41ca784ce9958e415305b536d
Author: Brian Demers <bd...@apache.org>
AuthorDate: Mon Sep 20 18:26:02 2021 -0400
Port a few pages
java-annotations
license
overview
reference
NOTE: lend_a_hand template change to include body content (looks similar to `page` but adds the "Land a Hand" block to bottom of page
the `java-annotations` page changes more than 50, so git treats it as a delete/add instead of a move
---
java-annotations.md | 21 -----------------
.../assets/img}/ShiroBasicArchitecture.png | Bin
.../content/java-annotations-list.md | 9 +++----
jbake/content/java-annotations.md | 16 +++++++++++++
license.md => jbake/content/license.md | 7 ++++--
overview.md => jbake/content/overview.md | 26 +++++++++++----------
reference.md => jbake/content/reference.md | 16 ++++---------
jbake/templates/lend_a_hand.ftl | 4 ++--
8 files changed, 47 insertions(+), 52 deletions(-)
diff --git a/java-annotations.md b/java-annotations.md
deleted file mode 100644
index 31603aa..0000000
--- a/java-annotations.md
+++ /dev/null
@@ -1,21 +0,0 @@
-<a name="JavaAnnotations-JavaAnnotationSupport"></a>
-#Java Annotation Support
-
-Before you can use Java annotations, you'll need to enable AOP support in your application. There are a number of different AOP frameworks so, unfortunately, there is no standard way to enable AOP in an application.
-
-For AspectJ, you can review our [AspectJ sample application](https://github.com/apache/shiro/tree/main/samples/aspectj).
-
-For Spring, you can look into our [Spring Integration](spring.html "Spring") documentation.
-
-<a name="JavaAnnotations-Shiro%27sJavaAnnotations."></a>
-##Shiro's Java Annotations.
-
-Once you have AOP enabled in our application, you can use Shiro's set of annotations found in the [Java Annotations List](java-annotations-list.html "Java Annotations List")
-
-<a name="JavaAnnotations-Lendahandwithdocumentation"></a>
-##Lend a hand with documentation
-
-While we hope this documentation helps you with the work you're doing with Apache Shiro, the community is improving and expanding the documentation all the time. If you'd like to help the Shiro project, please consider correcting, expanding, or adding documentation where you see a need. Every little bit of help you provide expands the community and in turn improves Shiro.
-
-The easiest way to contribute your documentation is to send it to the [User Forum](http://shiro-user.582556.n2.nabble.com/) or the [User Mailing List](mailing-lists.html "Mailing Lists").
-<input type="hidden" id="ghEditPage" value="java-annotations.md"></input>
diff --git a/assets/images/ShiroBasicArchitecture.png b/jbake/assets/img/ShiroBasicArchitecture.png
similarity index 100%
rename from assets/images/ShiroBasicArchitecture.png
rename to jbake/assets/img/ShiroBasicArchitecture.png
diff --git a/java-annotations-list.md b/jbake/content/java-annotations-list.md
similarity index 90%
rename from java-annotations-list.md
rename to jbake/content/java-annotations-list.md
index c2e7ef4..a7ef340 100644
--- a/java-annotations-list.md
+++ b/jbake/content/java-annotations-list.md
@@ -1,5 +1,8 @@
-<a name="JavaAnnotationsList-JavaAnnotationsList"></a>
-#Java Annotations List
+title=Java Annotations List
+type=page
+tags=documentation, manual
+status=published
+~~~~~~
Below are a list of the different Shiro annotations you can use in your application.
@@ -12,5 +15,3 @@ Below are a list of the different Shiro annotations you can use in your applicat
* **[RequiresRoles](static/current/apidocs/org/apache/shiro/authz/annotation/RequiresRoles.html)** - Requires the currently executing Subject to have all of the specified roles. If they do not have the role(s), the method will not be executed and an AuthorizationException is thrown.
* **[RequiresUser](static/current/apidocs/org/apache/shiro/authz/annotation/RequiresUser.html)** - Requires the current Subject to be an application user for the annotated class/instance/method to be accessed or invoked.
-
-<input type="hidden" id="ghEditPage" value="java-annotations-list.md"></input>
diff --git a/jbake/content/java-annotations.md b/jbake/content/java-annotations.md
new file mode 100644
index 0000000..7eb5470
--- /dev/null
+++ b/jbake/content/java-annotations.md
@@ -0,0 +1,16 @@
+title=Java Annotation Support
+type=lend_a_hand
+tags=documentation, manual, todo, lend-a-hand
+status=published
+~~~~~~
+
+Before you can use Java annotations, you'll need to enable AOP support in your application. There are a number of different AOP frameworks so, unfortunately, there is no standard way to enable AOP in an application.
+
+For AspectJ, you can review our [AspectJ sample application](https://github.com/apache/shiro/tree/main/samples/aspectj).
+
+For Spring, you can look into our [Spring Integration](spring.html "Spring") documentation.
+
+<a name="JavaAnnotations-Shiro%27sJavaAnnotations."></a>
+## Shiro's Java Annotations.
+
+Once you have AOP enabled in our application, you can use Shiro's set of annotations found in the [Java Annotations List](java-annotations-list.html "Java Annotations List")
diff --git a/license.md b/jbake/content/license.md
similarity index 99%
rename from license.md
rename to jbake/content/license.md
index 210d84d..839ea7e 100644
--- a/license.md
+++ b/jbake/content/license.md
@@ -1,5 +1,8 @@
-<a name="License-TheApacheSoftwareLicense%2CVersion2.0"></a>
-#The Apache Software License, Version 2.0
+title=Apache License, Version 2.0
+type=page
+tags=documentation, manual
+status=published
+~~~~~~
``` nohighlight
Apache License
diff --git a/overview.md b/jbake/content/overview.md
similarity index 95%
rename from overview.md
rename to jbake/content/overview.md
index 0870878..06bf68a 100644
--- a/overview.md
+++ b/jbake/content/overview.md
@@ -1,8 +1,11 @@
-<a name="Overview-OverviewofApacheShiro"></a>
-#Overview of Apache Shiro
+title=Overview of Apache Shiro
+type=page
+tags=documentation, manual
+status=published
+~~~~~~
<a name="Overview-Introduction"></a>
-##Introduction
+## Introduction
Apache Shiro is a powerful and flexible open-source security framework that cleanly handles authentication, authorization, enterprise session management and cryptography.
@@ -25,11 +28,11 @@ and much more - all integrated into a cohesive easy-to-use API.
Shiro attempts to achieve these goals for all application environments - from the simplest command line application to the largest enterprise applications, without forcing dependencies on other 3rd party frameworks, containers, or application servers. Of course the project aims to integrate into these environments wherever possible, but it could be used out-of-the-box in any environment.
<a name="Overview-Features"></a>
-##Features
+## Features
Apache Shiro is a comprehensive application security framework with many features. The following diagram shows where Shiro focuses its energy, and this reference manual will be organized similarly:
-<img src="assets/images/ShiroFeatures.png" style="margin:0px auto;display:block"></img>
+<img src="/img/ShiroFeatures.png" style="margin:0px auto;display:block"></img>
Shiro targets what the Shiro development team calls "the four cornerstones of application security" - Authentication, Authorization, Session Management, and Cryptography:
@@ -51,7 +54,7 @@ There are also additional features to support and reinforce these concerns in di
* "Remember Me": Remember users' identities across sessions so they only need to log in when mandatory.
<a name="Overview-AFirstLookatApacheShiro"></a>
-##A First Look at Apache Shiro
+## A First Look at Apache Shiro
Apache Shiro's design goals are to simplify application security by being intuitive and easy to use. Shiro's core design models how most people think about application security - in the context of someone (or something) interacting with an application.
@@ -62,14 +65,14 @@ This example statement indicates that applications are largely written to satisf
Shiro largely reflects these concepts in its own design. By matching what is already intuitive for software developers, Apache Shiro remains intuitive and easy to use in practically any application.
<a name="Overview-BasicDesign"></a>
-###Basic Design
+### Bsic Design
Shiro's architecture has 3 primary concepts: the `Subject`, `SecurityManager` and `Realm` s. The following diagram is a high-level overview of how these concepts interact, and we'll cover each concept below:
-<img src="assets/images/ShiroBasicArchitecture.png" style="margin:0px auto;display:block"></img>
+<img src="/img/ShiroBasicArchitecture.png" style="margin:0px auto;display:block"></img>
<a name="Overview-Subject"></a>
-####Subject
+#### Subject
The `Subject` is essentially a security specific 'view' of the the currently executing user. Notice that it is not actually named _User_ however. The name _Subject_ was chosen for two reasons:
@@ -88,7 +91,7 @@ Subject currentUser = SecurityUtils.getSubject();
Once you have a `Subject` instance, you immediately have access to 90% of everything you would ever need to do to perform security for that Subject, such as login and logout, perform role and permission checks, access their session, and more - but more about this later. The most important thing to know is that the `Subject` is your 'security-specific view' of an application 'user' and that you can essentially access this anywhere in application code to perform whatever security operation [...]
<a name="Overview-TheSecurityManager"></a>
-####The SecurityManager
+#### The SecurityManager
While application developers almost exclusively interact with `Subject` instances in their code, Subjects have a 'behind the scenes' counterpart that makes them work - the Shiro `SecurityManager` (note this is _not_ the same thing as the `java.lang.SecurityManager`).
@@ -99,7 +102,7 @@ The `SecurityManager` is the heart of Shiro’s architecture and acts as a sort
We will talk about the `SecurityManager` in detail later on, but it is important to realize that when you interact with a `Subject`, it is really the `SecurityManager` behind the scenes that does all the heavy lifting for any `Subject` security operation. This is reflected in the basic flow diagram above.
<a name="Overview-Realms"></a>
-####Realms
+#### Realms
The third and final core concept in Shiro is that of a Realm. A Realm acts as the ‘bridge’ or ‘connector’ between Shiro and your application’s security data. That is, when it comes time to actually interact with security-related data like user accounts to perform authentication (login) and authorization (access control), Shiro looks up many of these things from one or more Realms configured for an application.
@@ -108,4 +111,3 @@ In this sense a Realm is essentially a security-specific [DAO](https://en.wikipe
Shiro provides out-of-the-box Realms to connect to a number of security data sources (aka directories) such as LDAP, relational databases (JDBC), text configuration sources like INI and properties files, and more. You can plug-in your own Realm implementations to represent custom data sources if the default Realms do not meet your needs.
Like other internal components, the Shiro `SecurityManager` manages how Realms are used to acquire security data and then represented as `Subject` instances.
-<input type="hidden" id="ghEditPage" value="overview.md"></input>
diff --git a/reference.md b/jbake/content/reference.md
similarity index 61%
rename from reference.md
rename to jbake/content/reference.md
index 411eeab..c1888a9 100644
--- a/reference.md
+++ b/jbake/content/reference.md
@@ -1,5 +1,8 @@
-<a name="Reference-ApacheShiroReferenceDocumentation"></a>
-#Apache Shiro Reference Documentation
+title=Apache Shiro Reference Documentation
+type=lend_a_hand
+tags=documentation, manual, todo, lend-a-hand
+status=published
+~~~~~~
1. Overview
@@ -47,12 +50,3 @@
1. Index
* [Terminology](terminology.html)
-
-##Lend a hand with documentation
-
-While we hope this documentation helps you with the work you're doing with Apache Shiro, the community is improving and expanding the documentation all the time. If you'd like to help the Shiro project, please consider correcting, expanding, or adding documentation where you see a need. Every little bit of help you provide expands the community and in turn improves Shiro.
-
-The easiest way to contribute your documentation is to send it to the [User Forum](http://shiro-user.582556.n2.nabble.com/) or the [User Mailing List](mailing-lists.html).
-
-
-<input type="hidden" id="ghEditPage" value="reference.md"></input>
diff --git a/jbake/templates/lend_a_hand.ftl b/jbake/templates/lend_a_hand.ftl
index d7ae77f..4e069bc 100644
--- a/jbake/templates/lend_a_hand.ftl
+++ b/jbake/templates/lend_a_hand.ftl
@@ -6,9 +6,9 @@
</div>
<#else></#if>
-<p><em>${content.date?string("dd MMMM yyyy")}</em></p>
+<@content.body?interpret />
-<p>TODO</p>
+<hr />
<h2><a id="Lendahandwithdocumentation"></a>Lend a hand with documentation</h2>