de.uplanet.lucy.server.portalserver

Class PortalServerPath

java.lang.Object

de.uplanet.lucy.server.portalserver.PortalServerPath

@Scriptable
public final class PortalServerPath
extends Object

PortalServerPath for the portal server.

Version:

$Revision: 140619 $

Field Summary

Fields

Modifier and Type	Field and Description
static int	APP_DIR directory for application stuff
static int	APP_GROOVY_DIR directory for application resources
static int	APP_RESOURCE_DIR directory for application resources
static int	APP_STORE_DIR directory for application structure descriptions
static int	APP_TEMPLATE_DIR application templates directory
static int	APP_TEST_DIR directory for application tests
static int	APP_VM_DIR directory for vm stuff
static int	APP_WORKING_STORE_DIR directory for the save only application store
static int	APP_XSL_DIR directory for application xsls for transforming
static int	AUTHMODULE_PROPS_FILE company server authentication properties
static int	BIACFG_DIR Business Integration Adapter configuration directory
static int	BPEE_DIR bpee directory
static int	CALLABLES_CONFIGURATION_DIR callables configuration directory
static int	CFG_DIR company server configuration directory
static int	DATASTORE_CFG_FILE file for datastore configuration
static int	DATATRANSFER_CFG_DIR data transfer dir
static int	DEFAULT_LAYOUT_DIR the default layout directory
static int	ERROR_HANDLER error handler
static int	ERROR_HANDLER_CUSTOM custom error handler
static int	EXTERNAL_DIR company server external directory
static int	FILE_STORAGE_DIR file storage directory
static int	FILEADAPTER_CFG_DIR company filestorage file
static int	FILESTORAGE_CFG_FILE company filestorage file
static int	HTML_ROOT_DIR html root directory
static int	HTML_TMP_DIR external temp-directory
static int	HTMLEDITOR_CFG_DIR htmleditor dir
static int	HTMLROOT_CSS_DIR external directory for css files
static int	HTMLROOT_DOWNLOAD_FILES_DIR directory for user files
static int	HTMLROOT_IMAGES_DIR directory for storing application specific images
static int	HTMLROOT_INCLUDE_DIR directory for application specific includes
static int	HTMLROOT_USER_FILES_DIR directory for user files
static int	HYPARCHIVE_CFG_DIR The dg hyparchive cfg dir.
static int	INTERNAL_DIR company server internal directory
static int	JDBC_DIR jdbc replication profile directory
static int	LAYOUT_DIR directory for layout stuff
static int	LAYOUT_VM_DIR directory for layout vms
static int	LAYOUT_XML_DIR directory for layout xml files
static int	LAYOUT_XML_LAYOUTS_DIR directory for stored layouts
static int	LAYOUT_XSL_DIR directory for layout xsl files
static int	LDAP_DIR ldap replication profile directory
static int	LICENSE_CFG_FILE file for license configuration
static int	LOCALES_CFG_DIR The locales cfg dir.
static int	LOG_DIR log dir
static int	LUCENE_CFG_DIR lucene directory
static int	LUCENE_DIR lucene directory
static int	LUCENE_INDEXES_DATAGROUPS_DIR lucene indexes directory
static int	LUCENE_INDEXES_DIR lucene indexes directory
static int	LUCENE_INDEXES_FILEWALKER_DIR lucene indexes directory
static int	LUCY_HOME_DIR server installation root directory, also known as lucy home
static int	LUCYAUTH_CFG_FILE company server login configuration file
static int	MAIL_BADMAIL_DIR Deprecated.
static int	MAIL_CFG_FILE The mail configuration file.
static int	MAIL_PICKUP_DIR Deprecated.
static int	MAIL_QUEUE_DIR Deprecated.
static int	MAIL_ROOT_DIR mail root directory
static int	MAIL_TMP_DIR Deprecated.
static int	MFILES_CFG_DIR The M-Files cfg dir.
static int	MIMEMAP_CUSTOM_FILE the custom mimemap file
static int	MIMEMAP_FILE the mimemap file
static int	MSEXCHANGE_CFG_DIR The MS Exchange cfg dir.
static int	NEWS_REGISTRY_FILE The news registry file
static int	ODATA_CFG_DIR The odata cfg dir.
static int	ODATA_PRODUCER_CFG_DIR The odata producer cfg dir.
static int	OM_CFG_FILE organization manager configuration file
static int	PORTAL_CFG_FILE company server configuration file
static int	PORTAL_PAGE_DIR The directory for portal pages (internal/layout/vm/html/portal).
static int	PORTAL_PAGE_TEMPLATE_DIR The template directory for portal pages (internal/layout/vm/html/portal/templates).
static int	PORTAL_PAGEINIT_DIR template directory for new main portals
static int	QUARTZ_PROPS_FILE quartz scheduler configuration file
static int	REGISTRY_DIR The registry directory for the register able classes (like controls, renderer, validatoren...)
static int	RELATIONSHIP_DIR The relationship model directory (internal/relationship).
static int	RENDERER_TYPE_REGISTRY_FILE The renderer type registry file
static int	REPLICATION_CFG_FILE replication configuration file
static int	REPLICATION_PROFILES_DIR replication profile directory
static int	REQUEST_VALIDATOR_REGISTRY_CUSTOM_FILE The request validator registry file
static int	REQUEST_VALIDATOR_REGISTRY_FILE The request validator registry file
static int	ROOT_DIR company server root directory
static int	SERVER_CFG_DIR server installation configuration directory
static int	SHARE_CFG_DIR The share cfg dir.
static int	SOAP_DEPLOYMENT_FILE SOAP deployment information for a company server connector
static int	SPRING_APP_CONTEXT_CFG_DIR Spring application context configuration file
static int	START_PARAM_FILE file for default start parameters of services
static int	SYSTEM_DIR directory for system stuff
static int	SYSTEM_VM_DIR directory for system vm stuff
static int	SYSTEM_XML_DIR directory for system xml stuff
static int	SYSTEM_XSL_DIR directory for system xsl stuff
static int	TINYMCE_CFG_DIR tinymce dir
static int	TMP_DIR The directory for temporary files (internal/tmp).
static String	UP_JAVA_CMD java executable file
static String	UP_JAVA_DIR java home directory
static int	UPLOAD_DIR upload directory
static int	USER_IMAGE_DIR company user image dir
static int	VALIDATOR_REGISTRY_FILE The validator registry file
static int	VELOCITY_CFG_FILE velocity configuration file
static int	WEB_SERVICE_AXIS2_CONF_DIR web service axis2 conf directory
static int	WEB_SERVICE_AXIS2_DIR web service axis2 directory
static int	WEB_SERVICE_AXIS2_REPO_DIR web service axis2 repository directory
static int	WEB_SERVICE_AXIS2_SERVICES_DIR web service axis2 reporsitory services directory
static int	WEB_SERVICE_DIR The Web service directory (internal/webservice).
static int	WEB_SERVICE_PROVIDER_DIR web service provider directory
static int	WORKFLOW_DIR The workflow directory (internal/workflow).
static int	WSCALL_REGISTRY_DIR The Web service call registry directory (internal/webservice/wscall-registry).
static int	WSDL_REGISTRY_DIR The WSDL registry directory (internal/webservice/wsdl-registry).

