public class SitemapTools extends GenericService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
static java.lang.String |
FILE_SEPARATOR |
static java.lang.String |
SITEINDEX_FOOTER |
static java.lang.String |
SITEINDEX_HEADER |
static java.lang.String |
SITEMAP_FOOTER |
static java.lang.String |
SITEMAP_HEADER |
static java.lang.String |
SLASH |
static char |
SLASH_CHAR |
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
SitemapTools() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
addPrefixToUrl(java.lang.String pUrlPrefix,
java.lang.String pUrl)
Adds specified URL prefix to URL.
|
static void |
addPrefixToUrl(java.lang.String pUrlPrefix,
java.lang.StringBuilder pUrl)
Adds specified URL prefix to URL.
|
void |
addSitemapEntry(java.lang.StringBuilder pStringBuilder,
java.lang.String pSitemapUrl,
boolean pDebugMode)
Generates and apppends sitemap entry of view:
|
void |
appendSiteindexFooter(java.lang.StringBuilder pSiteindexXML)
Appends siteindex footer to
pSiteindexXML |
void |
appendSiteindexHeader(java.lang.StringBuilder pSiteindexXML)
Appends siteindex header to
pSiteindexXML |
void |
appendSitemapFooter(java.lang.StringBuilder pSitemapXML)
Appends sitemap footer to
pSitemapXML |
void |
appendSitemapHeader(java.lang.StringBuilder pSitemapXML)
Appends sitemap header to
pSitemapXML |
void |
deleteAllItems(RepositoryItemDescriptor pDesc)
Deletes all items which repository item descriptor is
pDesc . |
void |
deleteSiteindexItems()
Deletes all siteindex repository items from repository
|
void |
deleteSitemapItems()
Deletes all sitemap repository items from repository
|
static java.lang.String |
encodeURLParameter(java.lang.String pParameter)
Encodes the given text to UTF-8 so that it can be added to a URL.
|
static java.lang.String |
escapeURL(java.lang.String pURL)
Replaces the following characters in the URL string with their entity escape codes:
&,',",<,>.
|
static java.lang.String |
formatWarDir(java.lang.String pWarDir)
Returns formatted path to WarDir using '/' as file separator and not ended
with file separator.
|
java.lang.String |
generateSitemapUrlXml(java.lang.String pUrl,
java.lang.String pFrequency,
java.lang.String pPriority,
boolean pDebugMode)
Generates sitemap URL XML for a given repository item:
|
java.lang.String |
generateSitemapUrlXml(java.lang.String pUrl,
java.lang.String pLastMod,
java.lang.String pFrequency,
java.lang.String pPriority,
boolean pDebugMode)
Generates sitemap URL XML for a given repository item:
|
SitemapPropertiesManager |
getSitemapPropertiesManager() |
MutableRepository |
getSitemapRepository() |
RepositoryItem[] |
lookupAllItems(RepositoryItemDescriptor pDesc)
Returns an array of repository items which repository item descriptor is
pDesc . |
RepositoryItem[] |
lookupSiteindexItems()
Returns an array of siteindex repository items.
|
RepositoryItem[] |
lookupSitemapItems()
Returns an array of sitemap repository items.
|
void |
setSitemapPropertiesManager(SitemapPropertiesManager pSitemapPropertiesManager) |
void |
setSitemapRepository(MutableRepository pSitemapRepository) |
boolean |
validateSitemapSize(java.lang.String pStaticUrlXml,
java.lang.StringBuilder pStringBuilder,
int pMaxSitemapSize)
Checks if static URL can be added to sitemap so that maximum allowed file size
will not be exceeded.
|
void |
writeSiteindex(java.lang.StringBuilder pSiteindexXML,
java.lang.String pFilename)
Writes siteindex to SitemapRepository
|
void |
writeSitemap(java.lang.StringBuilder pSitemapXML,
java.lang.String pFilename)
Writes sitemap to SitemapRepository
|
void |
writeSitemap(java.lang.StringBuilder pSitemapXML,
java.lang.String pFilenamePrefix,
int sitemapCount)
Writes sitemap to SitemapRepository.
|
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final java.lang.String SITEMAP_HEADER
public static final java.lang.String SITEMAP_FOOTER
public static final java.lang.String SITEINDEX_HEADER
public static final java.lang.String SITEINDEX_FOOTER
public static final java.lang.String FILE_SEPARATOR
public static java.lang.String SLASH
public static char SLASH_CHAR
public MutableRepository getSitemapRepository()
public void setSitemapRepository(MutableRepository pSitemapRepository)
SitemapRepository
- Sitemap repositorypublic SitemapPropertiesManager getSitemapPropertiesManager()
public void setSitemapPropertiesManager(SitemapPropertiesManager pSitemapPropertiesManager)
SitemapPropertiesManager
- Sitemap repository props managerpublic RepositoryItem[] lookupSiteindexItems() throws RepositoryException
RepositoryException
- if repository exception occurspublic RepositoryItem[] lookupSitemapItems() throws RepositoryException
RepositoryException
- if repository exception occurspublic void deleteSitemapItems() throws RepositoryException
RepositoryException
- if repository exception occurspublic void deleteSiteindexItems() throws RepositoryException
RepositoryException
- if repository exception occurspublic RepositoryItem[] lookupAllItems(RepositoryItemDescriptor pDesc) throws RepositoryException
pDesc
.pDesc
- repository item descriptorRepositoryException
- if repository exception occurspublic void deleteAllItems(RepositoryItemDescriptor pDesc) throws RepositoryException
pDesc
.pDesc
- repository item descriptorRepositoryException
- if repository exception occurspublic void appendSiteindexFooter(java.lang.StringBuilder pSiteindexXML)
pSiteindexXML
pSiteindexXML
- String builder with siteindex XMLpublic void appendSiteindexHeader(java.lang.StringBuilder pSiteindexXML)
pSiteindexXML
pSiteindexXML
- String builder with siteindex XMLpublic void appendSitemapFooter(java.lang.StringBuilder pSitemapXML)
pSitemapXML
pSitemapXML
- String builder with sitemap XMLpublic void appendSitemapHeader(java.lang.StringBuilder pSitemapXML)
pSitemapXML
pSitemapXML
- String builder with sitemap XMLpublic void writeSitemap(java.lang.StringBuilder pSitemapXML, java.lang.String pFilename)
pSitemapXML
- XML with siteindex informationpFilename
- sitemap filenamepublic void writeSitemap(java.lang.StringBuilder pSitemapXML, java.lang.String pFilenamePrefix, int sitemapCount)
pSitemapXML
- XML with siteindex informationpFilename
- sitemap filenamepublic void writeSiteindex(java.lang.StringBuilder pSiteindexXML, java.lang.String pFilename)
pSiteindexXML
- XML with siteindex informationpFilename
- siteindex filenamepublic void addSitemapEntry(java.lang.StringBuilder pStringBuilder, java.lang.String pSitemapUrl, boolean pDebugMode)
<sitemap> <loc>http://www.example.com/sitemap1.xml</loc> </sitemap>
pStringBuilder
- string builder to append sitemap entrypSitemapUrl
- fully specified sitemap URLpDebugMode
- whether debug mode or notpublic java.lang.String generateSitemapUrlXml(java.lang.String pUrl, java.lang.String pFrequency, java.lang.String pPriority, boolean pDebugMode)
<url> <loc>http://www.example.com/</loc> <changefreq>monthly</changefreq> <priority>0.8</priority> </url>
pUrl
- URL to pagepFrequency
- change frequencypPriority
- prioritypDebugMode
- whether debug mode or notpublic java.lang.String generateSitemapUrlXml(java.lang.String pUrl, java.lang.String pLastMod, java.lang.String pFrequency, java.lang.String pPriority, boolean pDebugMode)
<url> <loc>http://www.example.com/</loc> <lastmod>05/29/2015</lastmod> <changefreq>monthly</changefreq> <priority>0.8</priority> </url>
pUrl
- URL to pagelastmod
- last modifiedpFrequency
- change frequencypPriority
- prioritypDebugMode
- whether debug mode or notpublic boolean validateSitemapSize(java.lang.String pStaticUrlXml, java.lang.StringBuilder pStringBuilder, int pMaxSitemapSize)
pStaticUrlXml
- - static URL XML that is going to be added next to sitemappStringBuilder
- - StringBuidler that contains XML string with sitemap for static pagespublic static java.lang.String addPrefixToUrl(java.lang.String pUrlPrefix, java.lang.String pUrl)
pUrlPrefix
- - URL prefix to addpUrl
- - URL to be prepended with prefixpublic static void addPrefixToUrl(java.lang.String pUrlPrefix, java.lang.StringBuilder pUrl)
pUrlPrefix
- - URL prefix to addpUrl
- - StringBuilder with URL where URL prefix should be addedpublic static java.lang.String formatWarDir(java.lang.String pWarDir)
public static java.lang.String encodeURLParameter(java.lang.String pParameter)
pText
- The String object containing the text to be encoded.public static java.lang.String escapeURL(java.lang.String pURL)
pURL
- URL to be escaped