org.apache.cocoon.components.source.impl
Class SitemapSourceInfo

java.lang.Object
  org.apache.cocoon.components.source.impl.SitemapSourceInfo

public final class SitemapSourceInfo

extends Object

This is a helper class for the cocoon protocol.

Version:

$Id: SitemapSourceInfo.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary

String	prefix The prefix of the URI in progress for cocoon:/ requests, or an empty string for cocoon:// requests.
boolean	processFromRoot Determine the initial processor for the cocoon protocol request.
String	protocol The protocol used in the sitemap URI, up to and excluding the colon.
String	queryString The query string of the sitemap URI.
boolean	rawMode true if the sitemap URI uses the raw: subprotocol, which means that request parameters of the original request are not forwarded, false otherwise.
String	requestURI The request URI, relative to the context.
String	systemId The system ID: <protocol><request-uri>[?<query-string>].
String	uri The sitemap URI without protocol identifier and query string.
String	view The Cocoon view used in the sitemap URI or null if no view is used.

Constructor Summary

SitemapSourceInfo()

Method Summary

static String	getView(String query, org.apache.cocoon.environment.Environment env)
static SitemapSourceInfo	parseURI(org.apache.cocoon.environment.Environment env, String sitemapURI)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rawMode

public boolean rawMode

• true if the sitemap URI uses the raw: subprotocol, which means that request parameters of the original request are not forwarded,
• false otherwise.

protocol

public String protocol

The protocol used in the sitemap URI, up to and excluding the colon.

requestURI

public String requestURI

The request URI, relative to the context.

systemId

public String systemId

The system ID: <protocol><request-uri>[?<query-string>].

view

public String view

The Cocoon view used in the sitemap URI or null if no view is used.

prefix

public String prefix

The prefix of the URI in progress for cocoon:/ requests, or an empty string for cocoon:// requests.

queryString

public String queryString

The query string of the sitemap URI.

uri

public String uri

The sitemap URI without protocol identifier and query string.

processFromRoot

public boolean processFromRoot

Determine the initial processor for the cocoon protocol request.

• true - start in the root sitemap (cocoon://)
• false - start in the current sitemap (cocoon:/)

Constructor Detail

SitemapSourceInfo

public SitemapSourceInfo()

Method Detail

parseURI

public static SitemapSourceInfo parseURI(org.apache.cocoon.environment.Environment env,
                                         String sitemapURI)
                                  throws MalformedURLException

Throws:

MalformedURLException

getView

public static String getView(String query,
                             org.apache.cocoon.environment.Environment env)