Java Doc for URLTemplatesFactory.java in » Library » Apache-beehive-1.0.2-src » org » apache » beehive » netui » core » urltemplates » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Library » Apache beehive 1.0.2 src » org.apache.beehive.netui.core.urltemplates

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.apache.beehive.netui.core.factory .Factory

org.apache.beehive.netui.core.urltemplates .URLTemplatesFactory

All known Subclasses:   org.apache.beehive.netui.pageflow.internal .DefaultURLTemplatesFactory,
URLTemplatesFactory
abstract public class URLTemplatesFactory extends Factory (Code)
Access point to URL templates (an optional config file to help format rewritten URLs) used by a org.apache.beehive.netui.core.urls.TemplatedURLFormatter via the org.apache.beehive.netui.core.urls.URLRewriterService .

Field Summary
final public static String ACTION_TEMPLATE

final public static String DEFAULT_TEMPLATE

final public static String DEFAULT_URL_TEMPLATE_CONFIG_FILE_PATH
     Default value for path from the web app to the URL templates.
final public static String RENDER_TEMPLATE

final public static String RESOURCE_TEMPLATE

final public static String SECURE_ACTION_TEMPLATE

final public static String SECURE_DEFAULT_TEMPLATE

final public static String SECURE_RENDER_TEMPLATE

final public static String SECURE_RESOURCE_TEMPLATE

protected String _configFilePath

protected Collection _knownTokens

protected Collection _requiredTokens


Method Summary
abstract public String getTemplateNameByRef(String refGroupName, String key)
     Returns URL template name of the given type (by key) from the desired reference group.
abstract public URLTemplate getURLTemplate(String name)
     Returns URL template given the name of the template.
abstract public URLTemplate[] getURLTemplates()
     Returns an array of the URL templates.
public static URLTemplatesFactory getURLTemplatesFactory(ServletContext servletContext)
     Gets the URLTemplatesFactory instance from a ServletContext attribute.
Parameters:
  servletContext - the current ServletContext.
public static URLTemplatesFactory getURLTemplatesFactory(ServletRequest servletRequest)
     Gets the URLTemplatesFactory instance from a ServletRequest attribute.
Parameters:
  servletRequest - the current ServletRequest.
public static void initServletContext(ServletContext servletContext, URLTemplatesFactory templatesFactory)
     Adds a given URLTemplatesFactory instance as an attribute on the ServletContext.
public static void initServletRequest(ServletRequest servletRequest, URLTemplatesFactory templatesFactory)
     Adds a given URLTemplatesFactory instance as an attribute on the ServletRequest.
abstract public void load(ServletContext servletContext)
     Initialization method that parses the URL template config file to get the URL templates and template reference groups.
public void setConfigFilePath(String configFilePath)
     Allow clients to set their own URL template config file name/path.
public void setKnownTokens(Collection knownTokens)
     Allow clients to define a set of known tokens for the template verification.
public void setRequiredTokens(Collection requiredTokens)
     Allow clients to define a set of required tokens for the template verification.

Field Detail
ACTION_TEMPLATE
final public static String ACTION_TEMPLATE(Code)

DEFAULT_TEMPLATE
final public static String DEFAULT_TEMPLATE(Code)

DEFAULT_URL_TEMPLATE_CONFIG_FILE_PATH
final public static String DEFAULT_URL_TEMPLATE_CONFIG_FILE_PATH(Code)
Default value for path from the web app to the URL templates.

RENDER_TEMPLATE
final public static String RENDER_TEMPLATE(Code)

RESOURCE_TEMPLATE
final public static String RESOURCE_TEMPLATE(Code)

SECURE_ACTION_TEMPLATE
final public static String SECURE_ACTION_TEMPLATE(Code)

SECURE_DEFAULT_TEMPLATE
final public static String SECURE_DEFAULT_TEMPLATE(Code)

SECURE_RENDER_TEMPLATE
final public static String SECURE_RENDER_TEMPLATE(Code)

SECURE_RESOURCE_TEMPLATE
final public static String SECURE_RESOURCE_TEMPLATE(Code)

_configFilePath
protected String _configFilePath(Code)

_knownTokens
protected Collection _knownTokens(Code)

_requiredTokens
protected Collection _requiredTokens(Code)

Method Detail
getTemplateNameByRef
abstract public String getTemplateNameByRef(String refGroupName, String key)(Code)
Returns URL template name of the given type (by key) from the desired reference group.
Parameters:
  refGroupName - name of a group of templates from the config file.
Parameters:
  key - type of the template template name

getURLTemplate
abstract public URLTemplate getURLTemplate(String name)(Code)
Returns URL template given the name of the template.
Parameters:
  name - name of the template template

getURLTemplates
abstract public URLTemplate[] getURLTemplates()(Code)
Returns an array of the URL templates. the URL templates

getURLTemplatesFactory
public static URLTemplatesFactory getURLTemplatesFactory(ServletContext servletContext)(Code)
Gets the URLTemplatesFactory instance from a ServletContext attribute.
Parameters:
  servletContext - the current ServletContext. the URLTemplatesFactory instance from the ServletContext.

getURLTemplatesFactory
public static URLTemplatesFactory getURLTemplatesFactory(ServletRequest servletRequest)(Code)
Gets the URLTemplatesFactory instance from a ServletRequest attribute.
Parameters:
  servletRequest - the current ServletRequest. the URLTemplatesFactory instance from the ServletRequest.

initServletContext
public static void initServletContext(ServletContext servletContext, URLTemplatesFactory templatesFactory)(Code)
Adds a given URLTemplatesFactory instance as an attribute on the ServletContext.
Parameters:
  servletContext - the current ServletContext.
Parameters:
  templatesFactory - the URLTemplatesFactory instance to add as an attribute of the context

initServletRequest
public static void initServletRequest(ServletRequest servletRequest, URLTemplatesFactory templatesFactory)(Code)
Adds a given URLTemplatesFactory instance as an attribute on the ServletRequest.
Parameters:
  servletRequest - the current ServletRequest.
Parameters:
  templatesFactory - the URLTemplatesFactory instance to add as an attribute of the request

load
abstract public void load(ServletContext servletContext)(Code)
Initialization method that parses the URL template config file to get the URL templates and template reference groups.
Parameters:
  servletContext - the current ServletContext.

setConfigFilePath
public void setConfigFilePath(String configFilePath)(Code)
Allow clients to set their own URL template config file name/path.
Parameters:
  configFilePath - An absolute path from the web app root to the URL template config file.

setKnownTokens
public void setKnownTokens(Collection knownTokens)(Code)
Allow clients to define a set of known tokens for the template verification. Tokens are expected to be qualified in braces. E.g. {url:path}
The template verification will ensure the known tokens in the URL template conforms to a valid format.
Parameters:
  knownTokens - The set of known tokens for a valid template.

setRequiredTokens
public void setRequiredTokens(Collection requiredTokens)(Code)
Allow clients to define a set of required tokens for the template verification. Tokens are expected to be qualified in braces. E.g. {url:path}
The template verification will ensure the URL template conforms to a valid format for known tokens and contains the required tokens.

Parameters:
  requiredTokens - The set of required tokens in a valid template.

Methods inherited from org.apache.beehive.netui.core.factory.Factory
protected FactoryConfig getConfig()(Code)(Java Doc)
protected ServletContext getServletContext()(Code)(Java Doc)
protected void onCreate()(Code)(Java Doc)
protected void reinit(ServletContext servletContext)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.