Method Summary

Modifier and Type	Method and Description
static File	get(int p_iItem) Get a subpath beginning with the specified file or directory.
static File	get(int p_iItem, String... p_subPaths) Get a subpath beginning with the specified file or directory.
static File	getNoCheck(int p_iItem, String... p_subPaths) Get a subpath beginning with the specified file or directory.
static Path	getPath(int p_iItem, String... p_subPaths) Get a subpath beginning with the specified file or directory.
static Path	getPathNoCheck(int p_iItem, String... p_subPaths) Get a subpath beginning with the specified file or directory.
static void	reset() Reset the PortalServerPath.

Methods inherited from class java.lang.Object

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

Field Detail

UP_JAVA_DIR

@SystemProperty
public static final String UP_JAVA_DIR

java home directory

See Also:

Constant Field Values

UP_JAVA_CMD

@SystemProperty
public static final String UP_JAVA_CMD

java executable file

See Also:

Constant Field Values

LUCY_HOME_DIR

public static final int LUCY_HOME_DIR

server installation root directory, also known as lucy home

SERVER_CFG_DIR

public static final int SERVER_CFG_DIR

server installation configuration directory

LICENSE_CFG_FILE

public static final int LICENSE_CFG_FILE

file for license configuration

DATASTORE_CFG_FILE

