public abstract class XFBaseServlet extends HttpServlet implements IConstants
Copyright 2004 SAP AG
| Modifier and Type | Class and Description |
|---|---|
protected static class |
XFBaseServlet.DataUrl |
IWcmConst.RESOURCE_TYPE_NAMESPACE, IWcmConst.RESOURCE_TYPES| Modifier and Type | Field and Description |
|---|---|
static String |
ACTION_CANCELED |
static String |
DATA_EXISTS |
static String |
DATA_RES_NAME |
static String |
DATA_STORED_UNDER |
static String |
ERROR_MESSAGE |
static String |
FORM_ID_LABEL |
protected com.sapportals.wcm.security.WCMLogon |
logon |
static String |
MSIE |
static String |
NETSCAPE |
static String |
NETSCAPEMAC |
static String |
NO_FOLDER |
static String |
NO_FORM_MANAGER |
static String |
NO_FORM_NAMEORTYPE |
static String |
NO_RESOURCE |
static String |
NO_RESOURCENAME |
protected static ResourceBundles |
oldResBundle |
protected static ResourceBundles |
resBundle |
protected static String |
SERVLET_PROP_TMPDIR
constants
|
protected static String |
SUBMIT_EVENT |
protected static String |
SUBMIT_RESOURCE |
protected static String |
SUBMITCREATE |
protected static String |
SUBMITDELETE_KEY |
protected static String |
SUBMITKEY |
protected static String |
SUBMITMODIFY_KEY |
static String |
SYSTEM_ERROR_ONCREATE |
AUTHOR, AUTHORPREVIEW, BUTTON_LBL_CANCEL, BUTTON_LBL_RESET, BUTTON_LBL_SUBMIT, CANCEL_BUTTON_NAME, CMADMIN, CONTENT_TYPE_HTML, CONTENT_TYPE_PDF, CONTENT_TYPE_XML, CREATE_MODE, CREATE_TEMPLATE, CREATE_TEMPLATE_IVIEW, CREATE_XSL, CREATE_XSL_IVIEW, DEFAULT_ENCODING, DEFAULT_LANGRESOURCEEXT, DELETE_BUTTON_NAME, DELETE_RESOURCE_KEY, EX_DATA_RESOURCE_EXISTS, EX_DST_NOT_COLLECTION, EX_ERROR_TRANSF_XML, EX_NO_DATA_RESOURCE, EX_NO_DATA_URI, EX_NO_ERROR, EX_NO_FOLDER_RESOURCE, EX_NO_FORM_CONFIG, EX_NO_FORM_NAMEORTYPE, EX_NO_FORMS, EX_NO_POST_XML, EX_NO_POST_XSL, EX_NO_RESPOND_XSL, EX_NO_SELECTION_FORM, EX_NO_SELECTION_TRANS, EX_NO_XML_PARSER, EX_NO_XSL_XML, EX_PROPERTY_CONFIGURATION_EXCEPTION, EX_RESOURCE_ACCESSDENIED, EX_RESOURCE_AUTORI_REQUIRED, EX_RESOURCE_CHECKEDOUT, EX_RESOURCE_INVALIDNAME, EX_RESOURCE_LOCKED, EX_RESOURCE_NO_PROP_SUPPORT, EX_RESOURCE_NOT_SUPPORTED, EX_RESOURCE_NOTFOUND, EX_RESOURCE_READONLY, FALSE, FORM_ID, GENERATED, INFO_LABEL, JAVASCRIPT_DEBUG_UTIL, JAVASCRIPT_XMLFORMS_UTIL, LIST_XSL, LIST_XSL_IVIEW, NEW_DATA_RES_LBL, NEW_DATA_RES_NAME, NEW_DATA_RES_OB, ORG_DATA_RES_NAME, PARAM_ACCESSIBILITY_MODE, PARAM_ALLOW_HTML, PARAM_AUTHORPREVIEWRESOURCE, PARAM_BROWSER, PARAM_BROWSERVERSION, PARAM_CALLBACKURL, PARAM_CONTENTACCESS, PARAM_COUNTRY, PARAM_CSS, PARAM_CSSURL, PARAM_DATA_EXT, PARAM_DATA_PATH, PARAM_DATA_URL, PARAM_DATE, PARAM_DETAILS_URL, PARAM_DOCUMENT_ORIENTATION, PARAM_EDIT_MODE, PARAM_EDITSERVLET, PARAM_FEEDBACK_URL, PARAM_FULLDATE, PARAM_GLOBALRESFILE, PARAM_GUID, PARAM_HTMLEDITOR, PARAM_IMAGE_PATH, PARAM_JAVASCRIPTPATH, PARAM_LANGRESFILE, PARAM_LANGRESFILEEXT, PARAM_LANGRESFILEPOSTFIX, PARAM_LANGUAGE, PARAM_LISTSERVLET, PARAM_LOCDATE, PARAM_LOCTIME, PARAM_MIMEPATH, PARAM_NAVIGATIONACCESS, PARAM_PACKETNO, PARAM_PACKETSIZE, PARAM_PORT, PARAM_PREVIEWSERVLET, PARAM_PROJECTROOT, PARAM_QUERYSTRING, PARAM_QUERYSTRING_PART, PARAM_QUERYSTRING_PREFIX, PARAM_RESFILE, PARAM_RESFILEEXT, PARAM_RESFILEPOSTFIX, PARAM_RESTYPE, PARAM_SCHEME, PARAM_SENDTO_URL, PARAM_SERVER, PARAM_SERVER_PREFIX, PARAM_SERVICESERVLET, PARAM_SERVLETPATH, PARAM_SIMPLE_DATEFORMAT, PARAM_TEMPLATES, PARAM_TIME, PARAM_URMAPI_JAVASCRIPTURL, PARAM_URPOPUP_JAVASCRIPTURL, PARAM_USE_LIGHTEDITOR, PARAM_USER_ID, PARAM_USER_NAME, PARAM_XMLFORMSBROWSERS, PARAM_XMLFORMSROOT, POST_BUTTON_NAME, POST_PATH, POST_PATH_IVIEW, PROJECT_ACCESS_MODE, PROJECT_ROOT, PROJECT_ROOT_IVIEW, RESET_BUTTON_NAME, RESFILE_ATTR_NAME, RESFILE_TAG_RESOURCE, RESFILE_TAG_RESOURCES, RESFILE_TAG_RESOURCESROOT, RESOURCE_CREATE, RESOURCE_NAME, RESOURCE_TITLE, RESOURCE_TYPE, RESPOND_XSL, RESPOND_XSL_IVIEW, SAP_XSL_NAMESPACE, SAP_XSL_NAMESPACE_URL, SHOW_TEST, SHOW_TEST_IVIEW, SHOW_XSL, SHOW_XSL_IVIEW, SYSTEM_CONFIG_PARAM_ENABLE_CLIPBOARD_MODE, SYSTEM_CONFIG_PARAM_ENABLE_COLORS_MODE, SYSTEM_CONFIG_PARAM_ENABLE_IMAGES_MODE, SYSTEM_CONFIG_PARAM_ENABLE_INOUDENT_MODE, SYSTEM_CONFIG_PARAM_ENABLE_LINKS_MODE, SYSTEM_CONFIG_PARAM_ENABLE_LISTS_MODE, SYSTEM_CONFIG_PARAM_ENABLE_TABLES_MODE, SYSTEM_CONFIG_PARAM_ENABLE_TEXTSETTINGS_MODE, SYSTEM_CONFIG_PARAM_ONLY_PLAINFORMAT_MODE, SYSTEM_CONFIG_PREFIX, TRUE, URLENCODER_NAMESPACE, URLENCODER_NAMESPACE_URL, VALUES_SUFFIX, XML_HEADER, XML_HEADER_CR, XMLFORMS_CANCELLABEL, XMLFORMS_CREATE, XMLFORMS_DESCRIPTION, XMLFORMS_EDIT, XMLFORMS_ENCODING, XMLFORMS_EXT, XMLFORMS_FORM_PARAMETERS, XMLFORMS_FORMGUID, XMLFORMS_FORMTYPES, XMLFORMS_GLOB_RES_FILE_PREF, XMLFORMS_HTMLFRAGMENT, XMLFORMS_IMAGEPATH, XMLFORMS_LANGRESOURCEEXT, XMLFORMS_LIST, XMLFORMS_LISTITEMTAG, XMLFORMS_LISTTAG, XMLFORMS_MAIN_PREFERENCES, XMLFORMS_MIMETYP, XMLFORMS_NAMESPACE, XMLFORMS_NAMESPACE_URL, XMLFORMS_OPENWINPARAMS, XMLFORMS_PATH, XMLFORMS_POST, XMLFORMS_PREF_EXT, XMLFORMS_PREFERENCES, XMLFORMS_PROPERTIES, XMLFORMS_RENAME, XMLFORMS_REQ_PROPERTIES, XMLFORMS_REQ_SCHEMA, XMLFORMS_REQUIRED_VALUES, XMLFORMS_RESETLABEL, XMLFORMS_RESPOND, XMLFORMS_RESTYPE, XMLFORMS_ROOT, XMLFORMS_ROOTPATH, XMLFORMS_SELECTFORM, XMLFORMS_SELECTXSL, XMLFORMS_SHOW, XMLFORMS_SHOWFORMS, XMLFORMS_SUBMITLABEL, XMLFORMS_SUBMITMETHODE, XMLFORMS_TEMPLATE, XMLFORMS_TEMPLATES, XMLFORMS_TESTPATH, XMLFORMS_TITLE, XMLFORMS_TOEDIT, XMLFORMS_USE_GUID_MAPPING, XMLFORMS_USEFILTERTODISPLAY, XMLFORMS_USEMETAXML, XMLFORMS_VALIDATE, XMLFORMS_VALIDATIONAPI, XMLFORMS_XSL, XSL_NAMESPACE, XSL_NAMESPACE_PREFIX, XSL_NAMESPACE_RESTYPE, XSL_NAMESPACE_RESTYPE_OLD, XSL_NAMESPACE_URLACCESSSTATISTIC_SERVICE, ACL_SERVICE, APP_PROPERTIES_SERVICE, ARCHIVING_PROPERTY_SERVICE, ATTACHMENT_SERVICE, CACHE_MAX_DOCUMENT_AGE, CACHE_MAX_LOOKUP_TIME_MS, CACHE_ONLY_IF_CACHED, COMMENT_SERVICE, COMMENT_SERVLET_PARAM_DESCRIPTION_URI, COMMENT_SERVLET_PARAMETER_STARTPAGE, COMMENT_SERVLET_PARAMETER_XMLFILE, CONTENT_LINK_PORTAL_NAVIGATION, CONTENT_LINK_PREFIX_NAVIGATION, CONTENT_LINK_PREFIX_RID, CONTENT_LINK_PREFIX_ROOM, CONTROLS_INSTRUCTION_NONE, CONTROLS_INSTRUCTION_SUMMARY, DISCUSSION_EXTENSION, DISCUSSION_SERVICE, EVENTLOG_SERVICE, EXTERNAL_PARAMETERS, FEEDBACK_SERVICE, FEEDBACK_SERVLET_PARAM_DESCRIPTION_URI, FEEDBACK_SERVLET_PARAMETER_STARTPAGE, FEEDBACK_SERVLET_PARAMETER_XMLFILE, HTTP_SERVLET_REQUEST, INDEX_TAXONOMY_BROWSER_STARTPAGE, INSTANCE_TYPE_ID, INSTANCE_TYPE_MULTI, INSTANCE_TYPE_SINGLETON, LAYOUT_SERVICE, NAMESPACE_SEPARATOR, PERSONALNOTE_SERVICE, PRIMARY_LOCALE, PROP_ADD_METATAG_NAME_EP60PRINCIPAL, PROP_ATTACHMENT, PROP_CATEGORIES, PROP_COLLECTION, PROP_COMMENT_COUNT, PROP_CONTENT_LANGUAGE, PROP_CONTENTLENGTH, PROP_CONTENTLINK, PROP_CONTENTTYPE, PROP_CREATEDBY, PROP_CREATIONDATE, PROP_DEF_ATTR_APPLICATION, PROP_DESCRIPTION, PROP_DISCUSSION_COUNT, PROP_DISCUSSION_TOPICS_COUNT, PROP_DISPLAYNAME, PROP_DOC_ABSTRACT, PROP_EMBEDDED_KEYWORDS, PROP_EMBEDDED_LINKS, PROP_ENHANCED_COLLECTION, PROP_ETAG, PROP_EXTENSION, PROP_EXTERNALLINK, PROP_FEEDBACK_COUNT, PROP_FOLLOW_LINKS, PROP_HIDDEN, PROP_HIGHLIGHTED_CONTENTLINK, PROP_INDEX_CONTENT, PROP_INDEXING_PROPERTIES, PROP_IS_SYSTEM, PROP_LASTMODIFIED, PROP_LASTMODIFIEDBY, PROP_LASTREADDATE, PROP_LINKTYPE, PROP_PERSNOTE_COUNT, PROP_RANK_VALUE, PROP_RATING, PROP_RATING_AMOUNT_RATING, PROP_RATING_AMOUNT_USER, PROP_RATING_USER, PROP_READBYME, PROP_READONLY, PROP_RESOURCE_TYPE, PROP_RESTRICTED_LINKS, PROP_VERSIONED, PROPERTIES_SERVLET_PARAMETER_RESOURCE, PROPERTIES_SERVLET_PARAMETER_STARTPAGE, PROPERTIES_SERVLET_PARAMETER_XML_FILE, PROPERTIES_SERVLET_VALUE_XML_FILE, PROPERTY_CONFIG_SERVICE, PROPERTY_CONSUMER_ID, RATING_SERVICE, REQUEST_URI, RESOURCE_CONTEXT, RESOURCE_TYPE_PORTAL_PAGE, SAP_NAMESPACE_ROOMSTRUCTURE, SAP_WCM_NAMESPACE, SAP_WCM_NAMESPACE_ACCSTAT, SAP_WCM_NAMESPACE_COLLABORATION, SAP_WCM_NAMESPACE_EDIT, SAP_WCM_NAMESPACE_RATING, SAP_WCM_NAMESPACE_RENDERING, SECURITY_MANAGER_TYPE_ACL, SECURITY_MANAGER_TYPE_ATTACHMENT, SECURITY_MANAGER_TYPE_COLLABORATION, SECURITY_MANAGER_TYPE_W2K, SENDTO_SERVLET_PARAM_DESCRIPTION_URI, SENDTO_SERVLET_PARAMETER_DESCRIPTION, SENDTO_SERVLET_PARAMETER_RESOURCE, SENDTO_SERVLET_PARAMETER_SENDASLINK, SENDTO_SERVLET_PARAMETER_STARTPAGE, SENDTO_SERVLET_PARAMETER_SUBJECT, SENDTO_SERVLET_PARAMETER_TO, SENDTO_SERVLET_PARAMETER_XML_FILE, SENDTO_SERVLET_VALUE_FALSE, SENDTO_SERVLET_VALUE_STARTPAGE, SENDTO_SERVLET_VALUE_TRUE, SENDTO_SERVLET_VALUE_XML_FILE, SERVICE_SERVLET_ACTION_DELETE, SERVICE_SERVLET_PARAMETER_ACTION, SERVICE_SERVLET_PARAMETER_IS_GLOBAL, SERVICE_SERVLET_PARAMETER_LOCATION, SERVICE_SERVLET_PARAMETER_POPUP, SERVICE_SERVLET_PARAMETER_PREFIX, SERVICE_SERVLET_PARAMETER_REPOSITORY, SERVICE_SERVLET_PARAMETER_RESOURCE, SERVICE_SERVLET_PARAMETER_SERVICE_ID, SERVICE_SERVLET_PARAMETER_SERVICE_TYPE, SERVICE_SERVLET_PARAMETER_STARTPAGE, SERVICE_SERVLET_PARAMETER_STRING_ONE, SERVICE_SERVLET_PARAMETER_STRING_TWO, SERVICE_SERVLET_PARAMETER_SUBSCRIPTIONID, SERVICE_SERVLET_PARAMETER_XML_FILE, SERVICE_SERVLET_SUBSCRIPTIONADMINISTRATION_STARTPAGE, SERVICE_SERVLET_SUBSCRIPTIONADMINISTRATION_XML_FILE, SERVICE_SERVLET_VALUE_FALSE, SERVICE_SERVLET_VALUE_STARTPAGE, SERVICE_SERVLET_VALUE_TRUE, SERVICE_SERVLET_VALUE_XML_FILE, SHAREDSPACE_SERVICE, SHOW_CLOSE_BUTTON_PARAMETER, SORTORDERASCENDING, SORTORDERDESCENDING, STATEMANAGEMENT_SERVICE, SUBSCRIPTION_SERVICE, TIMEBASED_PUBLISH_SERVICE, USER_MAPPING_REDIRECT, VIRTUAL_ROOT_PREFIX, WASTEBASKET_SERVICE, WCM_HORIZONTAL_ALIGN_RIGHT, XSUBSCRIPTION_SERVICE| Constructor and Description |
|---|
XFBaseServlet() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
closeInputStream(InputStream in)
Closes an input stream
|
protected void |
closeOutputStream(OutputStream out)
Closes an output stream
|
protected void |
copyStream(InputStream in,
OutputStream out)
Copies one stream to another
|
void |
doGet(HttpServletRequest req,
HttpServletResponse res)
Process the HTTP GET request
|
abstract void |
doGetAction(HttpServletRequest req,
HttpServletResponse res,
IResourceContext resourceContext,
IXFProject prj,
String tmpdir) |
void |
doPost(HttpServletRequest req,
HttpServletResponse res)
Process the HTTP Post request
|
String |
genhtmlResponse(String response,
String formatted,
String cssUrl,
String action,
Properties props)
Sends a response message page back to the browser
|
protected abstract String |
getCallbackURL(HttpServletRequest req) |
protected String |
getEncoding(HttpServletRequest req) |
protected String |
getParameter(String key,
HttpServletRequest req,
String encoding,
boolean normalize)
Gets a parameter value from the request
|
protected Hashtable |
getParameters(HttpServletRequest req) |
protected XFBaseServlet.DataUrl |
getResourceName(HttpServletRequest req,
IXFProject prj) |
protected String |
getServerPrefix(HttpServletRequest req)
Get server prefix from the request
|
protected boolean |
htmlEditorSupport(String browser,
String browserversion) |
protected void |
htmlresponse(HttpServletRequest req,
HttpServletResponse res,
String response,
String formatted,
String FormID)
Sends a simple response to the client
|
void |
init(ServletConfig config)
Servlet init
|
protected String |
normalize(String s)
Normalizes the given string
|
protected void |
sendhtml(HttpServletResponse res,
String response)
Sends a simple response to the client
|
void |
service(ServletRequest request,
ServletResponse response) |
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, servicedestroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, logprotected static ResourceBundles resBundle
protected static ResourceBundles oldResBundle
public static final String ACTION_CANCELED
public static final String DATA_EXISTS
public static final String ERROR_MESSAGE
public static final String NO_RESOURCE
public static final String NO_RESOURCENAME
public static final String NO_FORM_NAMEORTYPE
public static final String NO_FORM_MANAGER
public static final String SYSTEM_ERROR_ONCREATE
public static final String DATA_STORED_UNDER
public static final String DATA_RES_NAME
public static final String FORM_ID_LABEL
public static final String NO_FOLDER
public static final String NETSCAPE
public static final String NETSCAPEMAC
public static final String MSIE
protected static final String SERVLET_PROP_TMPDIR
protected static String SUBMITCREATE
protected static String SUBMITDELETE_KEY
protected static String SUBMITMODIFY_KEY
protected static String SUBMITKEY
protected static String SUBMIT_EVENT
protected static String SUBMIT_RESOURCE
protected transient com.sapportals.wcm.security.WCMLogon logon
public void init(ServletConfig config) throws ServletException
init in interface Servletinit in class GenericServletconfig - Servlet configurationServletException - if init failspublic void service(ServletRequest request, ServletResponse response) throws ServletException, IOException
service in interface Servletservice in class HttpServletServletExceptionIOExceptionpublic void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException
doGet in class HttpServletreq - HttpServletRequest to be processedres - HttpServletResponse to be processedServletException - processing failsIOException - processing failspublic abstract void doGetAction(HttpServletRequest req, HttpServletResponse res, IResourceContext resourceContext, IXFProject prj, String tmpdir) throws ServletException, IOException
ServletExceptionIOExceptionpublic void doPost(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException
doPost in class HttpServletreq - HttpServletRequest to be processedres - HttpServletResponse to be processedServletException - if doGet() throws ServletExceptionIOException - if doGet() throws IOExceptionprotected void copyStream(InputStream in, OutputStream out) throws IOException
in - InputStream from where the data will be readout - OutputStream where the data will be writtenIOException - if there is a problem with stream reading or writingprotected void htmlresponse(HttpServletRequest req, HttpServletResponse res, String response, String formatted, String FormID) throws IOException
req - HttpServletRequest to be processedres - HttpServletResponse to be returnedresponse - more information about the executed operationformatted - normalized stringFormID - form unique identifierIOException - if cannot get response writerprotected void sendhtml(HttpServletResponse res, String response) throws IOException
res - HttpServletResponse to be processedresponse - The response that will be sent to the browserIOException - If writing to the servlet response failsprotected void closeInputStream(InputStream in)
in - The input stream to be closedprotected void closeOutputStream(OutputStream out)
out - The output stream to be closedprotected abstract String getCallbackURL(HttpServletRequest req)
protected String getServerPrefix(HttpServletRequest req)
req - HttpServletRequest to be processedprotected String getEncoding(HttpServletRequest req)
protected String getParameter(String key, HttpServletRequest req, String encoding, boolean normalize)
key - First part of a key-value pair in the requestreq - HttpServletRequest to be processedencoding - Encodes the value got from the request into a sequence of bytes using the given encodingnormalize - <true> if value got from the request should be normalized, <false> otherwisepublic String genhtmlResponse(String response, String formatted, String cssUrl, String action, Properties props)
response - The message that will be send to the browserformatted - The normalized stringcssUrl - Stylesheet Urlaction - XMLForms Servlet URLprops - Properties added to the response htmlprotected String normalize(String s)
s - The string that is going to be normalizedprotected Hashtable getParameters(HttpServletRequest req)
protected XFBaseServlet.DataUrl getResourceName(HttpServletRequest req, IXFProject prj)
| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2021 SAP SE Complete Copyright Notice