001/*
002 * (C) Copyright 2006-2007 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Nuxeo - initial API and implementation
016 *
017 * $Id$
018 */
019
020package org.nuxeo.ecm.platform.ui.web.tag.fn;
021
022import org.dom4j.DocumentFactory;
023import org.dom4j.QName;
024
025public interface LiveEditConstants {
026
027    // nxedit query parameter names
028
029    static final String ACTION = "action";
030
031    static final String DOC_TYPE = "docType";
032
033    /**
034     * @deprecated use {@link #FILENAME_PROPERTY_NAME}
035     */
036    @Deprecated
037    static final String FILENAME_FIELD = "filenameField";
038
039    /**
040     * @deprecated use {@link #BLOB_PROPERTY_NAME}
041     */
042    @Deprecated
043    static final String BLOB_FIELD = "blobField";
044
045    /**
046     * @deprecated use {@link #FILENAME_PROPERTY_NAME} and {@link #BLOB_PROPERTY_NAME}
047     */
048    @Deprecated
049    static final String SCHEMA = "schema";
050
051    static final String FILENAME_PROPERTY_NAME = "filenamePropertyName";
052
053    static final String BLOB_PROPERTY_NAME = "blobPropertyName";
054
055    static final String MIMETYPE = "mimetype";
056
057    static final String REPO_ID = "repoID";
058
059    static final String DOC_REF = "docRef";
060
061    static final String TEMPLATE_BLOB_FIELD = "templateBlobField";
062
063    static final String TEMPLATE_SCHEMA = "templateSchema";
064
065    static final String TEMPLATE_DOC_REF = "templateDocRef";
066
067    static final String TEMPLATE_REPO_ID = "templateRepoID";
068
069    // action values
070
071    static final String ACTION_EDIT_DOCUMENT = "edit";
072
073    static final String ACTION_CREATE_DOCUMENT = "create";
074
075    static final String ACTION_CREATE_DOCUMENT_FROM_TEMPLATE = "createFromTemplate";
076
077    // default fields to store LiveEditable blobs and related fields
078
079    static final String DEFAULT_DOCTYPE = "File";
080
081    // to be deprecated once all filenames are stored in the blob itself
082    static final String DEFAULT_FILENAME_FIELD = "filename";
083
084    static final String DEFAULT_BLOB_FIELD = "content";
085
086    static final String DEFAULT_SUB_BLOB_FIELD = "file";
087
088    static final String DEFAULT_SCHEMA = "file";
089
090    // XML QNames for the Bootstrap XML and RESTful web service responses
091
092    static final String XML_LE_NAMESPACE = "http://www.nuxeo.org/liveEdit";
093
094    static final QName actionSelectorTag = DocumentFactory.getInstance().createQName("actionSelector");
095
096    static final QName liveEditTag = DocumentFactory.getInstance().createQName("liveEdit");
097
098    static final QName editIdTag = DocumentFactory.getInstance().createQName("editId");
099
100    static final QName documentTag = DocumentFactory.getInstance().createQName("document");
101
102    static final QName templateDocumentTag = DocumentFactory.getInstance().createQName("template");
103
104    static final QName docRefTag = DocumentFactory.getInstance().createQName("docRef");
105
106    static final QName docTitleTag = DocumentFactory.getInstance().createQName("docTitle");
107
108    static final QName docPathTag = DocumentFactory.getInstance().createQName("docPath");
109
110    static final QName docRepositoryTag = DocumentFactory.getInstance().createQName("repository");
111
112    /**
113     * @deprecated use docBlobFieldNameTag instead
114     */
115    @Deprecated
116    static final QName docFieldNameTag = DocumentFactory.getInstance().createQName("fieldName");
117
118    /**
119     * @deprecated use docBlobFieldPathTag instead
120     */
121    @Deprecated
122    static final QName docfieldPathTag = DocumentFactory.getInstance().createQName("fieldPath");
123
124    static final QName docBlobFieldNameTag = DocumentFactory.getInstance().createQName("blobFieldName");
125
126    static final QName docBlobFieldPathTag = DocumentFactory.getInstance().createQName("blobFieldPath");
127
128    static final QName docFilenameFieldNameTag = DocumentFactory.getInstance().createQName("filenameFieldName");
129
130    static final QName docFilenameFieldPathTag = DocumentFactory.getInstance().createQName("filenameFieldPath");
131
132    static final QName docSchemaNameTag = DocumentFactory.getInstance().createQName("schemaName");
133
134    static final QName docfileNameTag = DocumentFactory.getInstance().createQName("fileName");
135
136    static final QName docTypeTag = DocumentFactory.getInstance().createQName("type");
137
138    static final QName docMimetypeTag = DocumentFactory.getInstance().createQName("mimetype");
139
140    static final QName docFileExtensionTag = DocumentFactory.getInstance().createQName("fileExtension");
141
142    static final QName docFileAuthorizedExtensionsTag = DocumentFactory.getInstance().createQName(
143            "authorizedExtensions");
144
145    static final QName docFileAuthorizedExtensionTag = DocumentFactory.getInstance().createQName("extension");
146
147    static final QName docIsVersionTag = DocumentFactory.getInstance().createQName("isVersion");
148
149    static final QName docIsLockedTag = DocumentFactory.getInstance().createQName("isLocked");
150
151    static final QName requestInfoTag = DocumentFactory.getInstance().createQName("requestInfo");
152
153    static final QName requestCookiesTag = DocumentFactory.getInstance().createQName("cookies");
154
155    static final QName requestCookieTag = DocumentFactory.getInstance().createQName("cookie");
156
157    static final QName requestHeadersTag = DocumentFactory.getInstance().createQName("headers");
158
159    static final QName requestHeaderTag = DocumentFactory.getInstance().createQName("header");
160
161    static final QName requestBaseURLTag = DocumentFactory.getInstance().createQName("baseURL");
162
163    static final QName userInfoTag = DocumentFactory.getInstance().createQName("userInfo");
164
165    static final QName userNameTag = DocumentFactory.getInstance().createQName("userName");
166
167    static final QName userPasswordTag = DocumentFactory.getInstance().createQName("userPassword");
168
169    static final QName userTokenTag = DocumentFactory.getInstance().createQName("userToken");
170
171    static final QName userLocaleTag = DocumentFactory.getInstance().createQName("userLocale");
172
173    static final QName wsdlLocationsTag = DocumentFactory.getInstance().createQName("wsdlLocations");
174
175    static final QName wsdlAccessWebServiceTag = DocumentFactory.getInstance().createQName("wsdlAccessWS");
176
177    static final QName wsdlLEWebServiceTag = DocumentFactory.getInstance().createQName("wsdlLiveEditWS");
178
179    static final QName serverInfoTag = DocumentFactory.getInstance().createQName("serverInfo");
180
181    static final QName serverVersionTag = DocumentFactory.getInstance().createQName("serverVersion");
182
183    static final String URL_ENCODE_CHARSET = "UTF-8";
184
185}