Uses of Class
org.webmacro.Broker

Packages that use Broker
org.webmacro   
org.webmacro.directive   
org.webmacro.engine   
org.webmacro.parser   
org.webmacro.resource   
org.webmacro.servlet   
org.webmacro.util   
 

Uses of Broker in org.webmacro
 

Methods in org.webmacro that return Broker
static Broker Broker.getBroker()
           
static Broker Broker.getBroker(java.lang.String settingsFile)
           
protected static Broker Broker.findBroker(java.lang.Object key)
          Find the broker for the specified partition key, if one is registered.
 Broker WM.getBroker()
          This object is used to access components that have been plugged into WebMacro; it is shared between all instances of this class and its subclasses.
 Broker Context.getBroker()
          Get the instance of the Broker for this request
 Broker WebMacro.getBroker()
          This object is used to access components that have been plugged into WebMacro; it is shared between all instances of this class and its subclasses.
 

Methods in org.webmacro with parameters of type Broker
protected static void Broker.register(java.lang.Object key, Broker broker)
          Used to maintain a weak map mapping the partition key to the Broker.
 void Provider.init(Broker b, Settings config)
          Initialize this provider based on the specified config.
static FastWriter FastWriter.getInstance(Broker broker, java.io.OutputStream out, java.lang.String encoding)
          Get a new FastWriter.
static FastWriter FastWriter.getInstance(Broker broker, java.lang.String encoding)
          Return a FastWriter with the specified encoding and no output stream.
static FastWriter FastWriter.getInstance(Broker broker)
          Return a FastWriter with default encoding and no output stream.
 

Constructors in org.webmacro with parameters of type Broker
Broker(Broker dummy, java.lang.String name)
          Explicitly provide the properties that WebMacro should configure from.
WM(Broker broker)
          Constructs a WM from an arbitrary Broker.
Context(Broker broker)
          Create a new Context relative to the supplied broker
FastWriter(Broker broker, java.io.OutputStream out, java.lang.String encoding)
          Create a FastWriter to the target outputstream.
FastWriter(Broker broker, java.lang.String encoding)
          Create a new FastWriter with no output stream target.
 

Uses of Broker in org.webmacro.directive
 

Methods in org.webmacro.directive with parameters of type Broker
protected  boolean IncludeDirective.isLazy(Broker b)
          are we configured to lazily include the file/template (meaning during expansion)? If not, we end up inserting the template/file contents during build().
protected  boolean IncludeDirective.isStrictlyCompatible(Broker b)
          are we strictly compatible with previous versions of both #parse and #include? Default is no, we are not strictly compatible b/c we can get pretty close by dynamically figuring out the file type and b/c #parse has been deprecated.
protected  java.lang.String[] IncludeDirective.getTemplateExtensions(Broker b)
          get an array of Template file extensions we should use, if type==dynamic, to decide if the specified file is a template or not
protected  int IncludeDirective.guessType(Broker b, java.lang.String filename)
          if the filename contains :// assume it's a file b/c it's probably a url.
protected  java.lang.Object IncludeDirective.getThingToInclude(Broker b, int type, java.lang.String filename)
          get the template or file that the user wants to include, based on the specified type
protected  Template IncludeDirective.getTemplate(Broker b, java.lang.String name)
          get a Template via the "template" provider known by the specified broker
protected  java.lang.String IncludeDirective.getFile(Broker b, java.lang.String name)
          get the contents of a file (local file or url) via the "url" provider known by the specified broker.
static void BeanDirective.init(Broker b)
           
 void DirectiveProvider.init(Broker broker, Settings config)
           
 

Uses of Broker in org.webmacro.engine
 

Fields in org.webmacro.engine declared as Broker
protected  Broker WMTemplate._broker
          The resource broker used to resolve things in this template
 

Methods in org.webmacro.engine with parameters of type Broker
 void CrankyEvaluationExceptionHandler.init(Broker b, Settings config)
           
 void DefaultEvaluationExceptionHandler.init(Broker b, Settings config)
           
 void EvaluationExceptionHandler.init(Broker b, Settings config)
          Initialize the EEH
 void PropertyOperatorCache.init(Broker b, Settings config)
           
 void ParserProvider.init(Broker broker, Settings p)
           
 

Constructors in org.webmacro.engine with parameters of type Broker
BuildContext(Broker b)
           
WMTemplate(Broker broker)
          Create a new Template.
WMTemplate(java.lang.String parserName, Broker broker)
          Create a new Template specifying both the broker and the parsing language.
FileTemplate(Broker broker, java.lang.String filename)
          Instantiate a template based on the specified filename using the default encoding from WebMacro.properties (TemplateEncoding), or if not specified there then the UTF-8 encoding.
FileTemplate(Broker broker, java.io.File templateFile)
          Instantiate a template based on the specified file using the default encoding from WebMacro.properties (TemplateEncoding), if not specified there then the UTF-8 encoding.
