This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 35b84bc2bf60a6f9182ac700bf4b5f7eb7063b2d
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Wed Feb 21 17:53:51 2024 +0100
CAMEL-20410: documentation fixes for camel-shiro
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
components/camel-shiro/src/main/docs/shiro.adoc | 26 ++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/components/camel-shiro/src/main/docs/shiro.adoc
b/components/camel-shiro/src/main/docs/shiro.adoc
index ca3c7eab0a2..e88cb5d0d66 100644
--- a/components/camel-shiro/src/main/docs/shiro.adoc
+++ b/components/camel-shiro/src/main/docs/shiro.adoc
@@ -11,14 +11,14 @@
*Since Camel {since}*
-The Shiro Security component in Camel is a security focused component,
+The Shiro Security component in Camel is a security-focused component,
based on the Apache Shiro security project.
Apache Shiro is a powerful and flexible open-source security framework
that cleanly handles authentication, authorization, enterprise session
management and cryptography. The objective of the Apache Shiro project
is to provide the most robust and comprehensive application security
-framework available while also being very easy to understand and
+framework available while also being straightforward to understand and
extremely simple to use.
This camel shiro-security component allows authentication and
@@ -26,9 +26,9 @@ authorization support to be applied to different segments of
a camel
route.
Shiro security is applied on a route using a Camel Policy. A Policy in
-Camel utilizes a strategy pattern for applying interceptors on Camel
-Processors. It offering the ability to apply cross-cutting concerns (for
-example. security, transactions etc) on sections/segments of a camel
+Camel uses a strategy pattern for applying interceptors on Camel
+Processors. It is offering the ability to apply cross-cutting concerns (for
+example, security, transactions, etc.), on sections/segments of a Camel
route.
Maven users will need to add the following dependency to their `pom.xml`
@@ -52,7 +52,7 @@ must be instantiated with security configuration details
(including
users, passwords, roles etc). This object must then be applied to a
camel route. This ShiroSecurityPolicy Object may also be registered in
the Camel registry (JNDI or ApplicationContextRegistry) and then
-utilized on other routes in the Camel Context.
+used on other routes in the Camel Context.
Configuration details are provided to the ShiroSecurityPolicy using an
Ini file (properties file) or an Ini object. The Ini file is a standard
@@ -112,30 +112,30 @@ A ShiroSecurityPolicy object is instantiated as follows
|`iniResourcePath or ini` |`none` |Resource String or Ini Object |A mandatory
Resource String for the iniResourcePath or an instance of an
Ini object must be passed to the security policy. Resources can be
acquired from the file system, classpath, or URLs when prefixed with
-"file:, classpath:, or url:" respectively. For e.g "classpath:shiro.ini"
+"file:, classpath:, or url:" respectively. For e.g., `classpath:shiro.ini`
|`passPhrase` |`An AES 128 based key` |byte[] |A passPhrase to decrypt
ShiroSecurityToken(s) sent along with Message
Exchanges
-|`alwaysReauthenticate` |`true` |boolean |Setting to ensure re-authentication
on every individual request. If set
+|`alwaysReauthenticate` |`true` |boolean |Setting to ensure re-authentication
on every request. If set
to false, the user is authenticated and locked such than only requests
from the same user going forward are authenticated.
|`permissionsList` |`none` |List<Permission> |A List of permissions required
in order for an authenticated user to be
-authorized to perform further action i.e continue further on the route.
+authorized to perform further action i.e., continue further on the route.
If no Permissions list or Roles List (see below) is provided to the
ShiroSecurityPolicy object, then authorization is deemed as not
required. Note that the default is that authorization is granted if any
of the Permission Objects in the list are applicable.
|`rolesList` |`none` |List<String> |A List of roles required in order for an
authenticated
-user to be authorized to perform further action i.e continue further on
+user to be authorized to perform further action i.e., continue further on
the route. If no roles list or permissions list (see above) is provided
to the ShiroSecurityPolicy object, then authorization is deemed as not
required. Note that the default is that authorization is granted if any
of the roles in the list are applicable.
-|`cipherService` |`AES` |org.apache.shiro.crypto.CipherService |Shiro ships
with AES & Blowfish based CipherServices. You may use one
+|`cipherService` |`AES` |org.apache.shiro.crypto.CipherService |Shiro ships
with AES & Blowfish-based CipherServices. You may use one of
these or pass in your own Cipher implementation
|`base64` |`false` |`boolean` |To use base64 encoding for the security token
header,
@@ -144,11 +144,11 @@ option must also be set on `ShiroSecurityTokenInjector`
as well.
|`allPermissionsRequired` |`false` |`boolean` |The default is that
authorization is granted if any of the
Permission Objects in the permissionsList parameter are applicable. Set
-this to true to require all of the Permissions to be met.
+this to true to require all the Permissions to be met.
|`allRolesRequired` |`false` |`boolean` |The default is that authorization is
granted if any of the
roles in the rolesList parameter are applicable. Set this to true to
-require all of the roles to be met.
+require all the roles to be met.
|=======================================================================
[[ShiroSecurity-ApplyingShiroAuthenticationonaCamelRoute]]
