Java Doc for BaseURI.java in » Web-Framework » TURBINE » org » apache » turbine » util » uri » 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 » Web Framework » TURBINE » org.apache.turbine.util.uri

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.apache.turbine.util.uri .BaseURI

All known Subclasses:   org.apache.turbine.util.uri .DataURI,  org.apache.turbine.util.uri .TurbineURI,
BaseURI
abstract public class BaseURI implements URI,URIConstants(Code)
This is the base class for all dynamic URIs in the Turbine System. All of the classes used for generating URIs are derived from this.
author:
   Jon S. Stevens
author:
   Jason van Zyl
author:
   Henning P. Schmiedehausen
author:
   Quinton McCombs
version:
   $Id: BaseURI.java 534527 2007-05-02 16:10:59Z tv $

Constructor Summary
public BaseURI()
     Empty C'tor.
public BaseURI(RunData runData)

public BaseURI(RunData runData, boolean redirect)

public BaseURI(ServerData serverData)

public BaseURI(ServerData serverData, boolean redirect)


Method Summary
protected String encodeResponse(String uri)
     Encodes a Response Uri according to the Servlet Container.
protected void getContextAndScript(StringBuffer sb)
     Append the Context Path and Script Name to the passed String Buffer.
public String getContextPath()
     Gets the context path.
public String getReference()
     Returns the current reference anchor.
protected HttpServletResponse getResponse()
     Returns the Response Object from the Servlet Container.
protected void getSchemeAndPort(StringBuffer sb)
     Appends Scheme, Server and optionally the port to the supplied String Buffer.
public String getScriptName()
     Gets the script name (/servlets/Turbine).
public String getServerName()
     Gets the server name.
public int getServerPort()
     Gets the server port.
public String getServerScheme()

public boolean hasReference()

public boolean isRedirect()

public void setContextPath(String contextPath)
     Sets the context path.
public void setRedirect(boolean redirect)

public void setReference(String reference)
     Sets a reference anchor (#ref).
protected void setResponse(HttpServletResponse response)
     Set a Response Object to use when creating the response string.
public void setScriptName(String scriptName)
     Sets the script name (/servlets/Turbine).
public void setSecure()
     Method to specify that a URI should use SSL.
public void setSecure(int port)
     Method to specify that a URI should use SSL. Whether or not it does is determined from Turbine.properties. If use.ssl in the Turbine.properties is set to false, then http is used in any case.
public void setServerName(String serverName)
     Sets the server name.
public void setServerPort(int serverPort)
     Sets the server port.
public void setServerScheme(String serverScheme)
     Sets the scheme (HTTP or HTTPS).

Constructor Detail
BaseURI
public BaseURI()(Code)
Empty C'tor. Uses Turbine.getDefaultServerData().

BaseURI
public BaseURI(RunData runData)(Code)
Constructor with a RunData object
Parameters:
  runData - A RunData object

BaseURI
public BaseURI(RunData runData, boolean redirect)(Code)
Constructor, set explicit redirection
Parameters:
  runData - A RunData object
Parameters:
  redirect - True if redirection allowed.

BaseURI
public BaseURI(ServerData serverData)(Code)
Constructor with a ServerData object
Parameters:
  serverData - A ServerData object

BaseURI
public BaseURI(ServerData serverData, boolean redirect)(Code)
Constructor, set explicit redirection
Parameters:
  serverData - A ServerData object
Parameters:
  redirect - True if redirection allowed.

Method Detail
encodeResponse
protected String encodeResponse(String uri)(Code)
Encodes a Response Uri according to the Servlet Container. This might add a Java session identifier or do redirection. The resulting String can be used in a page or template.
Parameters:
  uri - The Uri to encode An Uri encoded by the container.

getContextAndScript
protected void getContextAndScript(StringBuffer sb)(Code)
Append the Context Path and Script Name to the passed String Buffer.
This is a convenience method to be used in the Link output routines of derived classes to easily append the correct path.
Parameters:
  sb - The StringBuffer to store context path and script name.

getContextPath
public String getContextPath()(Code)
Gets the context path. A String with the context path.

getReference
public String getReference()(Code)
Returns the current reference anchor. A String containing the reference.

getResponse
protected HttpServletResponse getResponse()(Code)
Returns the Response Object from the Servlet Container. The Servlet Response object or null

getSchemeAndPort
protected void getSchemeAndPort(StringBuffer sb)(Code)
Appends Scheme, Server and optionally the port to the supplied String Buffer.
This is a convenience method to be used in the Link output routines of derived classes to easily append the correct server scheme.
Parameters:
  sb - The StringBuffer to store the scheme and port information.

getScriptName
public String getScriptName()(Code)
Gets the script name (/servlets/Turbine). A String with the script name.

getServerName
public String getServerName()(Code)
Gets the server name. A String with the server name.

getServerPort
public int getServerPort()(Code)
Gets the server port. A String with the server port.

getServerScheme
public String getServerScheme()(Code)
Returns the current Server Scheme The current Server scheme

hasReference
public boolean hasReference()(Code)
Does this URI contain an anchor? (#ref) True if this URI contains an anchor.

isRedirect
public boolean isRedirect()(Code)
Returns the current value of the Redirect flag True if Redirect is allowed

setContextPath
public void setContextPath(String contextPath)(Code)
Sets the context path.
Parameters:
  contextPath - A String with the context path

setRedirect
public void setRedirect(boolean redirect)(Code)
Set the redirect Flag
Parameters:
  redirect - The new value of the redirect flag.

setReference
public void setReference(String reference)(Code)
Sets a reference anchor (#ref).
Parameters:
  reference - A String containing the reference.

setResponse
protected void setResponse(HttpServletResponse response)(Code)
Set a Response Object to use when creating the response string.

setScriptName
public void setScriptName(String scriptName)(Code)
Sets the script name (/servlets/Turbine).
Parameters:
  scriptName - A String with the script name.

setSecure
public void setSecure()(Code)
Method to specify that a URI should use SSL. The default port is used.

setSecure
public void setSecure(int port)(Code)
Method to specify that a URI should use SSL. Whether or not it does is determined from Turbine.properties. If use.ssl in the Turbine.properties is set to false, then http is used in any case. (Default of use.ssl is true).
Parameters:
  port - An int with the port number.

setServerName
public void setServerName(String serverName)(Code)
Sets the server name.
Parameters:
  serverName - A String with the server name.

setServerPort
public void setServerPort(int serverPort)(Code)
Sets the server port.
Parameters:
  serverPort - An int with the port.

setServerScheme
public void setServerScheme(String serverScheme)(Code)
Sets the scheme (HTTP or HTTPS).
Parameters:
  serverScheme - A String with the scheme.

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.