View Javadoc
1   /*
2    * Copyright (c) 2002-2018, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.document.modules.rest.util.constants;
35  
36  /**
37   *
38   * DocumentRestConstants
39   *
40   */
41  public class DocumentRestConstants
42  {
43      // CONSTANTS
44      public static final String SLASH = "/";
45      public static final String STATUS_SUCCESS = "SUCCESS";
46      public static final String STATUS_FAILURE = "FAILURE";
47  
48      // PATHS
49      public static final String PATH_WADL = "wadl";
50      public static final String PATH_GET_USER_SPACES = "getuserspaces/{id_user}";
51      public static final String PATH_GET_SPACE = "getspace/{id_space}";
52      public static final String PATH_GET_SPACES_ALLOWING_DOCUMENT_CREATION_BY_CODE_DOCUMENT_TYPE = "getspacesbydocumenttype/{code_document_type}";
53      public static final String PATH_GET_ATTRIBUTE_BY_DOCUMENT_TYPE = "getdocumenttypeattribute/{code_document_type}";
54      public static final String PATH_GET_DOCUMENTS_LIST_BY_SPACE = "getdocumentslistbyspace/{id_space}";
55      public static final String PATH_GET_DOCUMENT = "getdocument/{id_document}";
56      public static final String PATH_MANAGE = "manage/";
57      public static final String PATH_CREATE_GET_FIELDS = "getcreationdocumentfields/{code_document_type}";
58      public static final String PATH_GET_LIST_DOCUMENT_TYPE = "getdocumenttypelist/";
59      public static final String PATH_CREATE_DOCUMENT = "docreatedocument/";
60      public static final String PATH_MODIFY_DOCUMENT = "domodifydocument/";
61      public static final String PATH_REMOVE_DOCUMENT = "doremovedocument/{id_document}";
62      public static final String PATH_PORTLETS_DOCUMENT = "getportletstoassigndocument/{id_document}";
63      public static final String PATH_PORTLETS_LIST_DOCUMENT = "getportletslisttoassigndocument/{id_document}";
64      public static final String PATH_PORTLETS_DOCUMENT_ASSIGNED = "getportletsdocumentassigned/{id_document}";
65      public static final String PATH_DOCUMENT_SUBMIT = "dosubmitdocumenttovalidate/";
66      public static final String PATH_DOCUMENT_VALIDATE = "dovalidatedocument/";
67      public static final String PATH_DOCUMENT_ASSIGN_PORTLET = "doassigndocumentportlet/";
68      public static final String PATH_DOCUMENT_UNASSIGN_PORTLET = "dounassigndocumentportlet/";
69      public static final String PATH_DOCUMENT_PUBLISH = "dopublishdocument/";
70      public static final String PATH_DOCUMENT_UNPUBLISH = "dounpublishdocument/";
71  
72      // TAGS
73      public static final String TAG_RESPONSE = "Response";
74      public static final String TAG_STATUS = "Status";
75      public static final String TAG_DOCUMENTS = "Documents";
76      public static final String TAG_DOCUMENT = "Document";
77      public static final String TAG_ID_DOCUMENT = "Id-document";
78      public static final String TAG_ID_SPACE = "Id_space";
79      public static final String TAG_PUBLISHED_STATUS = "Published_status";
80      public static final String TAG_MAILING_LIST_ID = "Mailing_List_Id";
81      public static final String TAG_PAGE_TEMPLATE_DOCUMENT_ID = "Page_Template_Document_Id";
82      public static final String TAG_STATE_ID = "State_Id";
83      public static final String TAG_IS_NOTIFIED_COMMENT = "Is_Email_Notified_Comment";
84      public static final String TAG_IS_MODERATED_COMMENT = "Is_Moderated_Comment";
85      public static final String TAG_COMMENT = "Comment";
86      public static final String TAG_SPACES = "spaces";
87      public static final String TAG_SPACE = "space";
88      public static final String TAG_SPACE_ID = "space-id";
89      public static final String TAG_SPACE_ID_PARENT = "space-id-parent";
90      public static final String TAG_SPACE_NAME = "name";
91      public static final String TAG_SPACE_DESCRIPTION = "description";
92      public static final String TAG_SPACE_VIEW_TYPE = "view-type";
93      public static final String TAG_SPACE_ID_ICON = "space-id-icon";
94      public static final String TAG_SPACE_ICON_URL = "space-icon-url";
95      public static final String TAG_SPACE_ALLOWED_DOCUMENT_TYPES = "space-allowed-document-types";
96      public static final String TAG_SPACE_DOCUMENT_TYPE = "document-type";
97      public static final String TAG_SPACE_DOCUMENT_CREATION_ALLOWED = "space-document-creation-allowed";
98      public static final String TAG_SPACE_WORKGROUP = "space-workgroup";
99      public static final String TAG_DOCUMENT_TYPES = "document_types";
100     public static final String TAG_DOCUMENT_TYPE = "document_type";
101     public static final String TAG_CODE_DOCUMENT_TYPE = "code_document_type";
102     public static final String TAG_DOCUMENT_TYPE_NAME = "document_type_name";
103     public static final String TAG_DOCUMENT_TYPE_DESCRIPTION = "description";
104     public static final String TAG_DOCUMENT_TYPE_THUMBNAIL_ATTRIBUTE_ID = "thumbnail_attr_id";
105     public static final String TAG_DOCUMENT_TYPE_DEFAULT_THUMBNAIL_URL = "default_thumbnail_url";
106     public static final String TAG_DOCUMENT_TYPE_METADATA_HANDLER = "metadata_handler";
107     public static final String TAG_ATTRIBUTE = "attribute";
108     public static final String TAG_ATTRIBUTES = "attributes";
109     public static final String TAG_ATTRIBUTE_ID = "id_document_attr";
110     public static final String TAG_CODE_ATTRIBUTE_TYPE = "code_attr_type";
111     public static final String TAG_CODE_ATTRIBUTE = "code";
112     public static final String TAG_DOCUMENT_TYPE_ATTRIBUTE_NAME = "document_type_attr_name";
113     public static final String TAG_ATTRIBUTE_DESCRIPTION = "description";
114     public static final String TAG_CREATE_DOCUMENT_FIELDS_FORM = "form";
115     public static final String TAG_CREATE_DOCUMENT_FIELDS_FORM_MAINFIELDS = "main-fields";
116     public static final String TAG_CREATE_DOCUMENT_FIELDS_FORM_DUBLINCORE_FIELDS = "dublincore-fields";
117     public static final String TAG_CREATE_DOCUMENT_FIELDS_FORM_ATTRIBUTS_FIELDS = "attributs-fields";
118     public static final String TAG_CREATE_DOCUMENT_FIELDS_FORM_ATTRIBUT = "attribut";
119     public static final String TAG_CREATE_DOCUMENT_FIELDS_FORM_PARAMETER_ATTRIBUT = "parameter-attribut";
120     public static final String TAG_CREATE_DOCUMENT_FIELDS_FORM_PARAMETER_ATTRIBUT_VALUE = "parameter-attribut-value";
121     public static final String TAG_CREATE_DOCUMENT_FIELDS_TEXT = "text";
122     public static final String TAG_CREATE_DOCUMENT_FIELDS_TEXTAREA = "textarea";
123     public static final String TAG_CREATE_DOCUMENT_FIELDS_RADIO = "radio";
124     public static final String TAG_CREATE_DOCUMENT_FIELDS_RADIO_VALUE = "radio_value";
125     public static final String TAG_CREATE_DOCUMENT_FIELDS_CHECKBOX = "checkbox";
126     public static final String TAG_REF_ITEMS = "ref-items";
127     public static final String TAG_REF_ITEM = "ref-item";
128     public static final String TAG_DOCUMENTS_PUBLICATION = "documents-publication";
129     public static final String TAG_DOCUMENT_PUBLICATION = "document-publication";
130 
131     // MAP ATTRIBUTS
132     public static final String ATTRIBUTS_PORTLET_ID = "portlet-id";
133     public static final String ATTRIBUTS_STATUS = "status";
134     public static final String ATTRIBUTS_NAME = "name";
135     public static final String ATTRIBUTS_TYPE = "type";
136     public static final String ATTRIBUTS_MAXLENGTH = "maxlength";
137     public static final String ATTRIBUTS_SITE = "size";
138     public static final String ATTRIBUTS_ISREQUIRED = "isRequired";
139     public static final String ATTRIBUTS_CODE = "code";
140     public static final String ATTRIBUTS_VALUE = "value";
141     public static final String ATTRIBUTS_ROWS = "rows";
142     public static final String ATTRIBUTS_COLS = "cols";
143 
144     // PARAMETERS
145     public static final String PARAMETER_ID_USER = "id_user";
146     public static final String PARAMETER_ID_SPACE = "id_space";
147     public static final String PARAMETER_ID_DOCUMENT = "id_document";
148     public static final String PARAMETER_ID_ACTION = "id_action";
149     public static final String PARAMETER_ID_PORTLET = "id_portlet";
150     public static final String PARAMETER_CODE_DOCUMENT_TYPE = "code_document_type";
151     public static final String PARAMETER_STATE_ID = "id_state";
152     public static final String PARAMETER_DUBLIN_CORE_META_DATA_TITLE = "dc_title";
153     public static final String PARAMETER_DUBLIN_CORE_META_DATA_CREATOR = "dc_creator";
154     public static final String PARAMETER_DUBLIN_CORE_META_DATA_SUBJECT = "dc_subject";
155     public static final String PARAMETER_DUBLIN_CORE_META_DATA_DESCRIPTION = "dc_description";
156     public static final String PARAMETER_DUBLIN_CORE_META_DATA_PUBLISHER = "dc_publisher";
157     public static final String PARAMETER_DUBLIN_CORE_META_DATA_CONTRIBUTOR = "dc_contributor";
158     public static final String PARAMETER_DUBLIN_CORE_META_DATA_DATE = "dc_date";
159     public static final String PARAMETER_DUBLIN_CORE_META_DATA_TYPE = "dc_type";
160     public static final String PARAMETER_DUBLIN_CORE_META_DATA_FORMAT = "dc_format";
161     public static final String PARAMETER_DUBLIN_CORE_META_DATA_IDENTIFIER = "dc_identifier";
162     public static final String PARAMETER_DUBLIN_CORE_META_DATA_SOURCE = "dc_source";
163     public static final String PARAMETER_DUBLIN_CORE_META_DATA_LANGUAGE = "dc_language";
164     public static final String PARAMETER_DUBLIN_CORE_META_DATA_RELATION = "dc_relation";
165     public static final String PARAMETER_DUBLIN_CORE_META_DATA_COVERAGE = "dc_coverage";
166     public static final String PARAMETER_DUBLIN_CORE_META_DATA_RIGHTS = "dc_rights";
167     public static final String PARAMETER_DOCUMENT_TITLE = "document_title";
168     public static final String PARAMETER_DOCUMENT_SUMMARY = "document_summary";
169     public static final String PARAMETER_DOCUMENT_COMMENT = "document_comment";
170     public static final String PARAMETER_VALIDITY_BEGIN = "document_validity_begin";
171     public static final String PARAMETER_VALIDITY_END = "document_validity_end";
172     public static final String PARAMETER_ACCEPT_SITE_COMMENTS = "accept_site_comments";
173     public static final String PARAMETER_IS_MODERATED_COMMENT = "is_moderated_comment";
174     public static final String PARAMETER_IS_EMAIL_NOTIFIED_COMMENT = "is_email_notified_comment";
175     public static final String PARAMETER_MAILING_LIST = "mailinglists";
176     public static final String PARAMETER_PAGE_TEMPLATE_DOCUMENT_ID = "page_template_id";
177     public static final String PARAMETER_CATEGORY = "category_id";
178     public static final String PARAMETER_ATTRIBUTE_UPDATE = "update_";
179 
180     // PROPERTIES
181     public static final String PROPERTY_MULTIPART_SIZE_THRESHOLD = "document-rest.multipart.sizeThreshold";
182     public static final String PROPERTY_MULTIPART_REQUEST_SIZE_MAX = "document-rest.multipart.requestSizeMax";
183     public static final String PROPERTY_MULTIPART_NORMALIZE_FILE_NAME = "document-rest.multipart.activateNormalizeFileName";
184     public static final String PROPERTY_RESOURCE_TYPE = "document";
185     public static final String PROPERTIES_XML_HEADER = "document-rest.xml.header";
186 
187     // MESSAGES
188 
189     // MARKS
190     public static final String MARK_BASE_URL = "base_url";
191 
192     // TEMPLATES
193     public static final String TEMPLATE_WADL = "admin/plugins/document/modules/rest/wadl.xml";
194 
195     /**
196      * Private constructor
197      */
198     private DocumentRestConstants( )
199     {
200     }
201 }