Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> opencms >> [ core overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.opencms.core.CmsStaticExportProperties JAVADOC | Sourc code of com.opencms.core.CmsStaticExportProperties SOURCE | Download com.opencms.core.CmsStaticExportProperties DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.opencms.core
Class CmsStaticExportProperties  view CmsStaticExportProperties download CmsStaticExportProperties.java

java.lang.Object
  extended bycom.opencms.core.CmsStaticExportProperties
All Implemented Interfaces:
I_CmsConstants
public class CmsStaticExportProperties
extends java.lang.Object
implements I_CmsConstants

This class provides a special data structure to access the static export properties read from opencms.properties.

Version:
$Revision: 1.2 $ $Date: 2002/10/30 10:13:21 $

Field Summary
private static boolean c_exportDefaultTrue
          is export=true the default value for the resources property "export"
private static boolean c_exportRelativeLinks
          the link in the static export that link to pages that are exportet too are generated relative.
private static java.lang.String[] c_linkRulesExport
          the vectors to store the three different rulesets needed for the link replacement.
private static java.lang.String[] c_linkRulesExtern
           
private static java.lang.String[] c_linkRulesOffline
           
private static java.lang.String[] c_linkRulesOnline
           
private static java.lang.String c_linkRuleStart
          the start rule for the extern and the export rules
private static boolean c_staticExportEnabled
          Is the static export enabled or diabled
private static java.lang.String c_staticExportEnabledValue
          the value of the exportEnabled parameter.
private static java.lang.String c_staticExportPath
          The path to where the export will go
private static java.util.Vector c_staticExportStart
          The startpoints for the static export.
private static java.lang.String[] c_staticUrlPrefix
          contains the four url prefixe for the lnikreplacement.
 
Fields inherited from interface com.opencms.core.I_CmsConstants
C_ACCESS_DEFAULT_FLAGS, C_ACCESS_GROUP, C_ACCESS_GROUP_READ, C_ACCESS_GROUP_VISIBLE, C_ACCESS_GROUP_WRITE, C_ACCESS_INTERNAL_READ, C_ACCESS_OWNER, C_ACCESS_OWNER_READ, C_ACCESS_OWNER_VISIBLE, C_ACCESS_OWNER_WRITE, C_ACCESS_PUBLIC, C_ACCESS_PUBLIC_READ, C_ACCESS_PUBLIC_VISIBLE, C_ACCESS_PUBLIC_WRITE, C_ACCESS_READ, C_ACCESS_VISIBLE, C_ACCESS_WRITE, C_ADDITIONAL_INFO_EXPLORERSETTINGS, C_ADDITIONAL_INFO_PREFERENCES, C_ADDITIONAL_INFO_STARTSETTINGS, C_ADDITIONAL_INFO_TASKSETTINGS, C_ADDITIONAL_INFO_TOWN, C_ADDITIONAL_INFO_ZIPCODE, C_AT_LEAST_ONCE, C_CLUSTERURL, C_CONFIGURATION_CACHE, C_CONFIGURATION_CLASS, C_CONFIGURATION_REGISTRY, C_CONFIGURATION_RESOURCEBROKER, C_COPYRIGHT, C_DEFAULT_SITE, C_DELETE_HISTORY, C_ENABLE_HISTORY, C_ERRPREFIX, C_ERRSPERATOR, C_EXPORT_TAG_ACCESS, C_EXPORT_TAG_ADDRESS, C_EXPORT_TAG_CREATOR, C_EXPORT_TAG_DATE, C_EXPORT_TAG_DEFAULTGROUP, C_EXPORT_TAG_DESCRIPTION, C_EXPORT_TAG_DESTINATION, C_EXPORT_TAG_EMAIL, C_EXPORT_TAG_EXPORT, C_EXPORT_TAG_FILE, C_EXPORT_TAG_FIRSTNAME, C_EXPORT_TAG_FLAGS, C_EXPORT_TAG_GROUP, C_EXPORT_TAG_GROUPDATA, C_EXPORT_TAG_GROUPNAME, C_EXPORT_TAG_INFO, C_EXPORT_TAG_LASTMODIFIED, C_EXPORT_TAG_LASTNAME, C_EXPORT_TAG_LAUNCHER_START_CLASS, C_EXPORT_TAG_MODULEXPORT, C_EXPORT_TAG_NAME, C_EXPORT_TAG_OC_VERSION, C_EXPORT_TAG_PARENTGROUP, C_EXPORT_TAG_PASSWORD, C_EXPORT_TAG_PROJECT, C_EXPORT_TAG_PROPERTIES, C_EXPORT_TAG_PROPERTY, C_EXPORT_TAG_RECOVERYPASSWORD, C_EXPORT_TAG_SECTION, C_EXPORT_TAG_SOURCE, C_EXPORT_TAG_TYPE, C_EXPORT_TAG_USER, C_EXPORT_TAG_USERDATA, C_EXPORT_TAG_USERGROUPDATA, C_EXPORT_TAG_USERGROUPS, C_EXPORT_TAG_USERINFO, C_EXPORT_TAG_VALUE, C_EXPORT_TAG_VERSION, C_EXPORT_VERSION, C_EXPORT_XMLFILENAME, C_EXPORTONLYFILES, C_EXPORTONLYUSERS, C_EXPORTPOINT, C_EXPORTPOINT_PATH, C_EXPORTUSERSFILES, C_FCONTENT, C_FELEMENT, C_FILE, C_FILECONTENT, C_FILES_IMPORTED, C_FLAG_DISABLED, C_FLAG_ENABLED, C_FLAG_GROUP_PROJECTCOWORKER, C_FLAG_GROUP_PROJECTMANAGER, C_FLAG_GROUP_ROLE, C_FOLDER, C_FOLDER_SEPARATOR, C_GROUP, C_GROUP_ADMIN, C_GROUP_GUEST, C_GROUP_PROJECTLEADER, C_GROUP_USERS, C_LINKCHECKTABLE_DATE, C_MAX_LENGTH_RESOURCE_NAME, C_MODULE_PROPERTY_ADDITIONAL_RESOURCES, C_MODULE_PROPERTY_ADDITIONAL_RESOURCES_SEPARATOR, C_MODUS_AUTO, C_MODUS_EXPORT, C_MODUS_EXTERN, C_MODUS_OFFLINE, C_MODUS_ONLINE, C_MOUNTPOINT_FILESYSTEM, C_MOUNTPOINT_MYSQL, C_NEVER, C_NO_FILES_IMPORTED, C_ORDER_AGENTUSER, C_ORDER_ENDTIME, C_ORDER_ID, C_ORDER_INITIATORUSER, C_ORDER_NAME, C_ORDER_ORIGINALUSER, C_ORDER_PERCENTAGE, C_ORDER_PRIORITY, C_ORDER_ROLE, C_ORDER_STARTTIME, C_ORDER_STATE, C_ORDER_TASKTYPE, C_ORDER_TIMEOUT, C_ORDER_WAKEUPTIME, C_PASSWORD_MINIMUMSIZE, C_PROJECT_ONLINE, C_PROJECT_ONLINE_ID, C_PROJECT_STATE_ARCHIVE, C_PROJECT_STATE_INVISIBLE, C_PROJECT_STATE_LOCKED, C_PROJECT_STATE_UNLOCKED, C_PROJECT_TYPE_INVISIBLE, C_PROJECT_TYPE_NORMAL, C_PROJECT_TYPE_TEMPORARY, C_PROPERTY_ACTIV, C_PROPERTY_CHANNELID, C_PROPERTY_CONTENT_ENCODING, C_PROPERTY_DEFAULT_FILE, C_PROPERTY_DESCRIPTION, C_PROPERTY_EXPORT, C_PROPERTY_EXPORTNAME, C_PROPERTY_KEYWORDS, C_PROPERTY_NAVPOS, C_PROPERTY_NAVTEXT, C_PROPERTY_RELATIVEROOT, C_PROPERTY_TEMPLATETYPE, C_PROPERTY_TITLE, C_PROPERTY_VISIBLE, C_PUBLISH_METHOD_LINK, C_REGISTRY_DESTINATION, C_REGISTRY_HISTORY, C_REGISTRY_KNOWNLAUNCHERS, C_REGISTRY_LAUNCHER, C_REGISTRY_SOURCE, C_REQUEST_CONSOLE, C_REQUEST_HTTP, C_RESPONSE_CONSOLE, C_RESPONSE_HTTP, C_ROOT, C_ROOT_TEMPLATE_NAME, C_ROOTNAME_COS, C_ROOTNAME_VFS, C_SESSION_ADMIN_POS, C_SESSION_BROADCASTMESSAGE, C_SESSION_CONTENT_ENCODING, C_SESSION_CURRENTGROUP, C_SESSION_DATA, C_SESSION_IS_DIRTY, C_SESSION_MESSAGEPENDING, C_SESSION_MODULE_VECTOR, C_SESSION_PROJECT, C_SESSION_THREAD_ERROR, C_SESSION_USERNAME, C_SORT_ASC, C_SORT_DESC, C_START_ACCESSFLAGS, C_START_DEFAULTGROUP, C_START_LANGUAGE, C_START_LOCKDIALOG, C_START_PROJECT, C_START_VIEW, C_STATE_CHANGED, C_STATE_DELETED, C_STATE_NEW, C_STATE_UNCHANGED, C_STATICEXPORT_PATH, C_STATICEXPORT_START, C_SYNCHRONISATION_PATH, C_SYNCHRONISATION_PROJECT, C_SYNCHRONISATION_RESOURCE, C_SYNCHRONISATION_RESOURCETAG, C_SYSTEMPROPERTY_CRONTABLE, C_SYSTEMPROPERTY_EXPORTPATH, C_SYSTEMPROPERTY_EXTENSIONS, C_SYSTEMPROPERTY_LINKCHECKTABLE, C_SYSTEMPROPERTY_MIMETYPES, C_SYSTEMPROPERTY_MOUNTPOINT, C_SYSTEMPROPERTY_RESOURCE_TYPE, C_TABLE_CHANNELID, C_TASK_FILTER, C_TASK_MESSAGES, C_TASK_MESSAGES_ACCEPTED, C_TASK_MESSAGES_COMPLETED, C_TASK_MESSAGES_FORWARDED, C_TASK_MESSAGES_MEMBERS, C_TASK_ORDER_BY_DATE, C_TASK_ORDER_BY_NAME, C_TASK_PRIORITY_HIGH, C_TASK_PRIORITY_LOW, C_TASK_PRIORITY_NORMAL, C_TASK_STATE_ENDED, C_TASK_STATE_HALTED, C_TASK_STATE_NOTENDED, C_TASK_STATE_PREPARE, C_TASK_STATE_START, C_TASK_STATE_STARTED, C_TASK_VIEW_ALL, C_TASKLOG_SYSTEM, C_TASKLOG_USER, C_TASKORDER_NONE, C_TASKORDER_STARTDATE, C_TASKORDER_TIMEOUT, C_TASKS_ACTIVE, C_TASKS_ALL, C_TASKS_DONE, C_TASKS_NEW, C_TASKS_OPEN, C_TASKSORDER_TASKNAME, C_TEMP_PREFIX, C_TFACCESS, C_TFGROUP, C_TFILEOBJ, C_TFILES, C_TFNAME, C_TFPROPERTYINFO, C_TFPROPERTYNAME, C_TFPROPERTYTYPE, C_TFPROPERTYVALUE, C_TFTYPE, C_TFTYPENAME, C_TFUSER, C_TGDESC, C_TGFLAG, C_TGNAME, C_TGPARENTGROUP, C_TGROUPOBJ, C_TGROUPS, C_TGROUPUSERS, C_TGUSER, C_TUADDINFO, C_TUDESC, C_TUDGROUP, C_TUDISABLED, C_TUEMAIL, C_TUFIRSTNAME, C_TUFLAG, C_TUGROUP, C_TUINFOKEY, C_TUINFOVALUE, C_TULOGIN, C_TUNAME, C_TUPASSWD, C_TUSERGROUPS, C_TUSEROBJ, C_TUSERS, C_TYPE_BODY_NAME, C_TYPE_COMPATIBLEPLAIN_NAME, C_TYPE_FOLDER, C_TYPE_FOLDER_NAME, C_TYPE_IMAGE_NAME, C_TYPE_LAST_INDEX, C_TYPE_PAGE_NAME, C_TYPE_PLAIN_NAME, C_UNKNOWN_ID, C_UNKNOWN_INT, C_UNKNOWN_LAUNCHER, C_UNKNOWN_LAUNCHER_ID, C_UNKNOWN_LONG, C_URL_PREFIX_EXPORT, C_URL_PREFIX_HTTP, C_URL_PREFIX_HTTPS, C_URL_PREFIX_SERVERNAME, C_USER, C_USER_ADMIN, C_USER_GUEST, C_USER_TYPE_SYSTEMANDWEBUSER, C_USER_TYPE_SYSTEMUSER, C_USER_TYPE_WEBUSER, C_WEB_APP_REPLACE_KEY, C_WEEKS_HISTORY, C_WHATEVER, C_XML_BODY_ELEMENT
 
Constructor Summary
CmsStaticExportProperties()
          Constuctor.
 
Method Summary
 java.lang.String getExportPath()
          Returns the exportpath for the static export.
static java.lang.String[] getLinkRules(int state)
          Returns the ruleset for link replacement.
 java.util.Vector getStartPoints()
          Returns a Vector (of Strings) with the names of the vfs resources (files and folders) where the export should start.
 java.lang.String getStartRule()
          return the start rule used for export and extern mode.
 java.lang.String getStaticExportEnabledValue()
          Returns the value of the static export enable.
 java.lang.String[] getUrlPrefixArray()
          Gets the prefix array for the linkreplacement
 boolean isExportDefault()
          returns true if the default value for the resource property "export" is true.
 boolean isStaticExportEnabled()
          Returns true if the static export is enabled
 boolean relativLinksInExport()
          Returns true if the links in the static export should be relative.
 void setExportDefaultValue(java.lang.String value)
           
 void setExportPath(java.lang.String path)
           
 void setExportRelativeLinks(boolean relLinks)
           
 void setLinkRulesExport(java.lang.String[] rule)
           
 void setLinkRulesExtern(java.lang.String[] rule)
           
 void setLinkRulesOffline(java.lang.String[] rule)
           
 void setLinkRulesOnline(java.lang.String[] rule)
           
 void setStartPoints(java.util.Vector sp)
           
 void setStartRule(java.lang.String rule)
           
 void setStaticExportEnabled(boolean active)
           
 void setStaticExportEnabledValue(java.lang.String value)
           
 void setUrlPrefixArray(java.lang.String[] urls)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

c_exportRelativeLinks

private static boolean c_exportRelativeLinks
the link in the static export that link to pages that are exportet too are generated relative. This is only bugfree if the linkrules stay standard.

c_linkRulesExport

private static java.lang.String[] c_linkRulesExport
the vectors to store the three different rulesets needed for the link replacement. Each vector contains a ruleset. The elements are regular expressions (Strings) the way perl5 uses them.

c_linkRulesOnline

private static java.lang.String[] c_linkRulesOnline

c_linkRulesOffline

private static java.lang.String[] c_linkRulesOffline

c_linkRulesExtern

private static java.lang.String[] c_linkRulesExtern

c_linkRuleStart

private static java.lang.String c_linkRuleStart
the start rule for the extern and the export rules

c_staticExportEnabled

private static boolean c_staticExportEnabled
Is the static export enabled or diabled

c_exportDefaultTrue

private static boolean c_exportDefaultTrue
is export=true the default value for the resources property "export"

c_staticExportEnabledValue

private static java.lang.String c_staticExportEnabledValue
the value of the exportEnabled parameter.

c_staticExportPath

private static java.lang.String c_staticExportPath
The path to where the export will go

c_staticExportStart

private static java.util.Vector c_staticExportStart
The startpoints for the static export.

c_staticUrlPrefix

private static java.lang.String[] c_staticUrlPrefix
contains the four url prefixe for the lnikreplacement. That are the prefix for export, http, https and servername. The last two are used only wenn https is needed.

Constructor Detail

CmsStaticExportProperties

public CmsStaticExportProperties()
Constuctor.

Method Detail

getExportPath

public java.lang.String getExportPath()
Returns the exportpath for the static export.

getLinkRules

public static java.lang.String[] getLinkRules(int state)
Returns the ruleset for link replacement.

getStartPoints

public java.util.Vector getStartPoints()
Returns a Vector (of Strings) with the names of the vfs resources (files and folders) where the export should start.

getStartRule

public java.lang.String getStartRule()
return the start rule used for export and extern mode.

getStaticExportEnabledValue

public java.lang.String getStaticExportEnabledValue()
Returns the value of the static export enable. (needed for the false_ssl feature)

getUrlPrefixArray

public java.lang.String[] getUrlPrefixArray()
Gets the prefix array for the linkreplacement

isExportDefault

public boolean isExportDefault()
returns true if the default value for the resource property "export" is true.

isStaticExportEnabled

public boolean isStaticExportEnabled()
Returns true if the static export is enabled

relativLinksInExport

public boolean relativLinksInExport()
Returns true if the links in the static export should be relative.

setExportDefaultValue

public void setExportDefaultValue(java.lang.String value)

setExportPath

public void setExportPath(java.lang.String path)

setExportRelativeLinks

public void setExportRelativeLinks(boolean relLinks)

setLinkRulesExport

public void setLinkRulesExport(java.lang.String[] rule)

setLinkRulesOnline

public void setLinkRulesOnline(java.lang.String[] rule)

setLinkRulesOffline

public void setLinkRulesOffline(java.lang.String[] rule)

setLinkRulesExtern

public void setLinkRulesExtern(java.lang.String[] rule)

setStartPoints

public void setStartPoints(java.util.Vector sp)

setStartRule

public void setStartRule(java.lang.String rule)

setStaticExportEnabled

public void setStaticExportEnabled(boolean active)

setStaticExportEnabledValue

public void setStaticExportEnabledValue(java.lang.String value)

setUrlPrefixArray

public void setUrlPrefixArray(java.lang.String[] urls)
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> opencms >> [ core overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.opencms.core.CmsStaticExportProperties JAVADOC | Sourc code of com.opencms.core.CmsStaticExportProperties SOURCE | Download com.opencms.core.CmsStaticExportProperties DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD