at.pollux.thymeleaf.shiro.Shiro-Dialect.xml Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thymeleaf-extras-shiro Show documentation
Shiro taglib integration for Thymeleaf
The newest version!
<?xml version="1.0" encoding="UTF-8"?>

<!--

  ~ Licensed to the Apache Software Foundation (ASF) under one
  ~ or more contributor license agreements.  See the NOTICE file
  ~ distributed with this work for additional information
  ~ regarding copyright ownership.  The ASF licenses this file
  ~ to you under the Apache License, Version 2.0 (the
  ~ "License"); you may not use this file except in compliance
  ~ with the License.  You may obtain a copy of the License at
  ~
  ~     http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing,
  ~ software distributed under the License is distributed on an
  ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  ~ KIND, either express or implied.  See the License for the
  ~ specific language governing permissions and limitations
  ~ under the License.
-->
<dialect
        xmlns="http://www.thymeleaf.org/extras/dialect"
        prefix="shiro"
        namespace-uri="http://www.pollix.at/thymeleaf/shiro"
        class="at.pollux.thymeleaf.shiro.dialect.ShiroDialect">

    <attribute-processor name="authenticated"
                         class="at.pollux.thymeleaf.shiro.processor.attribute.AuthenticatedAttrProcessor">
        <documentation><![CDATA[
		Displays only if the current user has successfully authenticated _during their current session_. 
		It is more restrictive than the 'user' tag.  It is logically opposite to the 'notAuthenticated' tag.
		]]></documentation>
    </attribute-processor>

    <attribute-processor name="guest" class="at.pollux.thymeleaf.shiro.processor.attribute.GuestAttrProcessor">
        <documentation><![CDATA[
		Displays only if the current Subject IS NOT known to the system, either because they have not logged in or they have no 
		corresponding 'RememberMe' identity. It is logically opposite to the 'user' tag.
		]]></documentation>
    </attribute-processor>

    <attribute-processor name="hasAllPermissions"
                         class="at.pollux.thymeleaf.shiro.processor.attribute.HasAllPermissionsAttrProcessor">
        <documentation><![CDATA[
				Displays only if the current Subject (user) 'has all' (implies) the specified permission (i.e the user has the specified ability).
		]]></documentation>
    </attribute-processor>


    <attribute-processor name="hasAllRoles"
                         class="at.pollux.thymeleaf.shiro.processor.attribute.HasAllRolesAttrProcessor">
        <documentation><![CDATA[
				Displays only if the current user has all of the specified roles from a comma-separated list of role names.
		]]></documentation>
    </attribute-processor>

    <attribute-processor name="hasAnyPermissions"
                         class="at.pollux.thymeleaf.shiro.processor.attribute.HasAnyPermissionsAttrProcessor">
        <documentation><![CDATA[
				Displays only if the current user has one of the specified permission from a comma-separated list of permission names.
		]]></documentation>
    </attribute-processor>

    <attribute-processor name="hasAnyRoles"
                         class="at.pollux.thymeleaf.shiro.processor.attribute.HasAnyRolesAttrProcessor">
        <documentation><![CDATA[
		Displays only if the current user has one of the specified roles from a comma-separated list of role names.
		]]></documentation>
    </attribute-processor>

    <attribute-processor name="hasPermission"
                         class="at.pollux.thymeleaf.shiro.processor.attribute.HasPermissionAttrProcessor">
        <documentation><![CDATA[
		Displays only if the current Subject (user) 'has' (implies) the specified permission (i.e the user has the specified ability).
		]]></documentation>
    </attribute-processor>


    <attribute-processor name="hasRole" class="at.pollux.thymeleaf.shiro.processor.attribute.HasRoleAttrProcessor">
        <documentation><![CDATA[
		Displays only if the current user has the specified role.
		]]></documentation>
    </attribute-processor>


    <attribute-processor name="lacksPermission"
                         class="at.pollux.thymeleaf.shiro.processor.attribute.LacksPermissionAttrProcessor">
        <documentation><![CDATA[
		Displays only if the current Subject (user) does NOT have (not imply) the specified permission (i.e. the user lacks the specified ability)
		]]></documentation>
    </attribute-processor>


    <attribute-processor name="lacksRole" class="at.pollux.thymeleaf.shiro.processor.attribute.LacksRoleAttrProcessor">
        <documentation><![CDATA[
		Displays only if the current user does NOT have the specified role (i.e. they explicitly lack the specified role)
		]]></documentation>
    </attribute-processor>

    <attribute-processor name="notAuthenticated"
                         class="at.pollux.thymeleaf.shiro.processor.attribute.NotAuthenticatedAttrProcessor">
        <documentation><![CDATA[
		Displays only if the current user has NOT succesfully authenticated _during their current session_. 
		It is logically opposite to the 'authenticated' tag.
		]]></documentation>
    </attribute-processor>

    <attribute-processor name="principal" class="at.pollux.thymeleaf.shiro.processor.attribute.PrincipalAttrProcessor">
        <documentation><![CDATA[
		Displays the user's principal or a property of the user's principal. By default the principal to print is the subject.getPrincipal() value.  
		Use the 'type' attribute choose the object in the principal collection by type. Use the 'principal' attribute to reference a property in the
		principal object by name. 
		]]></documentation>
    </attribute-processor>

    <attribute-processor name="user" class="at.pollux.thymeleaf.shiro.processor.attribute.UserAttrProcessor">
        <documentation><![CDATA[
		Displays only if the current Subject has a known identity, either from a previous login or from 'RememberMe' services. 
		Note that this is semantically different from the 'authenticated' tag, which is more restrictive. 
		It is logically opposite to the 'guest' tag.
		]]></documentation>
    </attribute-processor>


    <element-processor name="authenticated"
                       class="at.pollux.thymeleaf.shiro.processor.element.AuthenticatedElementProcessor">
        <documentation><![CDATA[
		Displays body content only if the current user has successfully authenticated _during their current session_. 
		It is more restrictive than the 'user' tag. It is logically opposite to the 'notAuthenticated' tag.
		]]></documentation>
    </element-processor>

    <element-processor name="guest" class="at.pollux.thymeleaf.shiro.processor.element.GuestElementProcessor">
        <documentation><![CDATA[
		Displays body content only if the current Subject IS NOT known to the system, either because they have not logged in or 
		they have no corresponding 'RememberMe' identity. It is logically opposite to the 'user' tag.
		]]></documentation>
    </element-processor>

    <element-processor name="hasAllPermissions"
                       class="at.pollux.thymeleaf.shiro.processor.element.HasAllPermissionsElementProcessor">
        <documentation><![CDATA[
			Displays only if the current Subject (user) 'has all' (implies) the specified permission (i.e the user has the specified ability).
		]]></documentation>
    </element-processor>

    <element-processor name="hasAnyPermissions"
                       class="at.pollux.thymeleaf.shiro.processor.element.HasAnyPermissionsElementProcessor">
        <documentation><![CDATA[
						Displays only if the current user has one of the specified permission from a comma-separated list of permission names.
		]]></documentation>
    </element-processor>

    <element-processor name="hasAllRoles"
                       class="at.pollux.thymeleaf.shiro.processor.element.HasAllRolesElementProcessor">
        <documentation><![CDATA[
			Displays only if the current user has all of the specified roles from a comma-separated list of role names.
		]]></documentation>
    </element-processor>

    <element-processor name="hasAnyRoles"
                       class="at.pollux.thymeleaf.shiro.processor.element.HasAnyRolesElementProcessor">
        <documentation><![CDATA[
		Displays body content only if the current user has one of the specified roles from a comma-separated list of role names.
		]]></documentation>
    </element-processor>

    <element-processor name="hasPermission"
                       class="at.pollux.thymeleaf.shiro.processor.element.HasPermissionElementProcessor">
        <documentation><![CDATA[
		Displays body content only if the current Subject (user)
		'has' (implies) the specified permission (i.e the user has the specified ability).
		]]></documentation>
    </element-processor>

    <element-processor name="hasRole" class="at.pollux.thymeleaf.shiro.processor.element.HasRoleElementProcessor">
        <documentation><![CDATA[
		Displays body content only if the current user has the specified role.
		]]></documentation>
    </element-processor>

    <element-processor name="lacksPermission"
                       class="at.pollux.thymeleaf.shiro.processor.element.LacksPermissionElementProcessor">
        <documentation><![CDATA[
		Displays body content only if the current Subject (user) does
		NOT have (not imply) the specified permission (i.e. the user lacks the specified ability)
		]]></documentation>
    </element-processor>

    <element-processor name="lacksRole" class="at.pollux.thymeleaf.shiro.processor.element.LacksRoleElementProcessor">
        <documentation><![CDATA[
		Displays body content only if the current user does NOT have the specified role (i.e. they explicitly lack the specified role)
		]]></documentation>
    </element-processor>

    <element-processor name="notAuthenticated"
                       class="at.pollux.thymeleaf.shiro.processor.element.NotAuthenticatedElementProcessor">
        <documentation><![CDATA[
		Displays body content only if the current user has NOT succesfully authenticated
		_during their current session_. It is logically opposite to the 'authenticated' tag.
		]]></documentation>
    </element-processor>

    <element-processor name="principal" class="at.pollux.thymeleaf.shiro.processor.element.PrincipalElementProcessor">
        <documentation><![CDATA[
		Displays the user's principal or a property of the user's principal. By default the principal to print is the subject.getPrincipal() value.  
		Use the 'type' attribute choose the object in the principal collection by type. Use the 'principal' attribute to reference a property in the
		principal object by name.  
		]]></documentation>
    </element-processor>

    <element-processor name="user" class="at.pollux.thymeleaf.shiro.processor.element.UserElementProcessor">
        <documentation><![CDATA[
		Displays body content only if the current Subject has a known identity, either from a previous login or from 'RememberMe' services. 
		Note that this is semantically different from the 'authenticated' tag, which is more restrictive. It is logically opposite to the 'guest' tag.
		]]></documentation>
    </element-processor>


</dialect>