Modified: shiro/site/publish/developers.html URL: http://svn.apache.org/viewvc/shiro/site/publish/developers.html?rev=1766414&r1=1766413&r2=1766414&view=diff ============================================================================== --- shiro/site/publish/developers.html (original) +++ shiro/site/publish/developers.html Mon Oct 24 14:33:52 2016 @@ -78,53 +78,47 @@ <div id="content"> - <h1><a name="Developers-ApacheShiroDeveloperReferenceInformation"></a>Apache Shiro Developer Reference Information</h1> - + <a name="Developers-ApacheShiroDeveloperReferenceInformation"></a> +<h1><a href="#apache-shiro-developer-reference-information" name="apache-shiro-developer-reference-information">Apache Shiro Developer Reference Information</a></h1> <p>This page and its children are dedicated for reference information used by the Apache Shiro development team when performing tasks as a committer.</p> - -<h2><a name="Developers-WritingDocumentation"></a>Writing Documentation</h2> - -<p>All non-JavaDoc documentation is written in our <a class="external-link" href="https://cwiki.apache.org/confluence/display/SHIRO";>Apache Shiro Confluence Wiki Space</a>. This space is converted into the public website as described below.</p> - -<h2><a name="Developers-Version2Brainstorming"></a>Version 2 Brainstorming</h2> - -<p>Version 2 has no timeline yet, but if you're interested in seeing what the major ideas are, as well as to contribute any of your own, you can visit the <a class="external-link" href="https://cwiki.apache.org/confluence/display/SHIRO/Version+2+Brainstorming";>Version 2 Brainstorming Page</a>.</p> - -<h2><a name="Developers-Website"></a>Website</h2> - -<p>The Shiro website is automatically generated based on the content maintained in the <a class="external-link" href="https://cwiki.apache.org/confluence/display/SHIRO";>Apache Shiro Confluence Wiki Space</a>, with a few notable exceptions that we'll cover in a bit. Here's how it works:</p> - -<ol><li>Shiro committers and approved contributors modify the Confluence wiki pages as necessary. The left navigation panel is controlled by the <a class="external-link" href="https://cwiki.apache.org/confluence/display/SHIRO/Navigation";>Navigation wiki page</a>. -<br clear="none" class="atl-forced-newline"> -<br clear="none" class="atl-forced-newline"></li><li>Confluence detects changes to these pages and executes a 3rd-party <a class="external-link" href="http://code.google.com/p/couldit-autoexport"; rel="nofollow">Auto Export Confluence Plugin</a> that renders the content to .html files that can be served to the world (this plugin was installed in Confluence by the Apache Infrastructure team). If you're setting up <tt>Auto Export</tt> for the first time, read the "Setting up Confluence Export" section below. -<br clear="none" class="atl-forced-newline"> -<br clear="none" class="atl-forced-newline"> - <ol><li>A project contributor makes a single Velocity-based HTML template file. It can reference associated static assets (images, css files, javascript, etc) as necessary. They test it in their HTML design tool of choice to get the look and feel they want. -<br clear="none" class="atl-forced-newline"> -<br clear="none" class="atl-forced-newline"></li><li>The template designer sends the one HTML template file only (and not the referenced static assets) to an Apache member with Confluence administrative privileges and asks them to install their HTML template file into the <tt>Auto Export</tt> plugin configuration. Unfortunately only a Confluence administrators may perform this function - the plugin does not support administration on a per-project level. -<br clear="none" class="atl-forced-newline"> -<br clear="none" class="atl-forced-newline"> -You will have to separately upload the any referenced static assets to another location. We'll cover that shortly. -<br clear="none" class="atl-forced-newline"> -<br clear="none" class="atl-forced-newline"></li><li>The Confluence administrator installs the HTML template for the project's space only.</li><li>For each wiki page, the auto export plugin merges the page content with an HTML template and outputs a new <tt>.html</tt> file (html template + wiki content body = finished page).</li><li>All of the output files and any associated data (attachments, etc) are placed in a filesystem directory that mirrors content tree hierarchy in the wiki.<br clear="none"> -the The output files mirror the fileThe auto export plugin takes all of the pages and their content (attachments, etc), applies a single HTML template to each wiki page, and outputs each 'merged' page (html template + embedded wiki content = finished page)</li></ol> - </li></ol> - - -<p>The website files are maintained on <tt>people.apache.org</tt> in <tt>/www/shiro.apache.org</tt>:</p> - -<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> -<pre>> ssh people.apache.org +<a name="Developers-WritingDocumentation"></a> +<h2><a href="#writing-documentation" name="writing-documentation">Writing Documentation</a></h2> +<p>All non-JavaDoc documentation is written in our <a href="https://cwiki.apache.org/confluence/display/SHIRO";>Apache Shiro Confluence Wiki Space</a>. This space is converted into the public website as described below.</p> +<a name="Developers-Version2Brainstorming"></a> +<h2><a href="#version-2-brainstorming" name="version-2-brainstorming">Version 2 Brainstorming</a></h2> +<p>Version 2 has no timeline yet, but if you’re interested in seeing what the major ideas are, as well as to contribute any of your own, you can visit the <a href="https://cwiki.apache.org/confluence/display/SHIRO/Version+2+Brainstorming";>Version 2 Brainstorming Page</a>.</p> +<a name="Developers-Website"></a> +<h2><a href="#website" name="website">Website</a></h2> +<p>The Shiro website is automatically generated based on the content maintained in the <a href="https://cwiki.apache.org/confluence/display/SHIRO";>Apache Shiro Confluence Wiki Space</a>, with a few notable exceptions that we’ll cover in a bit. Here’s how it works:</p> +<ol> + <li> + <p>Shiro committers and approved contributors modify the Confluence wiki pages as necessary. The left navigation panel is controlled by the <a href="https://cwiki.apache.org/confluence/display/SHIRO/Navigation";>Navigation wiki page</a>.</p></li> + <li> + <p>Confluence detects changes to these pages and executes a 3rd-party <a href="http://code.google.com/p/couldit-autoexport";>Auto Export Confluence Plugin</a> that renders the content to .html files that can be served to the world (this plugin was installed in Confluence by the Apache Infrastructure team). If you’re setting up <code>Auto Export</code> for the first time, read the “Setting up Confluence Export” section below.</p> + <ol> + <li> + <p>A project contributor makes a single Velocity-based HTML template file. It can reference associated static assets (images, css files, javascript, etc) as necessary. They test it in their HTML design tool of choice to get the look and feel they want.</p></li> + <li> + <p>The template designer sends the one HTML template file only (and not the referenced static assets) to an Apache member with Confluence administrative privileges and asks them to install their HTML template file into the <code>Auto Export</code> plugin configuration. Unfortunately only a Confluence administrators may perform this function - the plugin does not support administration on a per-project level.</p></li> + </ol> + <p>You will have to separately upload the any referenced static assets to another location. We’ll cover that shortly.</p> + <ol> + <li>The Confluence administrator installs the HTML template for the project’s space only.</li> + <li>For each wiki page, the auto export plugin merges the page content with an HTML template and outputs a new <code>.html</code> file (html template + wiki content body = finished page).</li> + <li>All of the output files and any associated data (attachments, etc) are placed in a filesystem directory that mirrors content tree hierarchy in the wiki.<br/>the The output files mirror the fileThe auto export plugin takes all of the pages and their content (attachments, etc), applies a single HTML template to each wiki page, and outputs each ‘merged’ page (html template + embedded wiki content = finished page)</li> + </ol> + </li> +</ol> +<p>The website files are maintained on <code>people.apache.org</code> in <code>/www/shiro.apache.org</code>:</p> +<pre><code class="bash">> ssh people.apache.org (a bunch of login messages) [lhazlewood@minotaur:~]$ [lhazlewood@minotaur:~]$ cd /www/shiro.apache.org [lhazlewood@minotaur:/www/shiro.apache.org]$ -</pre> -</div></div> - -<p>Changes made to any files under this directory are synced and published to a set of mirrored Apache web servers that we can't access. So note: <b>Any changes to files under this directory will be propagated to the public Shiro site</b>. Be careful!</p> +</code></pre> +<p>Changes made to any files under this directory are synced and published to a set of mirrored Apache web servers that we can’t access. So note: <strong>Any changes to files under this directory will be propagated to the public Shiro site</strong>. Be careful!</p> </div>
Modified: shiro/site/publish/documentation-help-block.html URL: http://svn.apache.org/viewvc/shiro/site/publish/documentation-help-block.html?rev=1766414&r1=1766413&r2=1766414&view=diff ============================================================================== --- shiro/site/publish/documentation-help-block.html (original) +++ shiro/site/publish/documentation-help-block.html Mon Oct 24 14:33:52 2016 @@ -78,11 +78,10 @@ <div id="content"> - <h2><a name="DocumentationHelpBlock-Lendahandwithdocumentation"></a>Lend a hand with documentation </h2> - -<p>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 corrected, expanding, or adding documentation where you see a need. Every little bit of help you provide expands the community and in turn improves Shiro. </p> - -<p>The easiest way to contribute your documentation is to send it to the <a class="external-link" href="http://shiro-user.582556.n2.nabble.com/"; rel="nofollow">User Forum</a> or the <a href="mailing-lists.html" title="Mailing Lists">User Mailing List</a>.</p> + <a name="DocumentationHelpBlock-Lendahandwithdocumentation"></a> +<h2><a href="#lend-a-hand-with-documentation" name="lend-a-hand-with-documentation">Lend a hand with documentation</a></h2> +<p>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 corrected, expanding, or adding documentation where you see a need. Every little bit of help you provide expands the community and in turn improves Shiro.</p> +<p>The easiest way to contribute your documentation is to send it to the <a href="http://shiro-user.582556.n2.nabble.com/";>User Forum</a> or the <a href="mailing-lists.html" title="Mailing Lists">User Mailing List</a>.</p> </div> Modified: shiro/site/publish/documentation.html URL: http://svn.apache.org/viewvc/shiro/site/publish/documentation.html?rev=1766414&r1=1766413&r2=1766414&view=diff ============================================================================== --- shiro/site/publish/documentation.html (original) +++ shiro/site/publish/documentation.html Mon Oct 24 14:33:52 2016 @@ -78,65 +78,44 @@ <div id="content"> - - -<h1><a name="Documentation-ApacheShiroDocumentation"></a>Apache Shiro Documentation</h1> - -<h3><a name="Documentation-Introduction"></a>Introduction</h3> + <a name="Documentation-ApacheShiroDocumentation"></a> +<h1><a href="#apache-shiro-documentation" name="apache-shiro-documentation">Apache Shiro Documentation</a></h1> +<a name="Documentation-Introduction"></a> +<h3><a href="#introduction" name="introduction">Introduction</a></h3> <p>Helpful if read in order:</p> <ul> - <li><a class="external-link" href="https://www.infoq.com/articles/apache-shiro"; rel="nofollow">Application Security - with Apache Shiro</a> - full intro article on InfoQ.com - </li> - <li><a href="10-minute-tutorial.html" title="10 Minute Tutorial">10 Minute Tutorial</a></li> - <li><a href="webapp-tutorial.html" title="Beginner's Webapp Tutorial">Beginner's Webapp Tutorial: a step-by-step tutorial to enable Shiro in a web application</a></li> + <li><a href="https://www.infoq.com/articles/apache-shiro";>Application Security with Apache Shiro</a> - full intro article on InfoQ.com</li> + <li><a href="10-minute-tutorial.html" title="10 Minute Tutorial">10 Minute Tutorial</a></li> + <li><a href="webapp-tutorial.html" title="Beginner's Webapp Tutorial">Beginner’s Webapp Tutorial: a step-by-step tutorial to enable Shiro in a web application</a></li> </ul> - -<h2><a name="Documentation-ApacheShiroReferenceandAPI"></a>Apache Shiro Reference and API</h2> - -<h3><a name="Documentation-ReferenceManual"></a>Reference Manual</h3> +<a name="Documentation-ApacheShiroReferenceandAPI"></a> +<h2><a href="#apache-shiro-reference-and-api" name="apache-shiro-reference-and-api">Apache Shiro Reference and API</a></h2> +<a name="Documentation-ReferenceManual"></a> +<h3><a href="#reference-manual" name="reference-manual">Reference Manual</a></h3> <ul> - <li><a href="reference.html" title="Reference">Reference Manual</a></li> + <li><a href="reference.html" title="Reference">Reference Manual</a></li> </ul> - - -<h3><a name="Documentation-GuidesimportantShiroconcepts%3A"></a>Guides - important Shiro concepts:</h3> +<a name="Documentation-GuidesimportantShiroconcepts%3A"></a> +<h3>Guides - important Shiro concepts:</h3> <ul> - <li><a href="10-minute-tutorial.html" title="10 Minute Tutorial">10 Minute Tutorial</a></li> - <li><a href="webapp-tutorial.html">Beginner's Webapp Tutorial: a step-by-step tutorial to enable Shiro in a web application</a></li> - <li><a href="java-authentication-guide.html" title="Java Authentication Guide">Authentication Guide</a></li> - <li><a href="java-authorization-guide.html" title="Java Authorization Guide">Authorization Guide</a></li> - <li>Community-contributed <a href="articles.html" title="Articles">Articles</a></li> + <li><a href="10-minute-tutorial.html" title="10 Minute Tutorial">10 Minute Tutorial</a></li> + <li><a href="webapp-tutorial.html">Beginner’s Webapp Tutorial: a step-by-step tutorial to enable Shiro in a web application</a></li> + <li><a href="java-authentication-guide.html" title="Java Authentication Guide">Authentication Guide</a></li> + <li><a href="java-authorization-guide.html" title="Java Authorization Guide">Authorization Guide</a></li> + <li>Community-contributed <a href="articles.html" title="Articles">Articles</a></li> </ul> - -<h3><a name="Documentation-CurrentRelease"></a>Current Release</h3> +<a name="Documentation-CurrentRelease"></a> +<h3><a href="#current-release" name="current-release">Current Release</a></h3> <p>Apache Shiro 1.3.2 (<a href="download.html" title="Download">Download</a>)</p> <ul> - <li><a class="external-link" href="static/1.3.2/apidocs">API</a> (JavaDoc)</li> - <li><a class="external-link" href="static/1.3.2/xref/">Browse Source</a> (XREF)</li> - <li><a class="external-link" href="static/1.3.2/">Maven Static Site</a></li> -<!-- <li><a class="external-link" - href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310950&version=12323469&styleName=Html&projectId=12310950";>Release - Notes</a></li> --> + <li><a href="static/1.3.2/apidocs">API</a> (JavaDoc)</li> + <li><a href="static/1.3.2/xref/">Browse Source</a> (XREF)</li> + <li><a href="static/1.3.2/">Maven Static Site</a></li> </ul> - -<!-- -<h3><a name="Documentation-PreviousReleases"></a>Previous Releases</h3> -<p>Apache Shiro 1.0.0-incubating (<a class="external-link" href="http://svn.apache.org/repos/asf/shiro/tags/shiro-root-1.0.0-incubating";>Build from source</a>)</p> -<ul><li><a class="external-link" href="static/1.0.0-incubating/apidocs">API</a> (JavaDoc)</li><li><a class="external-link" href="static/1.0.0-incubating/xref/">Browse Source</a> (XREF)</li><li><a class="external-link" href="static/1.0.0-incubating/">Maven Static Site</a></li><li><a class="external-link" href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310950&styleName=Html&version=12314078";>Release Notes</a></li></ul> --> - - -<h2><a name="Documentation-Lendahandwithdocumentation"></a>Lend a hand with documentation </h2> - -<p>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 corrected, - expanding, or adding documentation where you see a need. Every little bit of help you provide expands the community - and in turn improves Shiro. </p> - -<p>The easiest way to contribute your documentation is to send it to the <a class="external-link" - href="http://shiro-user.582556.n2.nabble.com/"; - rel="nofollow">User Forum</a> or the <a - href="mailing-lists.html" title="Mailing Lists">User Mailing List</a>.</p> +<a name="Documentation-Lendahandwithdocumentation"></a> +<h2><a href="#lend-a-hand-with-documentation" name="lend-a-hand-with-documentation">Lend a hand with documentation</a></h2> +<p>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 corrected, expanding, or adding documentation where you see a need. Every little bit of help you provide expands the community and in turn improves Shiro.</p> +<p>The easiest way to contribute your documentation is to send it to the <a href="http://shiro-user.582556.n2.nabble.com/";>User Forum</a> or the <a href="mailing-lists.html" title="Mailing Lists">User Mailing List</a>.</p> </div> Modified: shiro/site/publish/events.html URL: http://svn.apache.org/viewvc/shiro/site/publish/events.html?rev=1766414&r1=1766413&r2=1766414&view=diff ============================================================================== --- shiro/site/publish/events.html (original) +++ shiro/site/publish/events.html Mon Oct 24 14:33:52 2016 @@ -78,23 +78,21 @@ <div id="content"> - <h1><a name="Events-ApacheShiroEvents"></a>Apache Shiro Events</h1> - -<p>Below is list of upcoming and past Shiro events. </p> - -<h2><a name="Events-UpcomingEvents"></a>Upcoming Events</h2> - -<h3><a name="Events-DevNexus%3AApplicationSecuritywithApacheShiro"></a>DevNexus: Application Security with Apache Shiro</h3> -<p>March 22, 2011, Atlanta, GA -<br clear="none" class="atl-forced-newline"><a class="external-link" href="https://www.devnexus.com/s/presentations#1138"; rel="nofollow">https://www.devnexus.com/s/presentations#1138</a></p> - -<h2><a name="Events-PastEvents"></a>Past Events</h2> - -<h3><a name="Events-SanFranciscoJavaUserGroup%3ASuperSimpleApplicationSecuritywithApacheShiro"></a>San Francisco Java User Group: Super Simple Application Security with Apache Shiro</h3> -<p>October 12, 2010, San Francisco, CA -<br clear="none" class="atl-forced-newline"><a class="external-link" href="http://www.meetup.com/sfjava/"; rel="nofollow">http://www.meetup.com/sfjava/</a></p> - -<h3><a name="Events-SDForum%3ASecuringApplicationswithApacheShiro"></a>SDForum: Securing Applications with Apache Shiro</h3> + <a name="Events-ApacheShiroEvents"></a> +<h1><a href="#apache-shiro-events" name="apache-shiro-events">Apache Shiro Events</a></h1> +<p>Below is list of upcoming and past Shiro events.</p> +<a name="Events-UpcomingEvents"></a> +<h2><a href="#upcoming-events" name="upcoming-events">Upcoming Events</a></h2> +<a name="Events-DevNexus%3AApplicationSecuritywithApacheShiro"></a> +<h3>DevNexus: Application Security with Apache Shiro</h3> +<p>March 22, 2011, Atlanta, GA<br/><a href="https://www.devnexus.com/s/presentations#1138";>https://www.devnexus.com/s/presentations#1138</a></p> +<a name="Events-PastEvents"></a> +<h2><a href="#past-events" name="past-events">Past Events</a></h2> +<a name="Events-SanFranciscoJavaUserGroup%3ASuperSimpleApplicationSecuritywithApacheShiro"></a> +<h3>San Francisco Java User Group: Super Simple Application Security with Apache Shiro</h3> +<p>October 12, 2010, San Francisco, CA<br/><a href="http://www.meetup.com/sfjava/";>http://www.meetup.com/sfjava/</a></p> +<a name="Events-SDForum%3ASecuringApplicationswithApacheShiro"></a> +<h3>SDForum: Securing Applications with Apache Shiro</h3> <p>June 1, 2010, Palo Alto, CA</p> </div> Modified: shiro/site/publish/features-overview.html URL: http://svn.apache.org/viewvc/shiro/site/publish/features-overview.html?rev=1766414&r1=1766413&r2=1766414&view=diff ============================================================================== --- shiro/site/publish/features-overview.html (original) +++ shiro/site/publish/features-overview.html Mon Oct 24 14:33:52 2016 @@ -78,45 +78,37 @@ <div id="content"> - <h1><a name="FeaturesOverview-ApacheShiroFeaturesOverview"></a>Apache Shiro Features Overview</h1> - -<p>Apache Shiro aims to be the most comprehensive, but also the easiest to use Java security framework available. Here are some of the frameworks finer points:</p> - -<ul><li>The easiest to understand Java Security API anywhere. Class and Interface names are intuitive and <em>make sense</em>. Anything is pluggable but good defaults exist for everything.</li></ul> - - -<ul><li>Support authentication ('logins') across one or more pluggable data sources (LDAP, JDBC, ActiveDirectory, etc).</li></ul> - - -<ul><li>Perform authorization ('access control') based on roles or fine-grained permissions, also using pluggable data sources.</li></ul> - - -<ul><li>First-class caching support for enhanced application performance.</li></ul> - - -<ul><li>Built-in POJO-based Enterprise Session Management. Use in both web and non-web environments or in any environment where Single Sign On (SSO) or clustered or distributed sessions are desired.</li></ul> - - -<ul><li><em>Heterogeneous</em> client session access. You are no longer forced to use only the <tt>HttpSession</tt> or Stateful Session Beans, which often unnecessarily tied applications to specific environments. Flash applets, C# applications, Java Web Start, and Web Applications, etc. can now all share session state regardless of deployment environment.</li></ul> - - -<ul><li>Simple Single Sign-On (SSO) support piggybacking the above Enterprise Session Management. If sessions are federated across multiple applications, the user's authentication state can be shared too. Log in once to any application and the others all recognize that log-in.</li></ul> - - -<ul><li>Secure data with the easiest possible Cryptography APIs available, giving you power and simplicity beyond what Java provides by default for ciphers and hashes.</li></ul> - - -<ul><li>An incredibly robust yet <b><em>low-configuration</em></b> web framework that can secure any url or resource, automatically handle logins and logouts, perform Remember Me services, and more.</li></ul> - - -<ul><li>Extremely low number of required dependencies. Standalone configuration requires only <tt>slf4j-api.jar</tt> and one of slf4j's binding .jars. Web configuration additionally requires <tt>commons-beanutils-core.jar</tt>. Feature-based dependencies (Ehcache caching, Quartz-based Session validation, Spring dependency injection, etc.) can be added when needed.</li></ul> - - -<h2><a name="FeaturesOverview-WantmoreinformationonwhatShirocando%3F"></a>Want more information on what Shiro can do? </h2> -<p>Check out the specific features for each of Shiro's major components: <a href="authentication-features.html" title="Authentication Features">Authentications</a>, <a href="authorization-features.html" title="Authorization Features">Authorization</a>, <a href="session-management-features.html" title="Session Management Features">Session Management</a>, and <a href="cryptography-features.html" title="Cryptography Features">Cryptogrpahy</a>.</p> - -<h2><a name="FeaturesOverview-GetStartedin10MinuteswithShiro"></a>Get Started in 10 Minutes with Shiro</h2> -<p>Try out Shiro for yourself with our <a href="10-minute-tutorial.html" title="10 Minute Tutorial">10 Minute Tutorial</a>. And if you have any questions about Shiro, please check out our <a href="forums.html" title="Forums">community forum</a> or <a href="mailing-lists.html" title="Mailing Lists">user mailing list</a> for answers from the community.</p> + <a name="FeaturesOverview-ApacheShiroFeaturesOverview"></a> +<h1><a href="#apache-shiro-features-overview" name="apache-shiro-features-overview">Apache Shiro Features Overview</a></h1> +<p>Apache Shiro aims to be the most comprehensive, but also the easiest to use Java security framework available. Here are some of the frameworks finer points:</p> +<ul> + <li> + <p>The easiest to understand Java Security API anywhere. Class and Interface names are intuitive and <em>make sense</em>. Anything is pluggable but good defaults exist for everything.</p></li> + <li> + <p>Support authentication (‘logins’) across one or more pluggable data sources (LDAP, JDBC, ActiveDirectory, etc).</p></li> + <li> + <p>Perform authorization (‘access control’) based on roles or fine-grained permissions, also using pluggable data sources.</p></li> + <li> + <p>First-class caching support for enhanced application performance.</p></li> + <li> + <p>Built-in POJO-based Enterprise Session Management. Use in both web and non-web environments or in any environment where Single Sign On (SSO) or clustered or distributed sessions are desired.</p></li> + <li> + <p><em>Heterogeneous</em> client session access. You are no longer forced to use only the <code>HttpSession</code> or Stateful Session Beans, which often unnecessarily tied applications to specific environments. Flash applets, C# applications, Java Web Start, and Web Applications, etc. can now all share session state regardless of deployment environment.</p></li> + <li> + <p>Simple Single Sign-On (SSO) support piggybacking the above Enterprise Session Management. If sessions are federated across multiple applications, the user’s authentication state can be shared too. Log in once to any application and the others all recognize that log-in.</p></li> + <li> + <p>Secure data with the easiest possible Cryptography APIs available, giving you power and simplicity beyond what Java provides by default for ciphers and hashes.</p></li> + <li> + <p>An incredibly robust yet <strong><em>low-configuration</em></strong> web framework that can secure any url or resource, automatically handle logins and logouts, perform Remember Me services, and more.</p></li> + <li> + <p>Extremely low number of required dependencies. Standalone configuration requires only <code>slf4j-api.jar</code> and one of slf4j’s binding .jars. Web configuration additionally requires <code>commons-beanutils-core.jar</code>. Feature-based dependencies (Ehcache caching, Quartz-based Session validation, Spring dependency injection, etc.) can be added when needed.</p></li> +</ul> +<a name="FeaturesOverview-WantmoreinformationonwhatShirocando%3F"></a> +<h2><a href="#want-more-information-on-what-shiro-can-do-" name="want-more-information-on-what-shiro-can-do-">Want more information on what Shiro can do?</a></h2> +<p>Check out the specific features for each of Shiro’s major components: <a href="authentication-features.html" title="Authentication Features">Authentications</a>, <a href="authorization-features.html" title="Authorization Features">Authorization</a>, <a href="session-management-features.html" title="Session Management Features">Session Management</a>, and <a href="cryptography-features.html" title="Cryptography Features">Cryptogrpahy</a>.</p> +<a name="FeaturesOverview-GetStartedin10MinuteswithShiro"></a> +<h2><a href="#get-started-in-10-minutes-with-shiro" name="get-started-in-10-minutes-with-shiro">Get Started in 10 Minutes with Shiro</a></h2> +<p>Try out Shiro for yourself with our <a href="10-minute-tutorial.html" title="10 Minute Tutorial">10 Minute Tutorial</a>. And if you have any questions about Shiro, please check out our <a href="forums.html" title="Forums">community forum</a> or <a href="mailing-lists.html" title="Mailing Lists">user mailing list</a> for answers from the community.</p> </div> Modified: shiro/site/publish/forums.html URL: http://svn.apache.org/viewvc/shiro/site/publish/forums.html?rev=1766414&r1=1766413&r2=1766414&view=diff ============================================================================== --- shiro/site/publish/forums.html (original) +++ shiro/site/publish/forums.html Mon Oct 24 14:33:52 2016 @@ -78,16 +78,16 @@ <div id="content"> - <h1><a name="Forums-ApacheShiroCommunityForums"></a>Apache Shiro Community Forums</h1> - -<p>For users that prefer to use forums over mailing lists, we use the <a class="external-link" href="http://www.nabble.com"; rel="nofollow">Nabble</a> forum/email/archive service. Nabble ensures that its forums remain synchronized with the mailing lists, so feel free to use whichever mechanism you like.</p> - - -<ul class="alternate" type="square"><li><a class="external-link" href="http://shiro-user.582556.n2.nabble.com/"; rel="nofollow">Shiro User Forum</a></li><li><a class="external-link" href="http://shiro-developer.582600.n2.nabble.com/"; rel="nofollow">Shiro Developer Forum</a></li></ul> - - -<h2><a name="Forums-MailingLists"></a>Mailing Lists</h2> -<p>For those that may prefer mailing lists, please see the <a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a> information.</p> + <a name="Forums-ApacheShiroCommunityForums"></a> +<h1><a href="#apache-shiro-community-forums" name="apache-shiro-community-forums">Apache Shiro Community Forums</a></h1> +<p>For users that prefer to use forums over mailing lists, we use the <a href="http://www.nabble.com";>Nabble</a> forum/email/archive service. Nabble ensures that its forums remain synchronized with the mailing lists, so feel free to use whichever mechanism you like.</p> +<ul> + <li><a href="http://shiro-user.582556.n2.nabble.com/";>Shiro User Forum</a></li> + <li><a href="http://shiro-developer.582600.n2.nabble.com/";>Shiro Developer Forum</a></li> +</ul> +<a name="Forums-MailingLists"></a> +<h2><a href="#mailing-lists" name="mailing-lists">Mailing Lists</a></h2> +<p>For those that may prefer mailing lists, please see the <a href="mailing-lists.html">Mailing Lists</a> information.</p> </div> Modified: shiro/site/publish/getting-started-block.html URL: http://svn.apache.org/viewvc/shiro/site/publish/getting-started-block.html?rev=1766414&r1=1766413&r2=1766414&view=diff ============================================================================== --- shiro/site/publish/getting-started-block.html (original) +++ shiro/site/publish/getting-started-block.html Mon Oct 24 14:33:52 2016 @@ -78,8 +78,9 @@ <div id="content"> - <h2><a name="GettingStartedBlock-GetStartedin10MinuteswithShiro"></a>Get Started in 10 Minutes with Shiro</h2> -<p>Try out Shiro for yourself with our <a href="10-minute-tutorial.html" title="10 Minute Tutorial">10 Minute Tutorial</a>. And if you have any questions about Shiro, please check out our <a href="forums.html" title="Forums">community forum</a> or <a href="mailing-lists.html" title="Mailing Lists">user mailing list</a> for answers from the community.</p> + <a name="GettingStartedBlock-GetStartedin10MinuteswithShiro"></a> +<h2><a href="#get-started-in-10-minutes-with-shiro" name="get-started-in-10-minutes-with-shiro">Get Started in 10 Minutes with Shiro</a></h2> +<p>Try out Shiro for yourself with our <a href="10-minute-tutorial.html" title="10 Minute Tutorial">10 Minute Tutorial</a>. And if you have any questions about Shiro, please check out our <a href="forums.html" title="Forums">community forum</a> or <a href="mailing-lists.html" title="Mailing Lists">user mailing list</a> for answers from the community.</p> </div> Modified: shiro/site/publish/graduation-resolution.html URL: http://svn.apache.org/viewvc/shiro/site/publish/graduation-resolution.html?rev=1766414&r1=1766413&r2=1766414&view=diff ============================================================================== --- shiro/site/publish/graduation-resolution.html (original) +++ shiro/site/publish/graduation-resolution.html Mon Oct 24 14:33:52 2016 @@ -78,20 +78,19 @@ <div id="content"> - <h1><a name="GraduationResolution-ApacheShiroGraduationResolution"></a>Apache Shiro Graduation Resolution</h1> - -<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> -<pre>Establish Apache Shiro Project + <a name="GraduationResolution-ApacheShiroGraduationResolution"></a> +<h1><a href="#apache-shiro-graduation-resolution" name="apache-shiro-graduation-resolution">Apache Shiro Graduation Resolution</a></h1> +<pre><code class="nohighlight">Establish Apache Shiro Project WHEREAS, the Board of Directors deems it to be in the best -interests of the Foundation and consistent with the Foundation's +interests of the Foundation and consistent with the Foundation's purpose to establish a Project Management Committee charged with the creation and maintenance of open-source software related to application security, for distribution at no charge to the public. NOW, THEREFORE, BE IT RESOLVED, that a Project Management -Committee (PMC), to be known as the "The Apache Shiro Project", +Committee (PMC), to be known as the "The Apache Shiro Project", be and hereby is established pursuant to Bylaws of the Foundation; and be it further @@ -99,7 +98,7 @@ RESOLVED, that The Apache Shiro Project responsible for the creation and maintenance of a software project related to application security; and be it further -RESOLVED, that the office of "Vice President, Shiro" be and +RESOLVED, that the office of "Vice President, Shiro" be and hereby is created, the person holding such office to serve at the direction of the Board of Directors as the chair of The Apache Shiro Project, and to have primary responsibility for management @@ -131,8 +130,7 @@ Incubator Shiro podling; and be it furth RESOLVED, that all responsibility pertaining to the Apache Incubator Shiro podling encumbered upon the Apache Incubator PMC are hereafter discharged. -</pre> -</div></div> +</code></pre> </div> Modified: shiro/site/publish/guice.html URL: http://svn.apache.org/viewvc/shiro/site/publish/guice.html?rev=1766414&r1=1766413&r2=1766414&view=diff ============================================================================== --- shiro/site/publish/guice.html (original) +++ shiro/site/publish/guice.html Mon Oct 24 14:33:52 2016 @@ -78,54 +78,54 @@ <div id="content"> - <h1><a name="Guice-IntegratingApacheShirointoGuicebasedApplication"></a>Integrating Apache Shiro into Guice based Application</h1> - -<p>Shiro <a class="external-link" href="https://github.com/google/guice"; rel="nofollow">Guice</a> integration was added in Shiro 1.2. This page covers the ways to integrate Shiro into Guice-based applications using standard Guice conventions and mechanisms. Prior to reading this integration document, you should be a least somewhat familiar with Guice.</p> - -<h2><a name="Guice-Overview"></a>Overview</h2> - + <a name="Guice-IntegratingApacheShirointoGuicebasedApplication"></a> +<h1><a href="#integrating-apache-shiro-into-guice-based-application" name="integrating-apache-shiro-into-guice-based-application">Integrating Apache Shiro into Guice based Application</a></h1> +<p>Shiro <a href="https://github.com/google/guice";>Guice</a> integration was added in Shiro 1.2. This page covers the ways to integrate Shiro into Guice-based applications using standard Guice conventions and mechanisms. Prior to reading this integration document, you should be a least somewhat familiar with Guice.</p> +<a name="Guice-Overview"></a> +<h2><a href="#overview" name="overview">Overview</a></h2> <p>shiro-guice provides three Guice modules that can be included in your application.</p> - -<ul><li>ShiroModule - <ul><li>Provides basic integration for setting up the <tt>SecurityManager</tt>, any <tt>Realms</tt>, and any other Shiro configuration.</li><li>This module is used by extending it and adding your own custom configuration.</li></ul> - </li></ul> - - -<ul><li>ShiroWebModule - <ul><li>Extension of <tt>ShiroModule</tt> that sets up the web environment and also allows for filter chain configuration. This uses the <a class="external-link" href="https://github.com/google/guice/wiki/ServletModule"; rel="nofollow">Guice Servlet Module</a> to configure the filters, and so requires that to be setup.</li><li>Like the <tt>ShiroModule</tt>, this module is used by extending it and adding your own custom configuration.</li></ul> - </li></ul> - - -<ul><li>ShiroAopModule - <ul><li>Uses <a class="external-link" href="https://github.com/google/guice/wiki/AOP"; rel="nofollow">Guice AOP</a> to implement the Shiro AOP annotations. This module is primarily concerned with adapting Shiro <tt>AnnotationMethodInterceptors</tt> to the Guice method interceptor model.</li><li>This module is typically used by simply installing it. However, if you have your own <tt>AnnotationMethodInterceptors</tt> written for Shiro, they can be easily incorporated by extending it.</li></ul> - </li></ul> - - -<h2><a name="Guice-GettingStarted"></a>Getting Started</h2> - -<p>The most simple configuration is to extend <tt>ShiroModule</tt> to install your own <tt>Realm</tt>. </p> - -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - class MyShiroModule <span class="code-keyword">extends</span> ShiroModule { - <span class="code-keyword">protected</span> void configureShiro() { - <span class="code-keyword">try</span> { - bindRealm().toConstructor(IniRealm.class.getConstructor(Ini.class)); - } <span class="code-keyword">catch</span> (NoSuchMethodException e) { - addError(e); - } - } - - @Provides - Ini loadShiroIni() { - <span class="code-keyword">return</span> Ini.fromResourcePath(<span class="code-quote">"classpath:shiro.ini"</span>); +<ul> + <li> + <p>ShiroModule</p> + <ul> + <li>Provides basic integration for setting up the <code>SecurityManager</code>, any <code>Realms</code>, and any other Shiro configuration.</li> + <li>This module is used by extending it and adding your own custom configuration.</li> + </ul> + </li> + <li> + <p>ShiroWebModule</p> + <ul> + <li>Extension of <code>ShiroModule</code> that sets up the web environment and also allows for filter chain configuration. This uses the <a href="https://github.com/google/guice/wiki/ServletModule";>Guice Servlet Module</a> to configure the filters, and so requires that to be setup.</li> + <li>Like the <code>ShiroModule</code>, this module is used by extending it and adding your own custom configuration.</li> + </ul> + </li> + <li> + <p>ShiroAopModule</p> + <ul> + <li>Uses <a href="https://github.com/google/guice/wiki/AOP";>Guice AOP</a> to implement the Shiro AOP annotations. This module is primarily concerned with adapting Shiro <code>AnnotationMethodInterceptors</code> to the Guice method interceptor model.</li> + <li>This module is typically used by simply installing it. However, if you have your own <code>AnnotationMethodInterceptors</code> written for Shiro, they can be easily incorporated by extending it.</li> + </ul> + </li> +</ul> +<a name="Guice-GettingStarted"></a> +<h2><a href="#getting-started" name="getting-started">Getting Started</a></h2> +<p>The most simple configuration is to extend <code>ShiroModule</code> to install your own <code>Realm</code>.</p> +<pre><code class="java">class MyShiroModule extends ShiroModule { + protected void configureShiro() { + try { + bindRealm().toConstructor(IniRealm.class.getConstructor(Ini.class)); + } catch (NoSuchMethodException e) { + addError(e); } } -</pre> -</div></div> - -<p>In this case, user and role configuration would go in the <tt>shiro.ini</tt> file.</p> + @Provides + Ini loadShiroIni() { + return Ini.fromResourcePath("classpath:shiro.ini"); + } +} +</code></pre> +<p>In this case, user and role configuration would go in the <code>shiro.ini</code> file.</p> <div class="panelMacro"> <table class="noteMacro"> <colgroup span="1"> @@ -141,147 +141,93 @@ <td colspan="1" rowspan="1"> <b>shiro.ini usage in Guice</b> <br clear="none"> - It is important to note that, in this above configuration, only the <tt>users</tt> and <tt>roles</tt> sections from the ini file are used. + It is important to note that, in this above configuration, only the `users` and `roles` sections from the ini file are used. </td> </tr> </tbody> </table> </div> - -<p>Then, the module is used to create a Guice injector, and the injector is used to obtain a <tt>SecurityManager</tt>. The following example serves the same purpose as the first three lines in the <a class="external-link" href="10-minute-tutorial.html#10MinuteTutorial-Quickstart.java">Quickstart</a> example.</p> - -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - Injector injector = Guice.createInjector(<span class="code-keyword">new</span> MyShiroModule()); - <span class="code-object">SecurityManager</span> securityManager = injector.getInstance(<span class="code-object">SecurityManager</span>.class); - SecurityUtils.setSecurityManager(securityManager); -</pre> -</div></div> - -<h2><a name="Guice-AOP"></a>AOP</h2> - -<p>Shiro includes several annotations and method interceptors useful for performing authorization via AOP. It also provides a simple API for writing Shiro-specific method interceptors. shiro-guice supports this with the <tt>ShiroAopModule</tt>.</p> - -<p>To use it, simply instantiate and install the module alongside your application module and your <tt>ShiroModule</tt>. </p> - -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - Injector injector = Guice.createInjector(<span class="code-keyword">new</span> MyShiroModule(), <span class="code-keyword">new</span> ShiroAopModule(), <span class="code-keyword">new</span> MyApplicationModule()); -</pre> -</div></div> - -<p>If you have written custom interceptors that conform to Shiro's api, you may find it useful to extend the <tt>ShiroAopModule</tt>. </p> - -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - class MyShiroAopModule <span class="code-keyword">extends</span> ShiroAopModule { - <span class="code-keyword">protected</span> void configureInterceptors(AnnotationResolver resolver) - { - bindShiroInterceptor(<span class="code-keyword">new</span> MyCustomAnnotationMethodInterceptor(resolver)); - } +<p>Then, the module is used to create a Guice injector, and the injector is used to obtain a <code>SecurityManager</code>. The following example serves the same purpose as the first three lines in the <a href="10-minute-tutorial.html#10MinuteTutorial-Quickstart.java">Quickstart</a> example.</p> +<pre><code class="java">Injector injector = Guice.createInjector(new MyShiroModule()); +SecurityManager securityManager = injector.getInstance(SecurityManager.class); +SecurityUtils.setSecurityManager(securityManager); +</code></pre> +<a name="Guice-AOP"></a> +<h2><a href="#aop" name="aop">AOP</a></h2> +<p>Shiro includes several annotations and method interceptors useful for performing authorization via AOP. It also provides a simple API for writing Shiro-specific method interceptors. shiro-guice supports this with the <code>ShiroAopModule</code>.</p> +<p>To use it, simply instantiate and install the module alongside your application module and your <code>ShiroModule</code>.</p> +<pre><code class="java">Injector injector = Guice.createInjector(new MyShiroModule(), new ShiroAopModule(), new MyApplicationModule()); +</code></pre> +<p>If you have written custom interceptors that conform to Shiro’s api, you may find it useful to extend the <code>ShiroAopModule</code>.</p> +<pre><code class="java">class MyShiroAopModule extends ShiroAopModule { + protected void configureInterceptors(AnnotationResolver resolver) + { + bindShiroInterceptor(new MyCustomAnnotationMethodInterceptor(resolver)); + } +} +</code></pre> +<a name="Guice-Web"></a> +<h2><a href="#web" name="web">Web</a></h2> +<p>shiro-guice’s web integration is designed to integrate Shiro and its filter paradigm with Guice’s servlet module. If you are using Shiro in a web environment, and using Guice’s servlet module, then you should extend ShiroWebModule rather than ShiroModule. Your web.xml should be setup exactly as Guice’s servlet module recommends.</p> +<pre><code class="java">class MyShiroWebModule extends ShiroWebModule { + MyShiroWebModule(ServletContext sc) { + super(sc); } -</pre> -</div></div> - -<h2><a name="Guice-Web"></a>Web</h2> - -<p>shiro-guice's web integration is designed to integrate Shiro and its filter paradigm with Guice's servlet module. If you are using Shiro in a web environment, and using Guice's servlet module, then you should extend ShiroWebModule rather than ShiroModule. Your web.xml should be setup exactly as Guice's servlet module recommends.</p> - -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - class MyShiroWebModule <span class="code-keyword">extends</span> ShiroWebModule { - MyShiroWebModule(ServletContext sc) { - <span class="code-keyword">super</span>(sc); - } - <span class="code-keyword">protected</span> void configureShiroWeb() { - <span class="code-keyword">try</span> { - bindRealm().toConstructor(IniRealm.class.getConstructor(Ini.class)); - } <span class="code-keyword">catch</span> (NoSuchMethodException e) { - addError(e); - } - - addFilterChain(<span class="code-quote">"/<span class="code-keyword">public</span>/**"</span>, ANON); - addFilterChain(<span class="code-quote">"/stuff/allowed/**"</span>, AUTHC_BASIC, config(PERMS, <span class="code-quote">"yes"</span>)); - addFilterChain(<span class="code-quote">"/stuff/forbidden/**"</span>, AUTHC_BASIC, config(PERMS, <span class="code-quote">"no"</span>)); - addFilterChain(<span class="code-quote">"/**"</span>, AUTHC_BASIC); + protected void configureShiroWeb() { + try { + bindRealm().toConstructor(IniRealm.class.getConstructor(Ini.class)); + } catch (NoSuchMethodException e) { + addError(e); } - @Provides - Ini loadShiroIni() { - <span class="code-keyword">return</span> Ini.fromResourcePath(<span class="code-quote">"classpath:shiro.ini"</span>); - } + addFilterChain("/public/**", ANON); + addFilterChain("/stuff/allowed/**", AUTHC_BASIC, config(PERMS, "yes")); + addFilterChain("/stuff/forbidden/**", AUTHC_BASIC, config(PERMS, "no")); + addFilterChain("/**", AUTHC_BASIC); } -</pre> -</div></div> - -<p>In the previous code, we have bound an <tt>IniRealm</tt> and setup four filter chains. These chains would be equivalent to the following ini configuration. </p> - -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - [urls] - /<span class="code-keyword">public</span>/** = anon - /stuff/allowed/** = authcBasic, perms[<span class="code-quote">"yes"</span>] - /stuff/forbidden/** = authcBasic, perms[<span class="code-quote">"no"</span>] - /** = authcBasic -</pre> -</div></div> - -<p>In shiro-guice, the filter names are Guice keys. All of the default Shiro filters are available as constants, but you are not limited to those. In order to use a custom filter in a filter chain, you would do </p> - -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - Key customFilter = Key.get(MyCustomFilter.class); - - addFilterChain(<span class="code-quote">"/custom/**"</span>, customFilter); -</pre> -</div></div> - -<p>We still have to tell guice-servlets about our Shiro filter. Since the <tt>ShiroWebModule</tt> is private, and guice-servlets does not give us a way to expose a filter mapping, we have to bind it manually. </p> - -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - ShiroWebModule.guiceFilterModule() -</pre> -</div></div> - -<p>Or, from within an application module, </p> -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - ShiroWebModule.bindGuiceFilter(binder()) -</pre> -</div></div> - -<h2><a name="Guice-Properties"></a>Properties</h2> - -<p>A number of Shiro classes expose configuration parameters via setter methods. shiro-guice will inject these if it finds a binding for <tt>@Named("shiro.{propName}")</tt>. For instance, to set the session timeout, you could do the following. </p> - -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - bindConstant().annotatedWith(Names.named(<span class="code-quote">"shiro.globalSessionTimeout"</span>)).to(30000L); -</pre> -</div></div> - -<p>If this paradigm doesn't work for you, you may also consider using a provider to instantiate the object and invoking the setters directly.</p> - -<h2><a name="Guice-InjectionofShiroObjects"></a>Injection of Shiro Objects</h2> - -<p>shiro-guice uses a Guice <tt>TypeListener</tt> to perform injection on native Shiro classes (any class in a subdirectory of <tt>org.apache.shiro</tt> but not <tt>org.apache.shiro.guice</tt>). However, Guice only considers explicitly bound types as candidates for <tt>TypeListeners</tt>, so if you have a Shiro object that you want injected, you have to declare it explicitly. For instance, to set the <tt>CredentialsMatcher</tt> for a realm, we would need to add the following bindings:</p> - -<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> -<pre class="code-java"> - bind(CredentialsMatcher.class).to(HashedCredentialsMatcher.class); - bind(HashedCredentialsMatcher.class); - bindConstant().annotatedWith(Names.named(<span class="code-quote">"shiro.hashAlgorithmName"</span>)).to(Md5Hash.ALGORITHM_NAME); -</pre> -</div></div> - -<h2><a name="Guice-Lendahandwithdocumentation"></a>Lend a hand with documentation </h2> - -<p>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 corrected, expanding, or adding documentation where you see a need. Every little bit of help you provide expands the community and in turn improves Shiro. </p> - -<p>The easiest way to contribute your documentation is to send it to the <a class="external-link" href="http://shiro-user.582556.n2.nabble.com/"; rel="nofollow">User Forum</a> or the <a href="mailing-lists.html" title="Mailing Lists">User Mailing List</a>.</p> + @Provides + Ini loadShiroIni() { + return Ini.fromResourcePath("classpath:shiro.ini"); + } +} +</code></pre> +<p>In the previous code, we have bound an <code>IniRealm</code> and setup four filter chains. These chains would be equivalent to the following ini configuration.</p> +<pre><code class="ini">[urls] +/public/** = anon +/stuff/allowed/** = authcBasic, perms["yes"] +/stuff/forbidden/** = authcBasic, perms["no"] +/** = authcBasic +</code></pre> +<p>In shiro-guice, the filter names are Guice keys. All of the default Shiro filters are available as constants, but you are not limited to those. In order to use a custom filter in a filter chain, you would do</p> +<pre><code class="java">Key customFilter = Key.get(MyCustomFilter.class); + +addFilterChain("/custom/**", customFilter); +</code></pre> +<p>We still have to tell guice-servlets about our Shiro filter. Since the <code>ShiroWebModule</code> is private, and guice-servlets does not give us a way to expose a filter mapping, we have to bind it manually.</p> +<pre><code class="java">ShiroWebModule.guiceFilterModule() +</code></pre> +<p>Or, from within an application module,</p> +<pre><code class="java">ShiroWebModule.bindGuiceFilter(binder()) +</code></pre> +<a name="Guice-Properties"></a> +<h2><a href="#properties" name="properties">Properties</a></h2> +<p>A number of Shiro classes expose configuration parameters via setter methods. shiro-guice will inject these if it finds a binding for <code>@Named("shiro.{propName}")</code>. For instance, to set the session timeout, you could do the following.</p> +<pre><code class="java">bindConstant().annotatedWith(Names.named("shiro.globalSessionTimeout")).to(30000L); +</code></pre> +<p>If this paradigm doesn’t work for you, you may also consider using a provider to instantiate the object and invoking the setters directly.</p> +<a name="Guice-InjectionofShiroObjects"></a> +<h2><a href="#injection-of-shiro-objects" name="injection-of-shiro-objects">Injection of Shiro Objects</a></h2> +<p>shiro-guice uses a Guice <code>TypeListener</code> to perform injection on native Shiro classes (any class in a subdirectory of <code>org.apache.shiro</code> but not <code>org.apache.shiro.guice</code>). However, Guice only considers explicitly bound types as candidates for <code>TypeListeners</code>, so if you have a Shiro object that you want injected, you have to declare it explicitly. For instance, to set the <code>CredentialsMatcher</code> for a realm, we would need to add the following bindings:</p> +<pre><code class="java">bind(CredentialsMatcher.class).to(HashedCredentialsMatcher.class); +bind(HashedCredentialsMatcher.class); +bindConstant().annotatedWith(Names.named("shiro.hashAlgorithmName")).to(Md5Hash.ALGORITHM_NAME); +</code></pre> +<a name="Guice-Lendahandwithdocumentation"></a> +<h2><a href="#lend-a-hand-with-documentation" name="lend-a-hand-with-documentation">Lend a hand with documentation</a></h2> +<p>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 corrected, expanding, or adding documentation where you see a need. Every little bit of help you provide expands the community and in turn improves Shiro.</p> +<p>The easiest way to contribute your documentation is to send it to the <a href="http://shiro-user.582556.n2.nabble.com/";>User Forum</a> or the <a href="mailing-lists.html" title="Mailing Lists">User Mailing List</a>.</p> </div> Modified: shiro/site/publish/guides.html URL: http://svn.apache.org/viewvc/shiro/site/publish/guides.html?rev=1766414&r1=1766413&r2=1766414&view=diff ============================================================================== --- shiro/site/publish/guides.html (original) +++ shiro/site/publish/guides.html Mon Oct 24 14:33:52 2016 @@ -78,20 +78,18 @@ <div id="content"> - <h1><a name="Guides-ApacheShiroGuides"></a>Apache Shiro Guides</h1> - + <a name="Guides-ApacheShiroGuides"></a> +<h1><a href="#apache-shiro-guides" name="apache-shiro-guides">Apache Shiro Guides</a></h1> <p>Here are some basic guides on how to use Shiro.</p> - <p>Please post any errata to the user or dev mailing lists.</p> - -<ul><li><b><a href="10-minute-tutorial.html" title="10 Minute Tutorial">10 Minute Tutorial</a></b></li></ul> - - -<ul><li><b><a href="java-authentication-guide.html" title="Java Authentication Guide">Authentication Guide</a></b></li></ul> - - -<ul><li><b><a href="java-authorization-guide.html" title="Java Authorization Guide">Authorization Guide</a></b></li></ul> - +<ul> + <li> + <p><strong><a href="10-minute-tutorial.html" title="10 Minute Tutorial">10 Minute Tutorial</a></strong></p></li> + <li> + <p><strong><a href="java-authentication-guide.html" title="Java Authentication Guide">Authentication Guide</a></strong></p></li> + <li> + <p><strong><a href="java-authorization-guide.html" title="Java Authorization Guide">Authorization Guide</a></strong></p></li> +</ul> </div>
