AbstractRobotsGenerator (Ametys 4.4.x - API)

java.lang.Object
- org.apache.avalon.framework.logger.AbstractLogEnabled
- - org.apache.cocoon.xml.AbstractXMLProducer
  - - org.apache.cocoon.generation.AbstractGenerator
    - - org.apache.cocoon.generation.ServiceableGenerator
      - org.ametys.web.robots.AbstractRobotsGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

Direct Known Subclasses:

RobotsGenerator, RobotsSitemapGenerator
```
public abstract class AbstractRobotsGenerator
extends ServiceableGenerator
```
Abstract base class for generators dealing with robots

Field Summary

Fields
Modifier and Type Field Description

private RightManager _rightManager

private SiteManager _siteManager
- Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator
  manager
- Fields inherited from class org.apache.cocoon.generation.AbstractGenerator
  objectModel, parameters, resolver, source
- Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer
  contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer
- Fields inherited from interface org.apache.cocoon.generation.Generator
  ROLE

Constructor Summary

Constructors
Constructor Description

AbstractRobotsGenerator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Site`	`getSite(String siteName)`	Get site
`protected boolean`	`hasRestrictedAccess(PagesContainer pageOrSitemap)`	Determines if the page or sitemap has a restricted access
`void`	`service(ServiceManager smanager)`

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator
dispose

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator
recycle, setup

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer
setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.cocoon.generation.Generator
generate

Methods inherited from interface org.apache.cocoon.xml.XMLProducer
setConsumer

- Field Detail
  - _siteManager
```
private SiteManager _siteManager
```
  - _rightManager
```
private RightManager _rightManager
```
- Constructor Detail
  - AbstractRobotsGenerator
```
public AbstractRobotsGenerator()
```
- Method Detail
  - service
```
public void service(ServiceManager smanager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Overrides:
    
    service in class ServiceableGenerator
    
    Throws:
    
    ServiceException
  - getSite
```
public Site getSite(String siteName)
```
    Get site
    
    Parameters:
    
    siteName - teh site name
    
    Returns:
    
    the site
  - hasRestrictedAccess
```
protected boolean hasRestrictedAccess(PagesContainer pageOrSitemap)
```
    Determines if the page or sitemap has a restricted access
    
    Parameters:
    
    pageOrSitemap - thepage or sitemap
    
    Returns:
    
    true if the page or sitemap has a restricted access