public static final int DATASTORE_CFG_FILE

file for datastore configuration

START_PARAM_FILE

public static final int START_PARAM_FILE

file for default start parameters of services

ROOT_DIR

public static final int ROOT_DIR

company server root directory

INTERNAL_DIR

public static final int INTERNAL_DIR

company server internal directory

EXTERNAL_DIR

public static final int EXTERNAL_DIR

company server external directory

USER_IMAGE_DIR

public static final int USER_IMAGE_DIR

company user image dir

CFG_DIR

public static final int CFG_DIR

company server configuration directory

PORTAL_CFG_FILE

public static final int PORTAL_CFG_FILE

company server configuration file

FILEADAPTER_CFG_DIR

public static final int FILEADAPTER_CFG_DIR

company filestorage file

FILESTORAGE_CFG_FILE

public static final int FILESTORAGE_CFG_FILE

company filestorage file

MIMEMAP_FILE

public static final int MIMEMAP_FILE

the mimemap file

MIMEMAP_CUSTOM_FILE

public static final int MIMEMAP_CUSTOM_FILE

the custom mimemap file

LUCYAUTH_CFG_FILE

public static final int LUCYAUTH_CFG_FILE

company server login configuration file

AUTHMODULE_PROPS_FILE

public static final int AUTHMODULE_PROPS_FILE

company server authentication properties

OM_CFG_FILE

public static final int OM_CFG_FILE

organization manager configuration file

REPLICATION_CFG_FILE

public static final int REPLICATION_CFG_FILE

replication configuration file

REPLICATION_PROFILES_DIR

public static final int REPLICATION_PROFILES_DIR

replication profile directory

LDAP_DIR

public static final int LDAP_DIR

ldap replication profile directory

JDBC_DIR

public static final int JDBC_DIR

jdbc replication profile directory

VELOCITY_CFG_FILE

public static final int VELOCITY_CFG_FILE

velocity configuration file

MAIL_CFG_FILE

public static final int MAIL_CFG_FILE

The mail configuration file.

QUARTZ_PROPS_FILE

public static final int QUARTZ_PROPS_FILE

quartz scheduler configuration file

CALLABLES_CONFIGURATION_DIR

public static final int CALLABLES_CONFIGURATION_DIR

callables configuration directory

SOAP_DEPLOYMENT_FILE

public static final int SOAP_DEPLOYMENT_FILE

SOAP deployment information for a company server connector

SPRING_APP_CONTEXT_CFG_DIR

public static final int SPRING_APP_CONTEXT_CFG_DIR

Spring application context configuration file

BIACFG_DIR

public static final int BIACFG_DIR

Business Integration Adapter configuration directory

DATATRANSFER_CFG_DIR

public static final int DATATRANSFER_CFG_DIR

data transfer dir

HTMLEDITOR_CFG_DIR

public static final int HTMLEDITOR_CFG_DIR

htmleditor dir

TINYMCE_CFG_DIR

public static final int TINYMCE_CFG_DIR

tinymce dir

MSEXCHANGE_CFG_DIR

public static final int MSEXCHANGE_CFG_DIR

The MS Exchange cfg dir.

ODATA_CFG_DIR

public static final int ODATA_CFG_DIR

The odata cfg dir.

ODATA_PRODUCER_CFG_DIR

public static final int ODATA_PRODUCER_CFG_DIR

The odata producer cfg dir.

MFILES_CFG_DIR

public static final int MFILES_CFG_DIR

The M-Files cfg dir.

HYPARCHIVE_CFG_DIR

public static final int HYPARCHIVE_CFG_DIR

The dg hyparchive cfg dir.

SHARE_CFG_DIR

public static final int SHARE_CFG_DIR

The share cfg dir.

LOCALES_CFG_DIR

public static final int LOCALES_CFG_DIR

The locales cfg dir.

REGISTRY_DIR

public static final int REGISTRY_DIR

The registry directory for the register able classes (like controls, renderer, validatoren...)

RENDERER_TYPE_REGISTRY_FILE

public static final int RENDERER_TYPE_REGISTRY_FILE

The renderer type registry file

VALIDATOR_REGISTRY_FILE

public static final int VALIDATOR_REGISTRY_FILE

The validator registry file

REQUEST_VALIDATOR_REGISTRY_FILE

