Skip navigation links

Oracle® WebCenter Content Site Studio for External Applications Java API Reference
11g Release 1 (11.1.1)

E17273-03


oracle.stellent.wcm.client.generator
Class SiteGenerator

java.lang.Object
  extended by oracle.stellent.wcm.client.generator.SiteGenerator


public class SiteGenerator
extends java.lang.Object

Generate a static version the sites represented by a configuration.


Constructor Summary
SiteGenerator(Configuration configuration)
           

 

Method Summary
 void addUrlProcessor(UrlProcessor processor)
           
 void clearUrlProcessors()
           
 GeneratorState generateSites()
          Generates the entire site hierarchy.
 GeneratorState generateSites(java.util.Set<java.net.URI> additionUrls)
          Generates the entire site hierarchy.
 ScriptableClientApplication getClientApplication()
           
 GeneratorCallback getGeneratorCallback()
           
 GeneratorOptions getOptions()
           
 PageGenerator getPageGenerator()
           
protected  void processDependentUrls(GeneratorState state)
          Process the dependent URLs listed in the current generator state
protected  void processUrl(GeneratorState state, java.net.URI uri)
          Process an individual URI
 void removeUrlProcessor(UrlProcessor processor)
           
 void setGeneratorCallback(GeneratorCallback generatorCallback)
           
 void setPageGenerator(PageGenerator pageGenerator)
           

 

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

 

Constructor Detail

SiteGenerator

public SiteGenerator(Configuration configuration)

Method Detail

getOptions

public GeneratorOptions getOptions()
Returns:
the generator options

getClientApplication

public ScriptableClientApplication getClientApplication()
                                                 throws GeneratorException
Returns:
the associated client application
Throws:
GeneratorException - if an error occurs during initialization

getGeneratorCallback

public GeneratorCallback getGeneratorCallback()
Returns:
the generator callback

setGeneratorCallback

public void setGeneratorCallback(GeneratorCallback generatorCallback)

getPageGenerator

public PageGenerator getPageGenerator()
                               throws GeneratorException
Returns:
the page generator object
Throws:
GeneratorException

setPageGenerator

public void setPageGenerator(PageGenerator pageGenerator)

addUrlProcessor

public void addUrlProcessor(UrlProcessor processor)

removeUrlProcessor

public void removeUrlProcessor(UrlProcessor processor)

clearUrlProcessors

public void clearUrlProcessors()

generateSites

public GeneratorState generateSites()
                             throws GeneratorException,
                                    java.io.IOException
Generates the entire site hierarchy.
Returns:
the state of the generator after completion
Throws:
GeneratorException
java.io.IOException

generateSites

public GeneratorState generateSites(java.util.Set<java.net.URI> additionUrls)
                             throws GeneratorException,
                                    java.io.IOException
Generates the entire site hierarchy.
Parameters:
additionUrls - the additional urls to crawl
Returns:
the state of the generator after completion
Throws:
GeneratorException
java.io.IOException

processDependentUrls

protected void processDependentUrls(GeneratorState state)
                             throws java.io.IOException,
                                    GeneratorException
Process the dependent URLs listed in the current generator state
Parameters:
state - the generator state
Throws:
java.io.IOException
GeneratorException

processUrl

protected void processUrl(GeneratorState state,
                          java.net.URI uri)
                   throws java.io.IOException,
                          GeneratorException
Process an individual URI
Parameters:
state - the generator state
uri - the URI to process
Throws:
java.io.IOException
GeneratorException

Skip navigation links

Oracle® WebCenter Content Site Studio for External Applications Java API Reference
11g Release 1 (11.1.1)

E17273-03


Copyright © 2010, 2011, Oracle and/or its affiliates. All rights reserved.