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