public static final int REQUEST_VALIDATOR_REGISTRY_FILE

The request validator registry file

REQUEST_VALIDATOR_REGISTRY_CUSTOM_FILE

public static final int REQUEST_VALIDATOR_REGISTRY_CUSTOM_FILE

The request validator registry file

NEWS_REGISTRY_FILE

public static final int NEWS_REGISTRY_FILE

The news registry file

HTML_ROOT_DIR

public static final int HTML_ROOT_DIR

html root directory

HTML_TMP_DIR

public static final int HTML_TMP_DIR

external temp-directory

FILE_STORAGE_DIR

public static final int FILE_STORAGE_DIR

file storage directory

UPLOAD_DIR

public static final int UPLOAD_DIR

upload directory

HTMLROOT_CSS_DIR

public static final int HTMLROOT_CSS_DIR

external directory for css files

HTMLROOT_IMAGES_DIR

public static final int HTMLROOT_IMAGES_DIR

directory for storing application specific images

HTMLROOT_INCLUDE_DIR

public static final int HTMLROOT_INCLUDE_DIR

directory for application specific includes

HTMLROOT_USER_FILES_DIR

public static final int HTMLROOT_USER_FILES_DIR

directory for user files

HTMLROOT_DOWNLOAD_FILES_DIR

public static final int HTMLROOT_DOWNLOAD_FILES_DIR

directory for user files

LAYOUT_DIR

public static final int LAYOUT_DIR

directory for layout stuff

LAYOUT_XML_DIR

public static final int LAYOUT_XML_DIR

directory for layout xml files

LAYOUT_XSL_DIR

public static final int LAYOUT_XSL_DIR

directory for layout xsl files

LAYOUT_XML_LAYOUTS_DIR

public static final int LAYOUT_XML_LAYOUTS_DIR

directory for stored layouts

DEFAULT_LAYOUT_DIR

public static final int DEFAULT_LAYOUT_DIR

the default layout directory

LAYOUT_VM_DIR

public static final int LAYOUT_VM_DIR

directory for layout vms

LUCENE_DIR

public static final int LUCENE_DIR

lucene directory

LUCENE_CFG_DIR

public static final int LUCENE_CFG_DIR

lucene directory

LUCENE_INDEXES_DIR

public static final int LUCENE_INDEXES_DIR

lucene indexes directory

LUCENE_INDEXES_FILEWALKER_DIR

public static final int LUCENE_INDEXES_FILEWALKER_DIR

lucene indexes directory

LUCENE_INDEXES_DATAGROUPS_DIR

public static final int LUCENE_INDEXES_DATAGROUPS_DIR

lucene indexes directory

BPEE_DIR

public static final int BPEE_DIR

bpee directory

WEB_SERVICE_DIR

public static final int WEB_SERVICE_DIR

The Web service directory (internal/webservice).

WORKFLOW_DIR

public static final int WORKFLOW_DIR

The workflow directory (internal/workflow).

RELATIONSHIP_DIR

public static final int RELATIONSHIP_DIR

The relationship model directory (internal/relationship).

WEB_SERVICE_PROVIDER_DIR

public static final int WEB_SERVICE_PROVIDER_DIR

web service provider directory

WEB_SERVICE_AXIS2_DIR

public static final int WEB_SERVICE_AXIS2_DIR

web service axis2 directory

WEB_SERVICE_AXIS2_CONF_DIR

public static final int WEB_SERVICE_AXIS2_CONF_DIR

web service axis2 conf directory

WEB_SERVICE_AXIS2_REPO_DIR

public static final int WEB_SERVICE_AXIS2_REPO_DIR

web service axis2 repository directory

WEB_SERVICE_AXIS2_SERVICES_DIR

public static final int WEB_SERVICE_AXIS2_SERVICES_DIR

web service axis2 reporsitory services directory

WSDL_REGISTRY_DIR

public static final int WSDL_REGISTRY_DIR

The WSDL registry directory (internal/webservice/wsdl-registry).

WSCALL_REGISTRY_DIR

public static final int WSCALL_REGISTRY_DIR

The Web service call registry directory (internal/webservice/wscall-registry).

TMP_DIR

public static final int TMP_DIR

The directory for temporary files (internal/tmp).

PORTAL_PAGE_DIR

public static final int PORTAL_PAGE_DIR