FileTemplate(Broker broker, java.io.File tmplFile, java.lang.String encoding)
          Instantiate a template based on the specified file using the specified encoding to read the template.
TextParser(Broker broker)
           
StreamTemplate(Broker broker, java.io.Reader inStream)
          Instantiate a template based on the specified stream
StreamTemplate(Broker broker, java.io.InputStream in)
          Instantiate a template based on the specified stream Will use webmacro's default encoding.
StreamTemplate(Broker broker, java.io.InputStream in, java.lang.String encoding)
          Instantiate a template based on the specified stream If encoding is null, webmacro's default encoding will be used.
CrankyEvaluationExceptionHandler(Broker b)
           
DefaultEvaluationExceptionHandler(Broker b)
           
NullParser(Broker broker)
           
StringTemplate(Broker broker, java.lang.String templateText)
          Instantiate a template.
StringTemplate(Broker broker, java.lang.String templateText, java.lang.String name)
          Instantiate a template.
 

Uses of Broker in org.webmacro.parser
 

Constructors in org.webmacro.parser with parameters of type Broker
WMParser(Broker b)
           
WMParser_impl(Broker broker, java.lang.String templateName, BackupCharStream stream)
           
WMParser_impl(Broker broker, java.lang.String templateName, java.io.Reader reader)
           
 

Uses of Broker in org.webmacro.resource
 

Methods in org.webmacro.resource with parameters of type Broker
 void TrivialCacheManager.init(Broker b, Settings config, java.lang.String resourceType)
           
 void CacheManager.init(Broker b, Settings config, java.lang.String resourceType)
          Same as defined in Provider, except with an additional type parameter so it knows what type of resource it is caching
 void StaticSMapCacheManager.init(Broker b, Settings config, java.lang.String resourceType)
           
 void StaticIdentityCacheManager.init(Broker b, Settings config, java.lang.String resourceType)
           
 void ResourceLoader.init(Broker b, Settings config)
          Initialize this provider based on the specified config.
 void CachingProvider.init(Broker b, Settings config)
          If you override this method be sure and call super.init(...)
 void BrokerTemplateProvider.init(Broker b, Settings config)
           
 void BrokerTemplateProviderHelper.init(Broker b, Settings config)
          Create a new TemplateProvider that uses the specified directory as the source for Template objects that it will return
 void HMapCacheManager.init(Broker b, Settings config, java.lang.String resourceType)
           
 void URLTemplateProvider.init(Broker b, Settings config)
          Create a new TemplateProvider that uses the specified directory as the source for Template objects that it will return
 void ConfigProvider.init(Broker b, Settings config)
           
 void SMapCacheManager.init(Broker b, Settings config, java.lang.String resourceType)
           
 void ReloadDelayDecorator.init(Broker b, Settings config)
          Initialize object.
 void UrlProvider.init(Broker b, Settings config)
           
 void GenerationalCacheManager.init(Broker b, Settings config, java.lang.String resourceType)
           
 void TemplateProvider.init(Broker b, Settings config)
          Create a new TemplateProvider that uses the specified directory as the source for Template objects that it will return
 

Constructors in org.webmacro.resource with parameters of type Broker
URLTemplate(Broker broker, java.net.URL templateURL)
          Instantiate a template based on the specified file We use can use the special case or URLs like file:xxxxxx or jar:xxxxxx!yyyyyy extracting the xxxxxx.
 

Uses of Broker in org.webmacro.servlet
 

Subclasses of Broker in org.webmacro.servlet
 class Servlet20Broker
          An implementation of Broker tailored for Servlet 2.0/2.1 environments.
 class Servlet22Broker
          An implementation of Broker tailored for Servlet 2.2 environments.
 class ServletBroker
           
 

Methods in org.webmacro.servlet that return Broker
 Broker WMServlet.getBroker()
          This object is used to access components that have been plugged into WebMacro; it is shared between all instances of this class and its subclasses.
static Broker ServletBroker.getBroker(javax.servlet.Servlet s)
           
static Broker Servlet20Broker.getBroker(javax.servlet.Servlet s)
           
static Broker Servlet22Broker.getBroker(javax.servlet.Servlet s)
           
 

Constructors in org.webmacro.servlet with parameters of type Broker
WebContext(Broker broker)
          Construct a new WebContext.
 

Uses of Broker in org.webmacro.util
 

Methods in org.webmacro.util with parameters of type Broker
 LogTarget LogTargetFactory.createLogTarget(Broker broker, java.lang.String classname, Settings settings)
          Creates a new org.webmacro.util.LogTarget
 void Encoder.init(Broker b, Settings config)
           
 void EncoderProvider.init(Broker b, Settings config)
          Initialize this provider based on the specified config.