RestrictedPagePolicy (Ametys 4.5.x - API)

java.lang.Object
- java.lang.Enum<RestrictedPagePolicy>
- - org.ametys.web.pageaccess.RestrictedPagePolicy

All Implemented Interfaces:

Serializable, Comparable<RestrictedPagePolicy>
```
public enum RestrictedPagePolicy
extends Enum<RestrictedPagePolicy>
```
Per-site policy of rendering of restricted pages.
- HIDDEN: restricted pages access will remain hidden for unauthorized front-office users. Technically, it means that the SitemapInputData and the Sitemap service will not generate SAX events for those pages. This implies that the cache is disabled for sites with this policy. Use it only for intranets or sites with less traffic.
- DISPLAYED: restricted pages access will be displayed for everyone. When trying to go on one of these pages, an unauthorized user will get an AccessDeniedException. Technically, it means that the SitemapInputData and the Sitemap service will generate SAX events for those pages. Skins are then in charge of rendering restricted pages properly.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`DISPLAYED`	Restricted pages access will be displayed for everyone.
`HIDDEN`	Restricted pages access will remain hidden for unauthorized front-office users.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static RestrictedPagePolicy`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static RestrictedPagePolicy[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - HIDDEN
```
public static final RestrictedPagePolicy HIDDEN
```
    Restricted pages access will remain hidden for unauthorized front-office users.
  - DISPLAYED
```
public static final RestrictedPagePolicy DISPLAYED
```
    Restricted pages access will be displayed for everyone.
- Method Detail
  - values
```
public static RestrictedPagePolicy[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (RestrictedPagePolicy c : RestrictedPagePolicy.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RestrictedPagePolicy valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null