The directory for portal pages (internal/layout/vm/html/portal).

PORTAL_PAGE_TEMPLATE_DIR

public static final int PORTAL_PAGE_TEMPLATE_DIR

The template directory for portal pages (internal/layout/vm/html/portal/templates).

PORTAL_PAGEINIT_DIR

public static final int PORTAL_PAGEINIT_DIR

template directory for new main portals

APP_DIR

public static final int APP_DIR

directory for application stuff

APP_TEMPLATE_DIR

public static final int APP_TEMPLATE_DIR

application templates directory

APP_STORE_DIR

public static final int APP_STORE_DIR

directory for application structure descriptions

APP_WORKING_STORE_DIR

public static final int APP_WORKING_STORE_DIR

directory for the save only application store

APP_RESOURCE_DIR

public static final int APP_RESOURCE_DIR

directory for application resources

APP_GROOVY_DIR

public static final int APP_GROOVY_DIR

directory for application resources

APP_TEST_DIR

public static final int APP_TEST_DIR

directory for application tests

APP_XSL_DIR

public static final int APP_XSL_DIR

directory for application xsls for transforming

APP_VM_DIR

public static final int APP_VM_DIR

directory for vm stuff

SYSTEM_DIR

public static final int SYSTEM_DIR

directory for system stuff

SYSTEM_VM_DIR

public static final int SYSTEM_VM_DIR

directory for system vm stuff

SYSTEM_XML_DIR

public static final int SYSTEM_XML_DIR

directory for system xml stuff

SYSTEM_XSL_DIR

public static final int SYSTEM_XSL_DIR

directory for system xsl stuff

ERROR_HANDLER

public static final int ERROR_HANDLER

error handler

ERROR_HANDLER_CUSTOM

public static final int ERROR_HANDLER_CUSTOM

custom error handler

MAIL_ROOT_DIR

public static final int MAIL_ROOT_DIR

mail root directory

MAIL_PICKUP_DIR

@Deprecated
public static final int MAIL_PICKUP_DIR

Deprecated.

MAIL_QUEUE_DIR

@Deprecated
public static final int MAIL_QUEUE_DIR

Deprecated.

MAIL_BADMAIL_DIR

@Deprecated
public static final int MAIL_BADMAIL_DIR

Deprecated.

MAIL_TMP_DIR

@Deprecated
public static final int MAIL_TMP_DIR

Deprecated.

LOG_DIR

public static final int LOG_DIR

log dir

Method Detail

reset

public static void reset()

Reset the PortalServerPath.

get

public static File get(int p_iItem)

Get a subpath beginning with the specified file or directory.

Parameters:

p_iItem - The file's identifier.

Returns:

The requested file or directory.

get

public static File get(int p_iItem,
                       String... p_subPaths)
                throws IOException

Get a subpath beginning with the specified file or directory.

Parameters:

p_iItem - The parent file's identifier.

p_subPaths - Subpath elements.

Returns:

The requested file or directory.

Throws:

IOException - If an I/O error occurred.

SecurityException - If an attempt was made to get a directory outside the given parent directory.

getPath

public static Path getPath(int p_iItem,
                           String... p_subPaths)
                    throws IOException

Get a subpath beginning with the specified file or directory.

Parameters:

p_iItem - The parent file's identifier.

p_subPaths - Subpath elements.

Returns:

The requested file or directory.

Throws:

IOException - If an I/O error occurred.

SecurityException - If an attempt was made to get a directory outside the given parent directory.

getNoCheck

public static File getNoCheck(int p_iItem,
                              String... p_subPaths)

Get a subpath beginning with the specified file or directory.

Other than get(int, String...), this method does not perform checks if the resultant path is a subpath of the given directory.

Parameters:

p_iItem - The parent file's identifier.

p_subPaths - Subpath elements.

Returns:

The requested file or directory.

Throws:

IOException - If an I/O error occurred.

getPathNoCheck

public static Path getPathNoCheck(int p_iItem,
                                  String... p_subPaths)

Get a subpath beginning with the specified file or directory.

Other than get(int, String...), this method does not perform checks if the resultant path is a subpath of the given directory.

Parameters:

p_iItem - The parent file's identifier.

p_subPaths - Subpath elements.

Returns:

The requested file or directory.

Throws:

IOException - If an I/O error occurred.